@synsci/sdk 1.3.6-test.21.1 → 1.3.6-test.24.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/v2/gen/sdk.gen.d.ts +135 -1
- package/dist/v2/gen/sdk.gen.js +252 -0
- package/dist/v2/gen/types.gen.d.ts +698 -0
- package/package.json +1 -1
package/dist/v2/gen/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type Options as Options2, type TDataShape } from "./client/index.js";
|
|
2
|
-
import type { AccountBalanceResponses, AccountBillingModeGetResponses, AccountBillingModeSetResponses, AccountDeviceRevokeResponses, AccountDevicesResponses, AccountGetResponses, AccountLoginKeyResponses, AccountLogoutResponses, AccountSessionResponses, AgentPartInput, AppAgentsResponses, AppLogErrors, AppLogResponses, AppSkillDeleteResponses, AppSkillsResponses, AppSkillWriteResponses, Auth as Auth3, AuthRemoveErrors, AuthRemoveResponses, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config4, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, EventSubscribeResponses, ExperimentalResourceListResponses, FileArtifactsResponses, FileInspectResponses, FileListResponses, FileManifestResponses, FilePartInput, FilePartSource, FileProvenanceResponses, FilePublicationCapabilitiesResponses, FilePublicationResponses, FileRawResponses, FileReadResponses, FileReproducibilityResponses, FileStarterResponses, FileStatusResponses, FileWriteResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GlobalConfigGetResponses, GlobalConfigRawGetResponses, GlobalConfigRawSetErrors, GlobalConfigRawSetResponses, GlobalConfigUnsetErrors, GlobalConfigUnsetResponses, GlobalConfigUpdateErrors, GlobalConfigUpdateResponses, GlobalDisposeResponses, GlobalEventResponses, GlobalHealthResponses, GlobalSyncResponses, InstanceDisposeResponses, LspStatusResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConfigRemoveErrors, McpConfigRemoveResponses, McpConfigSetErrors, McpConfigSetResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, NotebookExecuteResponses, NotebookInterruptResponses, NotebookRestartResponses, NotebookStatusResponses, Part as Part2, PartDeleteErrors, PartDeleteResponses, PartUpdateErrors, PartUpdateResponses, PathGetResponses, PermissionListResponses, PermissionReplyErrors, PermissionReplyResponses, PermissionRespondErrors, PermissionRespondResponses, PermissionRuleset, PostSettingsLocalModelsResponses, PostSettingsLocalResponses, PostSettingsLocalStartResponses, ProjectCurrentResponses, ProjectListResponses, ProjectUpdateErrors, ProjectUpdateResponses, ProvenanceExportResponses, ProvenanceListResponses, ProvenanceRecordErrors, ProvenanceRecordResponses, ProvenanceReviewErrors, ProvenanceReviewResponses, ProvenanceTraceErrors, ProvenanceTraceResponses, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeErrors, ProviderOauthAuthorizeResponses, ProviderOauthCallbackErrors, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyUpdateErrors, PtyUpdateResponses, PutSettingsSandboxResponses, QuestionAnswer, QuestionListResponses, QuestionRejectErrors, QuestionRejectResponses, QuestionReplyErrors, QuestionReplyResponses, SessionAbortErrors, SessionAbortResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteResponses, SessionDiffResponses, SessionForkResponses, SessionGetErrors, SessionGetResponses, SessionInitErrors, SessionInitResponses, SessionListResponses, SessionMessageErrors, SessionMessageResponses, SessionMessagesErrors, SessionMessagesResponses, SessionPromptAsyncErrors, SessionPromptAsyncResponses, SessionPromptErrors, SessionPromptResponses, SessionRevertErrors, SessionRevertResponses, SessionShellErrors, SessionShellResponses, SessionStatusErrors, SessionStatusResponses, SessionSummarizeErrors, SessionSummarizeResponses, SessionTodoErrors, SessionTodoResponses, SessionUnrevertErrors, SessionUnrevertResponses, SessionUpdateErrors, SessionUpdateResponses, SettingsBillingGetResponses, SettingsBillingUpdateResponses, SettingsComputeEndpointAddErrors, SettingsComputeEndpointAddResponses, SettingsComputeEndpointRemoveResponses, SettingsComputeGetResponses, SettingsComputeJobsCancelErrors, SettingsComputeJobsCancelResponses, SettingsComputeJobsClearResponses, SettingsComputeJobsListResponses, SettingsComputeJobsLogErrors, SettingsComputeJobsLogResponses, SettingsComputeJobsStartErrors, SettingsComputeJobsStartResponses, SettingsComputeProviderConnectErrors, SettingsComputeProviderConnectResponses, SettingsComputeProviderDisconnectResponses, SettingsComputeSshAddErrors, SettingsComputeSshAddResponses, SettingsComputeSshRemoveResponses, SettingsComputeSshTestErrors, SettingsComputeSshTestResponses, SettingsCredentialsListResponses, SettingsCredentialsRemoveResponses, SettingsCredentialsSetResponses, SettingsMemoryGetResponses, SettingsMemorySetResponses, SettingsNetworkGetResponses, SettingsNetworkSetResponses, SettingsPermissionsGetResponses, SettingsPermissionsRevokeAllErrors, SettingsPermissionsRevokeAllResponses, SettingsPermissionsSetErrors, SettingsPermissionsSetResponses, SettingsPreferencesGetResponses, SettingsPreferencesUpdateResponses, SettingsSkillsInstallErrors, SettingsSkillsInstallResponses, SettingsStorageRelocateResponses, SettingsStorageResetLocationResponses, SettingsStorageUsageResponses, SettingsUsageGetResponses, SettingsWalletGetResponses, SubtaskPartInput, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, VcsGetResponses, WorktreeCreateErrors, WorktreeCreateInput, WorktreeCreateResponses, WorktreeListResponses, WorktreeRemoveErrors, WorktreeRemoveInput, WorktreeRemoveResponses, WorktreeResetErrors, WorktreeResetInput, WorktreeResetResponses } from "./types.gen.js";
|
|
2
|
+
import type { AccountBalanceResponses, AccountBillingModeGetResponses, AccountBillingModeSetResponses, AccountDeviceRevokeResponses, AccountDevicesResponses, AccountGetResponses, AccountLoginKeyResponses, AccountLogoutResponses, AccountSessionResponses, AgentPartInput, AppAgentsResponses, AppLogErrors, AppLogResponses, AppSkillDeleteResponses, AppSkillsResponses, AppSkillWriteResponses, Auth as Auth3, AuthRemoveErrors, AuthRemoveResponses, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config4, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, EventSubscribeResponses, ExperimentalResourceListResponses, FileAnnotationsCreateResponses, FileAnnotationsDeleteResponses, FileAnnotationsHistoryResponses, FileAnnotationsListResponses, FileAnnotationsUpdateResponses, FileArtifactsResponses, FileInspectResponses, FileListResponses, FileManifestResponses, FilePartInput, FilePartSource, FileProvenanceResponses, FilePublicationCapabilitiesResponses, FilePublicationResponses, FileRawResponses, FileReadResponses, FileReproducibilityResponses, FileReviewsCurrentErrors, FileReviewsCurrentResponses, FileReviewsFinalizeErrors, FileReviewsFinalizeResponses, FileReviewsHistoryResponses, FileReviewsResolveErrors, FileReviewsResolveResponses, FileReviewsRunResponses, FileStarterResponses, FileStatusResponses, FileWriteResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GlobalConfigGetResponses, GlobalConfigRawGetResponses, GlobalConfigRawSetErrors, GlobalConfigRawSetResponses, GlobalConfigUnsetErrors, GlobalConfigUnsetResponses, GlobalConfigUpdateErrors, GlobalConfigUpdateResponses, GlobalDisposeResponses, GlobalEventResponses, GlobalHealthResponses, GlobalSyncResponses, InstanceDisposeResponses, LspStatusResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConfigRemoveErrors, McpConfigRemoveResponses, McpConfigSetErrors, McpConfigSetResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, NotebookExecuteResponses, NotebookInterruptResponses, NotebookRestartResponses, NotebookStatusResponses, Part as Part2, PartDeleteErrors, PartDeleteResponses, PartUpdateErrors, PartUpdateResponses, PathGetResponses, PermissionListResponses, PermissionReplyErrors, PermissionReplyResponses, PermissionRespondErrors, PermissionRespondResponses, PermissionRuleset, PostSettingsLocalModelsResponses, PostSettingsLocalResponses, PostSettingsLocalStartResponses, ProjectCurrentResponses, ProjectListResponses, ProjectUpdateErrors, ProjectUpdateResponses, ProvenanceExportResponses, ProvenanceListResponses, ProvenanceRecordErrors, ProvenanceRecordResponses, ProvenanceReviewErrors, ProvenanceReviewResponses, ProvenanceTraceErrors, ProvenanceTraceResponses, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeErrors, ProviderOauthAuthorizeResponses, ProviderOauthCallbackErrors, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyUpdateErrors, PtyUpdateResponses, PutSettingsSandboxResponses, QuestionAnswer, QuestionListResponses, QuestionRejectErrors, QuestionRejectResponses, QuestionReplyErrors, QuestionReplyResponses, SessionAbortErrors, SessionAbortResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteResponses, SessionDiffResponses, SessionForkResponses, SessionGetErrors, SessionGetResponses, SessionInitErrors, SessionInitResponses, SessionListResponses, SessionMessageErrors, SessionMessageResponses, SessionMessagesErrors, SessionMessagesResponses, SessionPromptAsyncErrors, SessionPromptAsyncResponses, SessionPromptErrors, SessionPromptResponses, SessionRevertErrors, SessionRevertResponses, SessionShellErrors, SessionShellResponses, SessionStatusErrors, SessionStatusResponses, SessionSummarizeErrors, SessionSummarizeResponses, SessionTodoErrors, SessionTodoResponses, SessionUnrevertErrors, SessionUnrevertResponses, SessionUpdateErrors, SessionUpdateResponses, SettingsBillingGetResponses, SettingsBillingUpdateResponses, SettingsComputeEndpointAddErrors, SettingsComputeEndpointAddResponses, SettingsComputeEndpointRemoveResponses, SettingsComputeGetResponses, SettingsComputeJobsCancelErrors, SettingsComputeJobsCancelResponses, SettingsComputeJobsClearResponses, SettingsComputeJobsListResponses, SettingsComputeJobsLogErrors, SettingsComputeJobsLogResponses, SettingsComputeJobsStartErrors, SettingsComputeJobsStartResponses, SettingsComputeProviderConnectErrors, SettingsComputeProviderConnectResponses, SettingsComputeProviderDisconnectResponses, SettingsComputeSshAddErrors, SettingsComputeSshAddResponses, SettingsComputeSshRemoveResponses, SettingsComputeSshTestErrors, SettingsComputeSshTestResponses, SettingsCredentialsListResponses, SettingsCredentialsRemoveResponses, SettingsCredentialsSetResponses, SettingsMemoryGetResponses, SettingsMemorySetResponses, SettingsNetworkGetResponses, SettingsNetworkSetResponses, SettingsPermissionsGetResponses, SettingsPermissionsRevokeAllErrors, SettingsPermissionsRevokeAllResponses, SettingsPermissionsSetErrors, SettingsPermissionsSetResponses, SettingsPreferencesGetResponses, SettingsPreferencesUpdateResponses, SettingsSkillsInstallErrors, SettingsSkillsInstallResponses, SettingsStorageRelocateResponses, SettingsStorageResetLocationResponses, SettingsStorageUsageResponses, SettingsUsageGetResponses, SettingsWalletGetResponses, SubtaskPartInput, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, VcsGetResponses, WorktreeCreateErrors, WorktreeCreateInput, WorktreeCreateResponses, WorktreeListResponses, WorktreeRemoveErrors, WorktreeRemoveInput, WorktreeRemoveResponses, WorktreeResetErrors, WorktreeResetInput, WorktreeResetResponses } from "./types.gen.js";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -1102,6 +1102,134 @@ export declare class Find extends HeyApiClient {
|
|
|
1102
1102
|
query: string;
|
|
1103
1103
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindSymbolsResponses, unknown, ThrowOnError, "fields">;
|
|
1104
1104
|
}
|
|
1105
|
+
export declare class Annotations extends HeyApiClient {
|
|
1106
|
+
/**
|
|
1107
|
+
* List artifact annotations
|
|
1108
|
+
*
|
|
1109
|
+
* List durable review threads anchored to a project artifact.
|
|
1110
|
+
*/
|
|
1111
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
1112
|
+
directory?: string;
|
|
1113
|
+
path: string;
|
|
1114
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsListResponses, unknown, ThrowOnError, "fields">;
|
|
1115
|
+
/**
|
|
1116
|
+
* Create an artifact annotation
|
|
1117
|
+
*
|
|
1118
|
+
* Create a durable review thread anchored to an artifact, text range, notebook cell, molecule, or locus.
|
|
1119
|
+
*/
|
|
1120
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
1121
|
+
directory?: string;
|
|
1122
|
+
path?: string;
|
|
1123
|
+
body?: string;
|
|
1124
|
+
author?: string;
|
|
1125
|
+
anchor?: {
|
|
1126
|
+
kind: "artifact";
|
|
1127
|
+
label?: string;
|
|
1128
|
+
} | {
|
|
1129
|
+
kind: "text";
|
|
1130
|
+
startLine: number;
|
|
1131
|
+
endLine: number;
|
|
1132
|
+
quote?: string;
|
|
1133
|
+
} | {
|
|
1134
|
+
kind: "notebook";
|
|
1135
|
+
cellId: string;
|
|
1136
|
+
line?: number;
|
|
1137
|
+
} | {
|
|
1138
|
+
kind: "molecule";
|
|
1139
|
+
selection: string;
|
|
1140
|
+
count?: number;
|
|
1141
|
+
} | {
|
|
1142
|
+
kind: "genome";
|
|
1143
|
+
chromosome: string;
|
|
1144
|
+
start: number;
|
|
1145
|
+
end: number;
|
|
1146
|
+
};
|
|
1147
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsCreateResponses, unknown, ThrowOnError, "fields">;
|
|
1148
|
+
/**
|
|
1149
|
+
* Read artifact annotation history
|
|
1150
|
+
*
|
|
1151
|
+
* Read every immutable revision of an artifact review thread, including a recoverable tombstone.
|
|
1152
|
+
*/
|
|
1153
|
+
history<ThrowOnError extends boolean = false>(parameters: {
|
|
1154
|
+
id: string;
|
|
1155
|
+
directory?: string;
|
|
1156
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsHistoryResponses, unknown, ThrowOnError, "fields">;
|
|
1157
|
+
/**
|
|
1158
|
+
* Tombstone an artifact annotation
|
|
1159
|
+
*
|
|
1160
|
+
* Hide an artifact review thread while retaining its recoverable revision history.
|
|
1161
|
+
*/
|
|
1162
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1163
|
+
id: string;
|
|
1164
|
+
directory?: string;
|
|
1165
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
1166
|
+
/**
|
|
1167
|
+
* Update an artifact annotation
|
|
1168
|
+
*
|
|
1169
|
+
* Reply to, resolve, or reopen an artifact review thread.
|
|
1170
|
+
*/
|
|
1171
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1172
|
+
id: string;
|
|
1173
|
+
directory?: string;
|
|
1174
|
+
status?: "open" | "resolved";
|
|
1175
|
+
body?: string;
|
|
1176
|
+
reply?: string;
|
|
1177
|
+
author?: string;
|
|
1178
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsUpdateResponses, unknown, ThrowOnError, "fields">;
|
|
1179
|
+
}
|
|
1180
|
+
export declare class Reviews extends HeyApiClient {
|
|
1181
|
+
/**
|
|
1182
|
+
* Read the current publication review
|
|
1183
|
+
*
|
|
1184
|
+
* Return the latest deterministic review report and whether it is stale for the current source bytes.
|
|
1185
|
+
*/
|
|
1186
|
+
current<ThrowOnError extends boolean = false>(parameters: {
|
|
1187
|
+
directory?: string;
|
|
1188
|
+
path: string;
|
|
1189
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReviewsCurrentResponses, FileReviewsCurrentErrors, ThrowOnError, "fields">;
|
|
1190
|
+
/**
|
|
1191
|
+
* Run deterministic publication checks
|
|
1192
|
+
*
|
|
1193
|
+
* Check citations, numeric traces, figures, and provenance for the exact Markdown manuscript bytes.
|
|
1194
|
+
*/
|
|
1195
|
+
run<ThrowOnError extends boolean = false>(parameters?: {
|
|
1196
|
+
directory?: string;
|
|
1197
|
+
path?: string;
|
|
1198
|
+
actor?: string;
|
|
1199
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReviewsRunResponses, unknown, ThrowOnError, "fields">;
|
|
1200
|
+
/**
|
|
1201
|
+
* List publication review history
|
|
1202
|
+
*
|
|
1203
|
+
* List prior deterministic review reports for every reviewed version of a manuscript.
|
|
1204
|
+
*/
|
|
1205
|
+
history<ThrowOnError extends boolean = false>(parameters: {
|
|
1206
|
+
directory?: string;
|
|
1207
|
+
path: string;
|
|
1208
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReviewsHistoryResponses, unknown, ThrowOnError, "fields">;
|
|
1209
|
+
/**
|
|
1210
|
+
* Resolve or override a publication finding
|
|
1211
|
+
*
|
|
1212
|
+
* Record an attributed reason and close one deterministic review finding.
|
|
1213
|
+
*/
|
|
1214
|
+
resolve<ThrowOnError extends boolean = false>(parameters: {
|
|
1215
|
+
id: string;
|
|
1216
|
+
finding: string;
|
|
1217
|
+
directory?: string;
|
|
1218
|
+
status?: "resolved" | "overridden";
|
|
1219
|
+
actor?: string;
|
|
1220
|
+
reason?: string;
|
|
1221
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReviewsResolveResponses, FileReviewsResolveErrors, ThrowOnError, "fields">;
|
|
1222
|
+
/**
|
|
1223
|
+
* Finalize a publication review
|
|
1224
|
+
*
|
|
1225
|
+
* Bind publication-ready state to the exact reviewed source hash after all blocking findings close.
|
|
1226
|
+
*/
|
|
1227
|
+
finalize<ThrowOnError extends boolean = false>(parameters: {
|
|
1228
|
+
id: string;
|
|
1229
|
+
directory?: string;
|
|
1230
|
+
actor?: string;
|
|
1231
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReviewsFinalizeResponses, FileReviewsFinalizeErrors, ThrowOnError, "fields">;
|
|
1232
|
+
}
|
|
1105
1233
|
export declare class File extends HeyApiClient {
|
|
1106
1234
|
/**
|
|
1107
1235
|
* List files
|
|
@@ -1208,6 +1336,8 @@ export declare class File extends HeyApiClient {
|
|
|
1208
1336
|
directory?: string;
|
|
1209
1337
|
path?: string;
|
|
1210
1338
|
format?: "html" | "pdf" | "docx" | "latex" | "pptx";
|
|
1339
|
+
readiness?: "draft" | "reviewed";
|
|
1340
|
+
review_id?: string;
|
|
1211
1341
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FilePublicationResponses, unknown, ThrowOnError, "fields">;
|
|
1212
1342
|
/**
|
|
1213
1343
|
* Get file status
|
|
@@ -1217,6 +1347,10 @@ export declare class File extends HeyApiClient {
|
|
|
1217
1347
|
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
1218
1348
|
directory?: string;
|
|
1219
1349
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileStatusResponses, unknown, ThrowOnError, "fields">;
|
|
1350
|
+
private _annotations?;
|
|
1351
|
+
get annotations(): Annotations;
|
|
1352
|
+
private _reviews?;
|
|
1353
|
+
get reviews(): Reviews;
|
|
1220
1354
|
}
|
|
1221
1355
|
export declare class Notebook extends HeyApiClient {
|
|
1222
1356
|
/**
|
package/dist/v2/gen/sdk.gen.js
CHANGED
|
@@ -2161,6 +2161,248 @@ export class Find extends HeyApiClient {
|
|
|
2161
2161
|
});
|
|
2162
2162
|
}
|
|
2163
2163
|
}
|
|
2164
|
+
export class Annotations extends HeyApiClient {
|
|
2165
|
+
/**
|
|
2166
|
+
* List artifact annotations
|
|
2167
|
+
*
|
|
2168
|
+
* List durable review threads anchored to a project artifact.
|
|
2169
|
+
*/
|
|
2170
|
+
list(parameters, options) {
|
|
2171
|
+
const params = buildClientParams([parameters], [
|
|
2172
|
+
{
|
|
2173
|
+
args: [
|
|
2174
|
+
{ in: "query", key: "directory" },
|
|
2175
|
+
{ in: "query", key: "path" },
|
|
2176
|
+
],
|
|
2177
|
+
},
|
|
2178
|
+
]);
|
|
2179
|
+
return (options?.client ?? this.client).get({
|
|
2180
|
+
url: "/file/annotations",
|
|
2181
|
+
...options,
|
|
2182
|
+
...params,
|
|
2183
|
+
});
|
|
2184
|
+
}
|
|
2185
|
+
/**
|
|
2186
|
+
* Create an artifact annotation
|
|
2187
|
+
*
|
|
2188
|
+
* Create a durable review thread anchored to an artifact, text range, notebook cell, molecule, or locus.
|
|
2189
|
+
*/
|
|
2190
|
+
create(parameters, options) {
|
|
2191
|
+
const params = buildClientParams([parameters], [
|
|
2192
|
+
{
|
|
2193
|
+
args: [
|
|
2194
|
+
{ in: "query", key: "directory" },
|
|
2195
|
+
{ in: "body", key: "path" },
|
|
2196
|
+
{ in: "body", key: "body" },
|
|
2197
|
+
{ in: "body", key: "author" },
|
|
2198
|
+
{ in: "body", key: "anchor" },
|
|
2199
|
+
],
|
|
2200
|
+
},
|
|
2201
|
+
]);
|
|
2202
|
+
return (options?.client ?? this.client).post({
|
|
2203
|
+
url: "/file/annotations",
|
|
2204
|
+
...options,
|
|
2205
|
+
...params,
|
|
2206
|
+
headers: {
|
|
2207
|
+
"Content-Type": "application/json",
|
|
2208
|
+
...options?.headers,
|
|
2209
|
+
...params.headers,
|
|
2210
|
+
},
|
|
2211
|
+
});
|
|
2212
|
+
}
|
|
2213
|
+
/**
|
|
2214
|
+
* Read artifact annotation history
|
|
2215
|
+
*
|
|
2216
|
+
* Read every immutable revision of an artifact review thread, including a recoverable tombstone.
|
|
2217
|
+
*/
|
|
2218
|
+
history(parameters, options) {
|
|
2219
|
+
const params = buildClientParams([parameters], [
|
|
2220
|
+
{
|
|
2221
|
+
args: [
|
|
2222
|
+
{ in: "path", key: "id" },
|
|
2223
|
+
{ in: "query", key: "directory" },
|
|
2224
|
+
],
|
|
2225
|
+
},
|
|
2226
|
+
]);
|
|
2227
|
+
return (options?.client ?? this.client).get({
|
|
2228
|
+
url: "/file/annotations/{id}/history",
|
|
2229
|
+
...options,
|
|
2230
|
+
...params,
|
|
2231
|
+
});
|
|
2232
|
+
}
|
|
2233
|
+
/**
|
|
2234
|
+
* Tombstone an artifact annotation
|
|
2235
|
+
*
|
|
2236
|
+
* Hide an artifact review thread while retaining its recoverable revision history.
|
|
2237
|
+
*/
|
|
2238
|
+
delete(parameters, options) {
|
|
2239
|
+
const params = buildClientParams([parameters], [
|
|
2240
|
+
{
|
|
2241
|
+
args: [
|
|
2242
|
+
{ in: "path", key: "id" },
|
|
2243
|
+
{ in: "query", key: "directory" },
|
|
2244
|
+
],
|
|
2245
|
+
},
|
|
2246
|
+
]);
|
|
2247
|
+
return (options?.client ?? this.client).delete({
|
|
2248
|
+
url: "/file/annotations/{id}",
|
|
2249
|
+
...options,
|
|
2250
|
+
...params,
|
|
2251
|
+
});
|
|
2252
|
+
}
|
|
2253
|
+
/**
|
|
2254
|
+
* Update an artifact annotation
|
|
2255
|
+
*
|
|
2256
|
+
* Reply to, resolve, or reopen an artifact review thread.
|
|
2257
|
+
*/
|
|
2258
|
+
update(parameters, options) {
|
|
2259
|
+
const params = buildClientParams([parameters], [
|
|
2260
|
+
{
|
|
2261
|
+
args: [
|
|
2262
|
+
{ in: "path", key: "id" },
|
|
2263
|
+
{ in: "query", key: "directory" },
|
|
2264
|
+
{ in: "body", key: "status" },
|
|
2265
|
+
{ in: "body", key: "body" },
|
|
2266
|
+
{ in: "body", key: "reply" },
|
|
2267
|
+
{ in: "body", key: "author" },
|
|
2268
|
+
],
|
|
2269
|
+
},
|
|
2270
|
+
]);
|
|
2271
|
+
return (options?.client ?? this.client).patch({
|
|
2272
|
+
url: "/file/annotations/{id}",
|
|
2273
|
+
...options,
|
|
2274
|
+
...params,
|
|
2275
|
+
headers: {
|
|
2276
|
+
"Content-Type": "application/json",
|
|
2277
|
+
...options?.headers,
|
|
2278
|
+
...params.headers,
|
|
2279
|
+
},
|
|
2280
|
+
});
|
|
2281
|
+
}
|
|
2282
|
+
}
|
|
2283
|
+
export class Reviews extends HeyApiClient {
|
|
2284
|
+
/**
|
|
2285
|
+
* Read the current publication review
|
|
2286
|
+
*
|
|
2287
|
+
* Return the latest deterministic review report and whether it is stale for the current source bytes.
|
|
2288
|
+
*/
|
|
2289
|
+
current(parameters, options) {
|
|
2290
|
+
const params = buildClientParams([parameters], [
|
|
2291
|
+
{
|
|
2292
|
+
args: [
|
|
2293
|
+
{ in: "query", key: "directory" },
|
|
2294
|
+
{ in: "query", key: "path" },
|
|
2295
|
+
],
|
|
2296
|
+
},
|
|
2297
|
+
]);
|
|
2298
|
+
return (options?.client ?? this.client).get({
|
|
2299
|
+
url: "/file/reviews",
|
|
2300
|
+
...options,
|
|
2301
|
+
...params,
|
|
2302
|
+
});
|
|
2303
|
+
}
|
|
2304
|
+
/**
|
|
2305
|
+
* Run deterministic publication checks
|
|
2306
|
+
*
|
|
2307
|
+
* Check citations, numeric traces, figures, and provenance for the exact Markdown manuscript bytes.
|
|
2308
|
+
*/
|
|
2309
|
+
run(parameters, options) {
|
|
2310
|
+
const params = buildClientParams([parameters], [
|
|
2311
|
+
{
|
|
2312
|
+
args: [
|
|
2313
|
+
{ in: "query", key: "directory" },
|
|
2314
|
+
{ in: "body", key: "path" },
|
|
2315
|
+
{ in: "body", key: "actor" },
|
|
2316
|
+
],
|
|
2317
|
+
},
|
|
2318
|
+
]);
|
|
2319
|
+
return (options?.client ?? this.client).post({
|
|
2320
|
+
url: "/file/reviews",
|
|
2321
|
+
...options,
|
|
2322
|
+
...params,
|
|
2323
|
+
headers: {
|
|
2324
|
+
"Content-Type": "application/json",
|
|
2325
|
+
...options?.headers,
|
|
2326
|
+
...params.headers,
|
|
2327
|
+
},
|
|
2328
|
+
});
|
|
2329
|
+
}
|
|
2330
|
+
/**
|
|
2331
|
+
* List publication review history
|
|
2332
|
+
*
|
|
2333
|
+
* List prior deterministic review reports for every reviewed version of a manuscript.
|
|
2334
|
+
*/
|
|
2335
|
+
history(parameters, options) {
|
|
2336
|
+
const params = buildClientParams([parameters], [
|
|
2337
|
+
{
|
|
2338
|
+
args: [
|
|
2339
|
+
{ in: "query", key: "directory" },
|
|
2340
|
+
{ in: "query", key: "path" },
|
|
2341
|
+
],
|
|
2342
|
+
},
|
|
2343
|
+
]);
|
|
2344
|
+
return (options?.client ?? this.client).get({
|
|
2345
|
+
url: "/file/reviews/history",
|
|
2346
|
+
...options,
|
|
2347
|
+
...params,
|
|
2348
|
+
});
|
|
2349
|
+
}
|
|
2350
|
+
/**
|
|
2351
|
+
* Resolve or override a publication finding
|
|
2352
|
+
*
|
|
2353
|
+
* Record an attributed reason and close one deterministic review finding.
|
|
2354
|
+
*/
|
|
2355
|
+
resolve(parameters, options) {
|
|
2356
|
+
const params = buildClientParams([parameters], [
|
|
2357
|
+
{
|
|
2358
|
+
args: [
|
|
2359
|
+
{ in: "path", key: "id" },
|
|
2360
|
+
{ in: "path", key: "finding" },
|
|
2361
|
+
{ in: "query", key: "directory" },
|
|
2362
|
+
{ in: "body", key: "status" },
|
|
2363
|
+
{ in: "body", key: "actor" },
|
|
2364
|
+
{ in: "body", key: "reason" },
|
|
2365
|
+
],
|
|
2366
|
+
},
|
|
2367
|
+
]);
|
|
2368
|
+
return (options?.client ?? this.client).patch({
|
|
2369
|
+
url: "/file/reviews/{id}/findings/{finding}",
|
|
2370
|
+
...options,
|
|
2371
|
+
...params,
|
|
2372
|
+
headers: {
|
|
2373
|
+
"Content-Type": "application/json",
|
|
2374
|
+
...options?.headers,
|
|
2375
|
+
...params.headers,
|
|
2376
|
+
},
|
|
2377
|
+
});
|
|
2378
|
+
}
|
|
2379
|
+
/**
|
|
2380
|
+
* Finalize a publication review
|
|
2381
|
+
*
|
|
2382
|
+
* Bind publication-ready state to the exact reviewed source hash after all blocking findings close.
|
|
2383
|
+
*/
|
|
2384
|
+
finalize(parameters, options) {
|
|
2385
|
+
const params = buildClientParams([parameters], [
|
|
2386
|
+
{
|
|
2387
|
+
args: [
|
|
2388
|
+
{ in: "path", key: "id" },
|
|
2389
|
+
{ in: "query", key: "directory" },
|
|
2390
|
+
{ in: "body", key: "actor" },
|
|
2391
|
+
],
|
|
2392
|
+
},
|
|
2393
|
+
]);
|
|
2394
|
+
return (options?.client ?? this.client).post({
|
|
2395
|
+
url: "/file/reviews/{id}/finalize",
|
|
2396
|
+
...options,
|
|
2397
|
+
...params,
|
|
2398
|
+
headers: {
|
|
2399
|
+
"Content-Type": "application/json",
|
|
2400
|
+
...options?.headers,
|
|
2401
|
+
...params.headers,
|
|
2402
|
+
},
|
|
2403
|
+
});
|
|
2404
|
+
}
|
|
2405
|
+
}
|
|
2164
2406
|
export class File extends HeyApiClient {
|
|
2165
2407
|
/**
|
|
2166
2408
|
* List files
|
|
@@ -2377,6 +2619,8 @@ export class File extends HeyApiClient {
|
|
|
2377
2619
|
{ in: "query", key: "directory" },
|
|
2378
2620
|
{ in: "body", key: "path" },
|
|
2379
2621
|
{ in: "body", key: "format" },
|
|
2622
|
+
{ in: "body", key: "readiness" },
|
|
2623
|
+
{ in: "body", key: "review_id" },
|
|
2380
2624
|
],
|
|
2381
2625
|
},
|
|
2382
2626
|
]);
|
|
@@ -2404,6 +2648,14 @@ export class File extends HeyApiClient {
|
|
|
2404
2648
|
...params,
|
|
2405
2649
|
});
|
|
2406
2650
|
}
|
|
2651
|
+
_annotations;
|
|
2652
|
+
get annotations() {
|
|
2653
|
+
return (this._annotations ??= new Annotations({ client: this.client }));
|
|
2654
|
+
}
|
|
2655
|
+
_reviews;
|
|
2656
|
+
get reviews() {
|
|
2657
|
+
return (this._reviews ??= new Reviews({ client: this.client }));
|
|
2658
|
+
}
|
|
2407
2659
|
}
|
|
2408
2660
|
export class Notebook extends HeyApiClient {
|
|
2409
2661
|
/**
|
|
@@ -5156,6 +5156,330 @@ export type FileReproducibilityResponses = {
|
|
|
5156
5156
|
};
|
|
5157
5157
|
};
|
|
5158
5158
|
export type FileReproducibilityResponse = FileReproducibilityResponses[keyof FileReproducibilityResponses];
|
|
5159
|
+
export type FileAnnotationsListData = {
|
|
5160
|
+
body?: never;
|
|
5161
|
+
path?: never;
|
|
5162
|
+
query: {
|
|
5163
|
+
directory?: string;
|
|
5164
|
+
path: string;
|
|
5165
|
+
};
|
|
5166
|
+
url: "/file/annotations";
|
|
5167
|
+
};
|
|
5168
|
+
export type FileAnnotationsListResponses = {
|
|
5169
|
+
/**
|
|
5170
|
+
* Artifact annotations
|
|
5171
|
+
*/
|
|
5172
|
+
200: Array<{
|
|
5173
|
+
id: string;
|
|
5174
|
+
projectID: string;
|
|
5175
|
+
path: string;
|
|
5176
|
+
artifactHash: string;
|
|
5177
|
+
anchor: {
|
|
5178
|
+
kind: "artifact";
|
|
5179
|
+
label?: string;
|
|
5180
|
+
} | {
|
|
5181
|
+
kind: "text";
|
|
5182
|
+
startLine: number;
|
|
5183
|
+
endLine: number;
|
|
5184
|
+
quote?: string;
|
|
5185
|
+
} | {
|
|
5186
|
+
kind: "notebook";
|
|
5187
|
+
cellId: string;
|
|
5188
|
+
line?: number;
|
|
5189
|
+
} | {
|
|
5190
|
+
kind: "molecule";
|
|
5191
|
+
selection: string;
|
|
5192
|
+
count?: number;
|
|
5193
|
+
} | {
|
|
5194
|
+
kind: "genome";
|
|
5195
|
+
chromosome: string;
|
|
5196
|
+
start: number;
|
|
5197
|
+
end: number;
|
|
5198
|
+
};
|
|
5199
|
+
messages: Array<{
|
|
5200
|
+
id: string;
|
|
5201
|
+
body: string;
|
|
5202
|
+
author: string;
|
|
5203
|
+
createdAt: number;
|
|
5204
|
+
}>;
|
|
5205
|
+
status: "open" | "resolved";
|
|
5206
|
+
version: number;
|
|
5207
|
+
revisions: Array<{
|
|
5208
|
+
version: number;
|
|
5209
|
+
event: "created" | "edited" | "replied" | "resolved" | "reopened" | "deleted";
|
|
5210
|
+
actor: string;
|
|
5211
|
+
at: number;
|
|
5212
|
+
status: "open" | "resolved";
|
|
5213
|
+
messages: Array<{
|
|
5214
|
+
id: string;
|
|
5215
|
+
body: string;
|
|
5216
|
+
author: string;
|
|
5217
|
+
createdAt: number;
|
|
5218
|
+
}>;
|
|
5219
|
+
deletedAt?: number;
|
|
5220
|
+
}>;
|
|
5221
|
+
createdAt: number;
|
|
5222
|
+
updatedAt: number;
|
|
5223
|
+
deletedAt?: number;
|
|
5224
|
+
}>;
|
|
5225
|
+
};
|
|
5226
|
+
export type FileAnnotationsListResponse = FileAnnotationsListResponses[keyof FileAnnotationsListResponses];
|
|
5227
|
+
export type FileAnnotationsCreateData = {
|
|
5228
|
+
body?: {
|
|
5229
|
+
path: string;
|
|
5230
|
+
body: string;
|
|
5231
|
+
author?: string;
|
|
5232
|
+
anchor?: {
|
|
5233
|
+
kind: "artifact";
|
|
5234
|
+
label?: string;
|
|
5235
|
+
} | {
|
|
5236
|
+
kind: "text";
|
|
5237
|
+
startLine: number;
|
|
5238
|
+
endLine: number;
|
|
5239
|
+
quote?: string;
|
|
5240
|
+
} | {
|
|
5241
|
+
kind: "notebook";
|
|
5242
|
+
cellId: string;
|
|
5243
|
+
line?: number;
|
|
5244
|
+
} | {
|
|
5245
|
+
kind: "molecule";
|
|
5246
|
+
selection: string;
|
|
5247
|
+
count?: number;
|
|
5248
|
+
} | {
|
|
5249
|
+
kind: "genome";
|
|
5250
|
+
chromosome: string;
|
|
5251
|
+
start: number;
|
|
5252
|
+
end: number;
|
|
5253
|
+
};
|
|
5254
|
+
};
|
|
5255
|
+
path?: never;
|
|
5256
|
+
query?: {
|
|
5257
|
+
directory?: string;
|
|
5258
|
+
};
|
|
5259
|
+
url: "/file/annotations";
|
|
5260
|
+
};
|
|
5261
|
+
export type FileAnnotationsCreateResponses = {
|
|
5262
|
+
/**
|
|
5263
|
+
* Created annotation
|
|
5264
|
+
*/
|
|
5265
|
+
200: {
|
|
5266
|
+
id: string;
|
|
5267
|
+
projectID: string;
|
|
5268
|
+
path: string;
|
|
5269
|
+
artifactHash: string;
|
|
5270
|
+
anchor: {
|
|
5271
|
+
kind: "artifact";
|
|
5272
|
+
label?: string;
|
|
5273
|
+
} | {
|
|
5274
|
+
kind: "text";
|
|
5275
|
+
startLine: number;
|
|
5276
|
+
endLine: number;
|
|
5277
|
+
quote?: string;
|
|
5278
|
+
} | {
|
|
5279
|
+
kind: "notebook";
|
|
5280
|
+
cellId: string;
|
|
5281
|
+
line?: number;
|
|
5282
|
+
} | {
|
|
5283
|
+
kind: "molecule";
|
|
5284
|
+
selection: string;
|
|
5285
|
+
count?: number;
|
|
5286
|
+
} | {
|
|
5287
|
+
kind: "genome";
|
|
5288
|
+
chromosome: string;
|
|
5289
|
+
start: number;
|
|
5290
|
+
end: number;
|
|
5291
|
+
};
|
|
5292
|
+
messages: Array<{
|
|
5293
|
+
id: string;
|
|
5294
|
+
body: string;
|
|
5295
|
+
author: string;
|
|
5296
|
+
createdAt: number;
|
|
5297
|
+
}>;
|
|
5298
|
+
status: "open" | "resolved";
|
|
5299
|
+
version: number;
|
|
5300
|
+
revisions: Array<{
|
|
5301
|
+
version: number;
|
|
5302
|
+
event: "created" | "edited" | "replied" | "resolved" | "reopened" | "deleted";
|
|
5303
|
+
actor: string;
|
|
5304
|
+
at: number;
|
|
5305
|
+
status: "open" | "resolved";
|
|
5306
|
+
messages: Array<{
|
|
5307
|
+
id: string;
|
|
5308
|
+
body: string;
|
|
5309
|
+
author: string;
|
|
5310
|
+
createdAt: number;
|
|
5311
|
+
}>;
|
|
5312
|
+
deletedAt?: number;
|
|
5313
|
+
}>;
|
|
5314
|
+
createdAt: number;
|
|
5315
|
+
updatedAt: number;
|
|
5316
|
+
deletedAt?: number;
|
|
5317
|
+
};
|
|
5318
|
+
};
|
|
5319
|
+
export type FileAnnotationsCreateResponse = FileAnnotationsCreateResponses[keyof FileAnnotationsCreateResponses];
|
|
5320
|
+
export type FileAnnotationsHistoryData = {
|
|
5321
|
+
body?: never;
|
|
5322
|
+
path: {
|
|
5323
|
+
id: string;
|
|
5324
|
+
};
|
|
5325
|
+
query?: {
|
|
5326
|
+
directory?: string;
|
|
5327
|
+
};
|
|
5328
|
+
url: "/file/annotations/{id}/history";
|
|
5329
|
+
};
|
|
5330
|
+
export type FileAnnotationsHistoryResponses = {
|
|
5331
|
+
/**
|
|
5332
|
+
* Versioned artifact annotation
|
|
5333
|
+
*/
|
|
5334
|
+
200: {
|
|
5335
|
+
id: string;
|
|
5336
|
+
projectID: string;
|
|
5337
|
+
path: string;
|
|
5338
|
+
artifactHash: string;
|
|
5339
|
+
anchor: {
|
|
5340
|
+
kind: "artifact";
|
|
5341
|
+
label?: string;
|
|
5342
|
+
} | {
|
|
5343
|
+
kind: "text";
|
|
5344
|
+
startLine: number;
|
|
5345
|
+
endLine: number;
|
|
5346
|
+
quote?: string;
|
|
5347
|
+
} | {
|
|
5348
|
+
kind: "notebook";
|
|
5349
|
+
cellId: string;
|
|
5350
|
+
line?: number;
|
|
5351
|
+
} | {
|
|
5352
|
+
kind: "molecule";
|
|
5353
|
+
selection: string;
|
|
5354
|
+
count?: number;
|
|
5355
|
+
} | {
|
|
5356
|
+
kind: "genome";
|
|
5357
|
+
chromosome: string;
|
|
5358
|
+
start: number;
|
|
5359
|
+
end: number;
|
|
5360
|
+
};
|
|
5361
|
+
messages: Array<{
|
|
5362
|
+
id: string;
|
|
5363
|
+
body: string;
|
|
5364
|
+
author: string;
|
|
5365
|
+
createdAt: number;
|
|
5366
|
+
}>;
|
|
5367
|
+
status: "open" | "resolved";
|
|
5368
|
+
version: number;
|
|
5369
|
+
revisions: Array<{
|
|
5370
|
+
version: number;
|
|
5371
|
+
event: "created" | "edited" | "replied" | "resolved" | "reopened" | "deleted";
|
|
5372
|
+
actor: string;
|
|
5373
|
+
at: number;
|
|
5374
|
+
status: "open" | "resolved";
|
|
5375
|
+
messages: Array<{
|
|
5376
|
+
id: string;
|
|
5377
|
+
body: string;
|
|
5378
|
+
author: string;
|
|
5379
|
+
createdAt: number;
|
|
5380
|
+
}>;
|
|
5381
|
+
deletedAt?: number;
|
|
5382
|
+
}>;
|
|
5383
|
+
createdAt: number;
|
|
5384
|
+
updatedAt: number;
|
|
5385
|
+
deletedAt?: number;
|
|
5386
|
+
};
|
|
5387
|
+
};
|
|
5388
|
+
export type FileAnnotationsHistoryResponse = FileAnnotationsHistoryResponses[keyof FileAnnotationsHistoryResponses];
|
|
5389
|
+
export type FileAnnotationsDeleteData = {
|
|
5390
|
+
body?: never;
|
|
5391
|
+
path: {
|
|
5392
|
+
id: string;
|
|
5393
|
+
};
|
|
5394
|
+
query?: {
|
|
5395
|
+
directory?: string;
|
|
5396
|
+
};
|
|
5397
|
+
url: "/file/annotations/{id}";
|
|
5398
|
+
};
|
|
5399
|
+
export type FileAnnotationsDeleteResponses = {
|
|
5400
|
+
/**
|
|
5401
|
+
* Tombstoned annotation
|
|
5402
|
+
*/
|
|
5403
|
+
200: {
|
|
5404
|
+
deleted: true;
|
|
5405
|
+
version: number;
|
|
5406
|
+
};
|
|
5407
|
+
};
|
|
5408
|
+
export type FileAnnotationsDeleteResponse = FileAnnotationsDeleteResponses[keyof FileAnnotationsDeleteResponses];
|
|
5409
|
+
export type FileAnnotationsUpdateData = {
|
|
5410
|
+
body?: {
|
|
5411
|
+
status?: "open" | "resolved";
|
|
5412
|
+
body?: string;
|
|
5413
|
+
reply?: string;
|
|
5414
|
+
author?: string;
|
|
5415
|
+
};
|
|
5416
|
+
path: {
|
|
5417
|
+
id: string;
|
|
5418
|
+
};
|
|
5419
|
+
query?: {
|
|
5420
|
+
directory?: string;
|
|
5421
|
+
};
|
|
5422
|
+
url: "/file/annotations/{id}";
|
|
5423
|
+
};
|
|
5424
|
+
export type FileAnnotationsUpdateResponses = {
|
|
5425
|
+
/**
|
|
5426
|
+
* Updated annotation
|
|
5427
|
+
*/
|
|
5428
|
+
200: {
|
|
5429
|
+
id: string;
|
|
5430
|
+
projectID: string;
|
|
5431
|
+
path: string;
|
|
5432
|
+
artifactHash: string;
|
|
5433
|
+
anchor: {
|
|
5434
|
+
kind: "artifact";
|
|
5435
|
+
label?: string;
|
|
5436
|
+
} | {
|
|
5437
|
+
kind: "text";
|
|
5438
|
+
startLine: number;
|
|
5439
|
+
endLine: number;
|
|
5440
|
+
quote?: string;
|
|
5441
|
+
} | {
|
|
5442
|
+
kind: "notebook";
|
|
5443
|
+
cellId: string;
|
|
5444
|
+
line?: number;
|
|
5445
|
+
} | {
|
|
5446
|
+
kind: "molecule";
|
|
5447
|
+
selection: string;
|
|
5448
|
+
count?: number;
|
|
5449
|
+
} | {
|
|
5450
|
+
kind: "genome";
|
|
5451
|
+
chromosome: string;
|
|
5452
|
+
start: number;
|
|
5453
|
+
end: number;
|
|
5454
|
+
};
|
|
5455
|
+
messages: Array<{
|
|
5456
|
+
id: string;
|
|
5457
|
+
body: string;
|
|
5458
|
+
author: string;
|
|
5459
|
+
createdAt: number;
|
|
5460
|
+
}>;
|
|
5461
|
+
status: "open" | "resolved";
|
|
5462
|
+
version: number;
|
|
5463
|
+
revisions: Array<{
|
|
5464
|
+
version: number;
|
|
5465
|
+
event: "created" | "edited" | "replied" | "resolved" | "reopened" | "deleted";
|
|
5466
|
+
actor: string;
|
|
5467
|
+
at: number;
|
|
5468
|
+
status: "open" | "resolved";
|
|
5469
|
+
messages: Array<{
|
|
5470
|
+
id: string;
|
|
5471
|
+
body: string;
|
|
5472
|
+
author: string;
|
|
5473
|
+
createdAt: number;
|
|
5474
|
+
}>;
|
|
5475
|
+
deletedAt?: number;
|
|
5476
|
+
}>;
|
|
5477
|
+
createdAt: number;
|
|
5478
|
+
updatedAt: number;
|
|
5479
|
+
deletedAt?: number;
|
|
5480
|
+
};
|
|
5481
|
+
};
|
|
5482
|
+
export type FileAnnotationsUpdateResponse = FileAnnotationsUpdateResponses[keyof FileAnnotationsUpdateResponses];
|
|
5159
5483
|
export type FileManifestData = {
|
|
5160
5484
|
body?: never;
|
|
5161
5485
|
path?: never;
|
|
@@ -5232,6 +5556,8 @@ export type FilePublicationData = {
|
|
|
5232
5556
|
body?: {
|
|
5233
5557
|
path: string;
|
|
5234
5558
|
format: "html" | "pdf" | "docx" | "latex" | "pptx";
|
|
5559
|
+
readiness?: "draft" | "reviewed";
|
|
5560
|
+
review_id?: string;
|
|
5235
5561
|
};
|
|
5236
5562
|
path?: never;
|
|
5237
5563
|
query?: {
|
|
@@ -5249,9 +5575,381 @@ export type FilePublicationResponses = {
|
|
|
5249
5575
|
size: number;
|
|
5250
5576
|
created_at: string;
|
|
5251
5577
|
engine: string;
|
|
5578
|
+
readiness: "draft" | "reviewed";
|
|
5579
|
+
review_id?: string;
|
|
5252
5580
|
};
|
|
5253
5581
|
};
|
|
5254
5582
|
export type FilePublicationResponse = FilePublicationResponses[keyof FilePublicationResponses];
|
|
5583
|
+
export type FileReviewsCurrentData = {
|
|
5584
|
+
body?: never;
|
|
5585
|
+
path?: never;
|
|
5586
|
+
query: {
|
|
5587
|
+
directory?: string;
|
|
5588
|
+
path: string;
|
|
5589
|
+
};
|
|
5590
|
+
url: "/file/reviews";
|
|
5591
|
+
};
|
|
5592
|
+
export type FileReviewsCurrentErrors = {
|
|
5593
|
+
/**
|
|
5594
|
+
* No publication review exists for this manuscript
|
|
5595
|
+
*/
|
|
5596
|
+
404: unknown;
|
|
5597
|
+
};
|
|
5598
|
+
export type FileReviewsCurrentResponses = {
|
|
5599
|
+
/**
|
|
5600
|
+
* Current publication review
|
|
5601
|
+
*/
|
|
5602
|
+
200: {
|
|
5603
|
+
format: "openscience.publication-review.v1";
|
|
5604
|
+
id: string;
|
|
5605
|
+
projectID: string;
|
|
5606
|
+
path: string;
|
|
5607
|
+
artifactHash: string;
|
|
5608
|
+
version: number;
|
|
5609
|
+
status: "blocked" | "warnings" | "ready";
|
|
5610
|
+
summary: {
|
|
5611
|
+
total: number;
|
|
5612
|
+
open: number;
|
|
5613
|
+
blocking: number;
|
|
5614
|
+
major: number;
|
|
5615
|
+
minor: number;
|
|
5616
|
+
info: number;
|
|
5617
|
+
resolved: number;
|
|
5618
|
+
overridden: number;
|
|
5619
|
+
};
|
|
5620
|
+
findings: Array<{
|
|
5621
|
+
id: string;
|
|
5622
|
+
check: "citation" | "numeric" | "figure" | "provenance";
|
|
5623
|
+
severity: "blocking" | "major" | "minor" | "info";
|
|
5624
|
+
status: "open" | "resolved" | "overridden";
|
|
5625
|
+
title: string;
|
|
5626
|
+
detail: string;
|
|
5627
|
+
evidence: Array<string>;
|
|
5628
|
+
location: {
|
|
5629
|
+
path: string;
|
|
5630
|
+
line?: number;
|
|
5631
|
+
};
|
|
5632
|
+
resolution?: {
|
|
5633
|
+
kind: "resolved" | "overridden";
|
|
5634
|
+
actor: string;
|
|
5635
|
+
reason: string;
|
|
5636
|
+
at: number;
|
|
5637
|
+
};
|
|
5638
|
+
}>;
|
|
5639
|
+
events: Array<{
|
|
5640
|
+
version: number;
|
|
5641
|
+
type: "generated" | "resolved" | "overridden" | "finalized";
|
|
5642
|
+
actor: string;
|
|
5643
|
+
at: number;
|
|
5644
|
+
findingID?: string;
|
|
5645
|
+
reason?: string;
|
|
5646
|
+
}>;
|
|
5647
|
+
finalized?: {
|
|
5648
|
+
actor: string;
|
|
5649
|
+
at: number;
|
|
5650
|
+
artifactHash: string;
|
|
5651
|
+
};
|
|
5652
|
+
createdAt: number;
|
|
5653
|
+
updatedAt: number;
|
|
5654
|
+
stale: boolean;
|
|
5655
|
+
};
|
|
5656
|
+
};
|
|
5657
|
+
export type FileReviewsCurrentResponse = FileReviewsCurrentResponses[keyof FileReviewsCurrentResponses];
|
|
5658
|
+
export type FileReviewsRunData = {
|
|
5659
|
+
body?: {
|
|
5660
|
+
path: string;
|
|
5661
|
+
actor?: string;
|
|
5662
|
+
};
|
|
5663
|
+
path?: never;
|
|
5664
|
+
query?: {
|
|
5665
|
+
directory?: string;
|
|
5666
|
+
};
|
|
5667
|
+
url: "/file/reviews";
|
|
5668
|
+
};
|
|
5669
|
+
export type FileReviewsRunResponses = {
|
|
5670
|
+
/**
|
|
5671
|
+
* Generated publication review
|
|
5672
|
+
*/
|
|
5673
|
+
200: {
|
|
5674
|
+
format: "openscience.publication-review.v1";
|
|
5675
|
+
id: string;
|
|
5676
|
+
projectID: string;
|
|
5677
|
+
path: string;
|
|
5678
|
+
artifactHash: string;
|
|
5679
|
+
version: number;
|
|
5680
|
+
status: "blocked" | "warnings" | "ready";
|
|
5681
|
+
summary: {
|
|
5682
|
+
total: number;
|
|
5683
|
+
open: number;
|
|
5684
|
+
blocking: number;
|
|
5685
|
+
major: number;
|
|
5686
|
+
minor: number;
|
|
5687
|
+
info: number;
|
|
5688
|
+
resolved: number;
|
|
5689
|
+
overridden: number;
|
|
5690
|
+
};
|
|
5691
|
+
findings: Array<{
|
|
5692
|
+
id: string;
|
|
5693
|
+
check: "citation" | "numeric" | "figure" | "provenance";
|
|
5694
|
+
severity: "blocking" | "major" | "minor" | "info";
|
|
5695
|
+
status: "open" | "resolved" | "overridden";
|
|
5696
|
+
title: string;
|
|
5697
|
+
detail: string;
|
|
5698
|
+
evidence: Array<string>;
|
|
5699
|
+
location: {
|
|
5700
|
+
path: string;
|
|
5701
|
+
line?: number;
|
|
5702
|
+
};
|
|
5703
|
+
resolution?: {
|
|
5704
|
+
kind: "resolved" | "overridden";
|
|
5705
|
+
actor: string;
|
|
5706
|
+
reason: string;
|
|
5707
|
+
at: number;
|
|
5708
|
+
};
|
|
5709
|
+
}>;
|
|
5710
|
+
events: Array<{
|
|
5711
|
+
version: number;
|
|
5712
|
+
type: "generated" | "resolved" | "overridden" | "finalized";
|
|
5713
|
+
actor: string;
|
|
5714
|
+
at: number;
|
|
5715
|
+
findingID?: string;
|
|
5716
|
+
reason?: string;
|
|
5717
|
+
}>;
|
|
5718
|
+
finalized?: {
|
|
5719
|
+
actor: string;
|
|
5720
|
+
at: number;
|
|
5721
|
+
artifactHash: string;
|
|
5722
|
+
};
|
|
5723
|
+
createdAt: number;
|
|
5724
|
+
updatedAt: number;
|
|
5725
|
+
};
|
|
5726
|
+
};
|
|
5727
|
+
export type FileReviewsRunResponse = FileReviewsRunResponses[keyof FileReviewsRunResponses];
|
|
5728
|
+
export type FileReviewsHistoryData = {
|
|
5729
|
+
body?: never;
|
|
5730
|
+
path?: never;
|
|
5731
|
+
query: {
|
|
5732
|
+
directory?: string;
|
|
5733
|
+
path: string;
|
|
5734
|
+
};
|
|
5735
|
+
url: "/file/reviews/history";
|
|
5736
|
+
};
|
|
5737
|
+
export type FileReviewsHistoryResponses = {
|
|
5738
|
+
/**
|
|
5739
|
+
* Publication review history
|
|
5740
|
+
*/
|
|
5741
|
+
200: Array<{
|
|
5742
|
+
format: "openscience.publication-review.v1";
|
|
5743
|
+
id: string;
|
|
5744
|
+
projectID: string;
|
|
5745
|
+
path: string;
|
|
5746
|
+
artifactHash: string;
|
|
5747
|
+
version: number;
|
|
5748
|
+
status: "blocked" | "warnings" | "ready";
|
|
5749
|
+
summary: {
|
|
5750
|
+
total: number;
|
|
5751
|
+
open: number;
|
|
5752
|
+
blocking: number;
|
|
5753
|
+
major: number;
|
|
5754
|
+
minor: number;
|
|
5755
|
+
info: number;
|
|
5756
|
+
resolved: number;
|
|
5757
|
+
overridden: number;
|
|
5758
|
+
};
|
|
5759
|
+
findings: Array<{
|
|
5760
|
+
id: string;
|
|
5761
|
+
check: "citation" | "numeric" | "figure" | "provenance";
|
|
5762
|
+
severity: "blocking" | "major" | "minor" | "info";
|
|
5763
|
+
status: "open" | "resolved" | "overridden";
|
|
5764
|
+
title: string;
|
|
5765
|
+
detail: string;
|
|
5766
|
+
evidence: Array<string>;
|
|
5767
|
+
location: {
|
|
5768
|
+
path: string;
|
|
5769
|
+
line?: number;
|
|
5770
|
+
};
|
|
5771
|
+
resolution?: {
|
|
5772
|
+
kind: "resolved" | "overridden";
|
|
5773
|
+
actor: string;
|
|
5774
|
+
reason: string;
|
|
5775
|
+
at: number;
|
|
5776
|
+
};
|
|
5777
|
+
}>;
|
|
5778
|
+
events: Array<{
|
|
5779
|
+
version: number;
|
|
5780
|
+
type: "generated" | "resolved" | "overridden" | "finalized";
|
|
5781
|
+
actor: string;
|
|
5782
|
+
at: number;
|
|
5783
|
+
findingID?: string;
|
|
5784
|
+
reason?: string;
|
|
5785
|
+
}>;
|
|
5786
|
+
finalized?: {
|
|
5787
|
+
actor: string;
|
|
5788
|
+
at: number;
|
|
5789
|
+
artifactHash: string;
|
|
5790
|
+
};
|
|
5791
|
+
createdAt: number;
|
|
5792
|
+
updatedAt: number;
|
|
5793
|
+
}>;
|
|
5794
|
+
};
|
|
5795
|
+
export type FileReviewsHistoryResponse = FileReviewsHistoryResponses[keyof FileReviewsHistoryResponses];
|
|
5796
|
+
export type FileReviewsResolveData = {
|
|
5797
|
+
body?: {
|
|
5798
|
+
status: "resolved" | "overridden";
|
|
5799
|
+
actor: string;
|
|
5800
|
+
reason: string;
|
|
5801
|
+
};
|
|
5802
|
+
path: {
|
|
5803
|
+
id: string;
|
|
5804
|
+
finding: string;
|
|
5805
|
+
};
|
|
5806
|
+
query?: {
|
|
5807
|
+
directory?: string;
|
|
5808
|
+
};
|
|
5809
|
+
url: "/file/reviews/{id}/findings/{finding}";
|
|
5810
|
+
};
|
|
5811
|
+
export type FileReviewsResolveErrors = {
|
|
5812
|
+
/**
|
|
5813
|
+
* Finding cannot be updated
|
|
5814
|
+
*/
|
|
5815
|
+
409: unknown;
|
|
5816
|
+
};
|
|
5817
|
+
export type FileReviewsResolveResponses = {
|
|
5818
|
+
/**
|
|
5819
|
+
* Updated publication review
|
|
5820
|
+
*/
|
|
5821
|
+
200: {
|
|
5822
|
+
format: "openscience.publication-review.v1";
|
|
5823
|
+
id: string;
|
|
5824
|
+
projectID: string;
|
|
5825
|
+
path: string;
|
|
5826
|
+
artifactHash: string;
|
|
5827
|
+
version: number;
|
|
5828
|
+
status: "blocked" | "warnings" | "ready";
|
|
5829
|
+
summary: {
|
|
5830
|
+
total: number;
|
|
5831
|
+
open: number;
|
|
5832
|
+
blocking: number;
|
|
5833
|
+
major: number;
|
|
5834
|
+
minor: number;
|
|
5835
|
+
info: number;
|
|
5836
|
+
resolved: number;
|
|
5837
|
+
overridden: number;
|
|
5838
|
+
};
|
|
5839
|
+
findings: Array<{
|
|
5840
|
+
id: string;
|
|
5841
|
+
check: "citation" | "numeric" | "figure" | "provenance";
|
|
5842
|
+
severity: "blocking" | "major" | "minor" | "info";
|
|
5843
|
+
status: "open" | "resolved" | "overridden";
|
|
5844
|
+
title: string;
|
|
5845
|
+
detail: string;
|
|
5846
|
+
evidence: Array<string>;
|
|
5847
|
+
location: {
|
|
5848
|
+
path: string;
|
|
5849
|
+
line?: number;
|
|
5850
|
+
};
|
|
5851
|
+
resolution?: {
|
|
5852
|
+
kind: "resolved" | "overridden";
|
|
5853
|
+
actor: string;
|
|
5854
|
+
reason: string;
|
|
5855
|
+
at: number;
|
|
5856
|
+
};
|
|
5857
|
+
}>;
|
|
5858
|
+
events: Array<{
|
|
5859
|
+
version: number;
|
|
5860
|
+
type: "generated" | "resolved" | "overridden" | "finalized";
|
|
5861
|
+
actor: string;
|
|
5862
|
+
at: number;
|
|
5863
|
+
findingID?: string;
|
|
5864
|
+
reason?: string;
|
|
5865
|
+
}>;
|
|
5866
|
+
finalized?: {
|
|
5867
|
+
actor: string;
|
|
5868
|
+
at: number;
|
|
5869
|
+
artifactHash: string;
|
|
5870
|
+
};
|
|
5871
|
+
createdAt: number;
|
|
5872
|
+
updatedAt: number;
|
|
5873
|
+
};
|
|
5874
|
+
};
|
|
5875
|
+
export type FileReviewsResolveResponse = FileReviewsResolveResponses[keyof FileReviewsResolveResponses];
|
|
5876
|
+
export type FileReviewsFinalizeData = {
|
|
5877
|
+
body?: {
|
|
5878
|
+
actor: string;
|
|
5879
|
+
};
|
|
5880
|
+
path: {
|
|
5881
|
+
id: string;
|
|
5882
|
+
};
|
|
5883
|
+
query?: {
|
|
5884
|
+
directory?: string;
|
|
5885
|
+
};
|
|
5886
|
+
url: "/file/reviews/{id}/finalize";
|
|
5887
|
+
};
|
|
5888
|
+
export type FileReviewsFinalizeErrors = {
|
|
5889
|
+
/**
|
|
5890
|
+
* Review is blocked, stale, or already invalid
|
|
5891
|
+
*/
|
|
5892
|
+
409: unknown;
|
|
5893
|
+
};
|
|
5894
|
+
export type FileReviewsFinalizeResponses = {
|
|
5895
|
+
/**
|
|
5896
|
+
* Finalized publication review
|
|
5897
|
+
*/
|
|
5898
|
+
200: {
|
|
5899
|
+
format: "openscience.publication-review.v1";
|
|
5900
|
+
id: string;
|
|
5901
|
+
projectID: string;
|
|
5902
|
+
path: string;
|
|
5903
|
+
artifactHash: string;
|
|
5904
|
+
version: number;
|
|
5905
|
+
status: "blocked" | "warnings" | "ready";
|
|
5906
|
+
summary: {
|
|
5907
|
+
total: number;
|
|
5908
|
+
open: number;
|
|
5909
|
+
blocking: number;
|
|
5910
|
+
major: number;
|
|
5911
|
+
minor: number;
|
|
5912
|
+
info: number;
|
|
5913
|
+
resolved: number;
|
|
5914
|
+
overridden: number;
|
|
5915
|
+
};
|
|
5916
|
+
findings: Array<{
|
|
5917
|
+
id: string;
|
|
5918
|
+
check: "citation" | "numeric" | "figure" | "provenance";
|
|
5919
|
+
severity: "blocking" | "major" | "minor" | "info";
|
|
5920
|
+
status: "open" | "resolved" | "overridden";
|
|
5921
|
+
title: string;
|
|
5922
|
+
detail: string;
|
|
5923
|
+
evidence: Array<string>;
|
|
5924
|
+
location: {
|
|
5925
|
+
path: string;
|
|
5926
|
+
line?: number;
|
|
5927
|
+
};
|
|
5928
|
+
resolution?: {
|
|
5929
|
+
kind: "resolved" | "overridden";
|
|
5930
|
+
actor: string;
|
|
5931
|
+
reason: string;
|
|
5932
|
+
at: number;
|
|
5933
|
+
};
|
|
5934
|
+
}>;
|
|
5935
|
+
events: Array<{
|
|
5936
|
+
version: number;
|
|
5937
|
+
type: "generated" | "resolved" | "overridden" | "finalized";
|
|
5938
|
+
actor: string;
|
|
5939
|
+
at: number;
|
|
5940
|
+
findingID?: string;
|
|
5941
|
+
reason?: string;
|
|
5942
|
+
}>;
|
|
5943
|
+
finalized?: {
|
|
5944
|
+
actor: string;
|
|
5945
|
+
at: number;
|
|
5946
|
+
artifactHash: string;
|
|
5947
|
+
};
|
|
5948
|
+
createdAt: number;
|
|
5949
|
+
updatedAt: number;
|
|
5950
|
+
};
|
|
5951
|
+
};
|
|
5952
|
+
export type FileReviewsFinalizeResponse = FileReviewsFinalizeResponses[keyof FileReviewsFinalizeResponses];
|
|
5255
5953
|
export type FileStatusData = {
|
|
5256
5954
|
body?: never;
|
|
5257
5955
|
path?: never;
|