@synsci/sdk 1.3.6-test.22.1 → 1.3.6-test.25.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 +70 -3
- package/dist/v2/gen/sdk.gen.js +152 -2
- package/dist/v2/gen/types.gen.d.ts +497 -1
- 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, FileAnnotationsCreateResponses, FileAnnotationsDeleteResponses, FileAnnotationsListResponses, FileAnnotationsUpdateResponses, 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
|
|
@@ -1146,9 +1146,18 @@ export declare class Annotations extends HeyApiClient {
|
|
|
1146
1146
|
};
|
|
1147
1147
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsCreateResponses, unknown, ThrowOnError, "fields">;
|
|
1148
1148
|
/**
|
|
1149
|
-
*
|
|
1149
|
+
* Read artifact annotation history
|
|
1150
1150
|
*
|
|
1151
|
-
*
|
|
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.
|
|
1152
1161
|
*/
|
|
1153
1162
|
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1154
1163
|
id: string;
|
|
@@ -1163,10 +1172,64 @@ export declare class Annotations extends HeyApiClient {
|
|
|
1163
1172
|
id: string;
|
|
1164
1173
|
directory?: string;
|
|
1165
1174
|
status?: "open" | "resolved";
|
|
1175
|
+
body?: string;
|
|
1166
1176
|
reply?: string;
|
|
1167
1177
|
author?: string;
|
|
1168
1178
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileAnnotationsUpdateResponses, unknown, ThrowOnError, "fields">;
|
|
1169
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
|
+
}
|
|
1170
1233
|
export declare class File extends HeyApiClient {
|
|
1171
1234
|
/**
|
|
1172
1235
|
* List files
|
|
@@ -1273,6 +1336,8 @@ export declare class File extends HeyApiClient {
|
|
|
1273
1336
|
directory?: string;
|
|
1274
1337
|
path?: string;
|
|
1275
1338
|
format?: "html" | "pdf" | "docx" | "latex" | "pptx";
|
|
1339
|
+
readiness?: "draft" | "reviewed";
|
|
1340
|
+
review_id?: string;
|
|
1276
1341
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FilePublicationResponses, unknown, ThrowOnError, "fields">;
|
|
1277
1342
|
/**
|
|
1278
1343
|
* Get file status
|
|
@@ -1284,6 +1349,8 @@ export declare class File extends HeyApiClient {
|
|
|
1284
1349
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileStatusResponses, unknown, ThrowOnError, "fields">;
|
|
1285
1350
|
private _annotations?;
|
|
1286
1351
|
get annotations(): Annotations;
|
|
1352
|
+
private _reviews?;
|
|
1353
|
+
get reviews(): Reviews;
|
|
1287
1354
|
}
|
|
1288
1355
|
export declare class Notebook extends HeyApiClient {
|
|
1289
1356
|
/**
|
package/dist/v2/gen/sdk.gen.js
CHANGED
|
@@ -2211,9 +2211,29 @@ export class Annotations extends HeyApiClient {
|
|
|
2211
2211
|
});
|
|
2212
2212
|
}
|
|
2213
2213
|
/**
|
|
2214
|
-
*
|
|
2214
|
+
* Read artifact annotation history
|
|
2215
2215
|
*
|
|
2216
|
-
*
|
|
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.
|
|
2217
2237
|
*/
|
|
2218
2238
|
delete(parameters, options) {
|
|
2219
2239
|
const params = buildClientParams([parameters], [
|
|
@@ -2242,6 +2262,7 @@ export class Annotations extends HeyApiClient {
|
|
|
2242
2262
|
{ in: "path", key: "id" },
|
|
2243
2263
|
{ in: "query", key: "directory" },
|
|
2244
2264
|
{ in: "body", key: "status" },
|
|
2265
|
+
{ in: "body", key: "body" },
|
|
2245
2266
|
{ in: "body", key: "reply" },
|
|
2246
2267
|
{ in: "body", key: "author" },
|
|
2247
2268
|
],
|
|
@@ -2259,6 +2280,129 @@ export class Annotations extends HeyApiClient {
|
|
|
2259
2280
|
});
|
|
2260
2281
|
}
|
|
2261
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
|
+
}
|
|
2262
2406
|
export class File extends HeyApiClient {
|
|
2263
2407
|
/**
|
|
2264
2408
|
* List files
|
|
@@ -2475,6 +2619,8 @@ export class File extends HeyApiClient {
|
|
|
2475
2619
|
{ in: "query", key: "directory" },
|
|
2476
2620
|
{ in: "body", key: "path" },
|
|
2477
2621
|
{ in: "body", key: "format" },
|
|
2622
|
+
{ in: "body", key: "readiness" },
|
|
2623
|
+
{ in: "body", key: "review_id" },
|
|
2478
2624
|
],
|
|
2479
2625
|
},
|
|
2480
2626
|
]);
|
|
@@ -2506,6 +2652,10 @@ export class File extends HeyApiClient {
|
|
|
2506
2652
|
get annotations() {
|
|
2507
2653
|
return (this._annotations ??= new Annotations({ client: this.client }));
|
|
2508
2654
|
}
|
|
2655
|
+
_reviews;
|
|
2656
|
+
get reviews() {
|
|
2657
|
+
return (this._reviews ??= new Reviews({ client: this.client }));
|
|
2658
|
+
}
|
|
2509
2659
|
}
|
|
2510
2660
|
export class Notebook extends HeyApiClient {
|
|
2511
2661
|
/**
|
|
@@ -5173,6 +5173,7 @@ export type FileAnnotationsListResponses = {
|
|
|
5173
5173
|
id: string;
|
|
5174
5174
|
projectID: string;
|
|
5175
5175
|
path: string;
|
|
5176
|
+
artifactHash: string;
|
|
5176
5177
|
anchor: {
|
|
5177
5178
|
kind: "artifact";
|
|
5178
5179
|
label?: string;
|
|
@@ -5202,8 +5203,24 @@ export type FileAnnotationsListResponses = {
|
|
|
5202
5203
|
createdAt: number;
|
|
5203
5204
|
}>;
|
|
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
|
+
}>;
|
|
5205
5221
|
createdAt: number;
|
|
5206
5222
|
updatedAt: number;
|
|
5223
|
+
deletedAt?: number;
|
|
5207
5224
|
}>;
|
|
5208
5225
|
};
|
|
5209
5226
|
export type FileAnnotationsListResponse = FileAnnotationsListResponses[keyof FileAnnotationsListResponses];
|
|
@@ -5249,6 +5266,7 @@ export type FileAnnotationsCreateResponses = {
|
|
|
5249
5266
|
id: string;
|
|
5250
5267
|
projectID: string;
|
|
5251
5268
|
path: string;
|
|
5269
|
+
artifactHash: string;
|
|
5252
5270
|
anchor: {
|
|
5253
5271
|
kind: "artifact";
|
|
5254
5272
|
label?: string;
|
|
@@ -5278,11 +5296,96 @@ export type FileAnnotationsCreateResponses = {
|
|
|
5278
5296
|
createdAt: number;
|
|
5279
5297
|
}>;
|
|
5280
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
|
+
}>;
|
|
5281
5314
|
createdAt: number;
|
|
5282
5315
|
updatedAt: number;
|
|
5316
|
+
deletedAt?: number;
|
|
5283
5317
|
};
|
|
5284
5318
|
};
|
|
5285
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];
|
|
5286
5389
|
export type FileAnnotationsDeleteData = {
|
|
5287
5390
|
body?: never;
|
|
5288
5391
|
path: {
|
|
@@ -5295,16 +5398,18 @@ export type FileAnnotationsDeleteData = {
|
|
|
5295
5398
|
};
|
|
5296
5399
|
export type FileAnnotationsDeleteResponses = {
|
|
5297
5400
|
/**
|
|
5298
|
-
*
|
|
5401
|
+
* Tombstoned annotation
|
|
5299
5402
|
*/
|
|
5300
5403
|
200: {
|
|
5301
5404
|
deleted: true;
|
|
5405
|
+
version: number;
|
|
5302
5406
|
};
|
|
5303
5407
|
};
|
|
5304
5408
|
export type FileAnnotationsDeleteResponse = FileAnnotationsDeleteResponses[keyof FileAnnotationsDeleteResponses];
|
|
5305
5409
|
export type FileAnnotationsUpdateData = {
|
|
5306
5410
|
body?: {
|
|
5307
5411
|
status?: "open" | "resolved";
|
|
5412
|
+
body?: string;
|
|
5308
5413
|
reply?: string;
|
|
5309
5414
|
author?: string;
|
|
5310
5415
|
};
|
|
@@ -5324,6 +5429,7 @@ export type FileAnnotationsUpdateResponses = {
|
|
|
5324
5429
|
id: string;
|
|
5325
5430
|
projectID: string;
|
|
5326
5431
|
path: string;
|
|
5432
|
+
artifactHash: string;
|
|
5327
5433
|
anchor: {
|
|
5328
5434
|
kind: "artifact";
|
|
5329
5435
|
label?: string;
|
|
@@ -5353,8 +5459,24 @@ export type FileAnnotationsUpdateResponses = {
|
|
|
5353
5459
|
createdAt: number;
|
|
5354
5460
|
}>;
|
|
5355
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
|
+
}>;
|
|
5356
5477
|
createdAt: number;
|
|
5357
5478
|
updatedAt: number;
|
|
5479
|
+
deletedAt?: number;
|
|
5358
5480
|
};
|
|
5359
5481
|
};
|
|
5360
5482
|
export type FileAnnotationsUpdateResponse = FileAnnotationsUpdateResponses[keyof FileAnnotationsUpdateResponses];
|
|
@@ -5434,6 +5556,8 @@ export type FilePublicationData = {
|
|
|
5434
5556
|
body?: {
|
|
5435
5557
|
path: string;
|
|
5436
5558
|
format: "html" | "pdf" | "docx" | "latex" | "pptx";
|
|
5559
|
+
readiness?: "draft" | "reviewed";
|
|
5560
|
+
review_id?: string;
|
|
5437
5561
|
};
|
|
5438
5562
|
path?: never;
|
|
5439
5563
|
query?: {
|
|
@@ -5451,9 +5575,381 @@ export type FilePublicationResponses = {
|
|
|
5451
5575
|
size: number;
|
|
5452
5576
|
created_at: string;
|
|
5453
5577
|
engine: string;
|
|
5578
|
+
readiness: "draft" | "reviewed";
|
|
5579
|
+
review_id?: string;
|
|
5454
5580
|
};
|
|
5455
5581
|
};
|
|
5456
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];
|
|
5457
5953
|
export type FileStatusData = {
|
|
5458
5954
|
body?: never;
|
|
5459
5955
|
path?: never;
|