@scaleway/sdk 2.45.0 → 2.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/account/index.gen.d.ts +6 -0
- package/dist/api/applesilicon/index.gen.d.ts +5 -0
- package/dist/api/baremetal/index.gen.d.ts +5 -0
- package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
- package/dist/api/baremetal/v1/marshalling.gen.cjs +61 -1
- package/dist/api/baremetal/v1/marshalling.gen.js +61 -1
- package/dist/api/baremetal/v1/types.gen.d.ts +120 -1
- package/dist/api/billing/index.gen.d.ts +6 -0
- package/dist/api/block/index.gen.d.ts +5 -0
- package/dist/api/cockpit/index.gen.d.ts +6 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +1 -1
- package/dist/api/container/index.gen.d.ts +5 -0
- package/dist/api/container/v1beta1/api.gen.cjs +0 -23
- package/dist/api/container/v1beta1/api.gen.d.ts +1 -9
- package/dist/api/container/v1beta1/api.gen.js +1 -24
- package/dist/api/container/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/container/v1beta1/types.gen.d.ts +0 -12
- package/dist/api/dedibox/index.gen.d.ts +5 -0
- package/dist/api/document_db/index.gen.d.ts +5 -0
- package/dist/api/domain/index.gen.d.ts +5 -0
- package/dist/api/edge_services/index.gen.d.ts +5 -0
- package/dist/api/flexibleip/index.gen.d.ts +5 -0
- package/dist/api/function/index.gen.d.ts +5 -0
- package/dist/api/function/v1beta1/api.gen.cjs +0 -23
- package/dist/api/function/v1beta1/api.gen.d.ts +1 -9
- package/dist/api/function/v1beta1/api.gen.js +1 -24
- package/dist/api/function/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/function/v1beta1/types.gen.d.ts +0 -12
- package/dist/api/iam/index.gen.d.ts +5 -0
- package/dist/api/iam/v1alpha1/api.gen.cjs +1 -1
- package/dist/api/iam/v1alpha1/api.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/api.gen.js +1 -1
- package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +16 -3
- package/dist/api/iam/v1alpha1/marshalling.gen.js +16 -3
- package/dist/api/iam/v1alpha1/types.gen.d.ts +25 -3
- package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +12 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +11 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.js +12 -0
- package/dist/api/index.gen.d.ts +43 -0
- package/dist/api/inference/index.gen.d.ts +5 -0
- package/dist/api/instance/index.gen.d.ts +5 -0
- package/dist/api/instance/v1/marshalling.gen.cjs +1 -0
- package/dist/api/instance/v1/marshalling.gen.js +1 -0
- package/dist/api/instance/v1/types.gen.d.ts +22 -8
- package/dist/api/instance/v1/types.private.gen.d.ts +2 -2
- package/dist/api/iot/index.gen.d.ts +5 -0
- package/dist/api/ipam/index.gen.d.ts +5 -0
- package/dist/api/ipam/v1/api.gen.cjs +67 -2
- package/dist/api/ipam/v1/api.gen.d.ts +38 -3
- package/dist/api/ipam/v1/api.gen.js +68 -3
- package/dist/api/ipam/v1/index.gen.d.ts +1 -1
- package/dist/api/ipam/v1/marshalling.gen.cjs +18 -0
- package/dist/api/ipam/v1/marshalling.gen.d.ts +4 -1
- package/dist/api/ipam/v1/marshalling.gen.js +18 -0
- package/dist/api/ipam/v1/types.gen.d.ts +59 -5
- package/dist/api/ipfs/index.gen.d.ts +5 -0
- package/dist/api/jobs/index.gen.d.ts +5 -0
- package/dist/api/k8s/index.gen.d.ts +5 -0
- package/dist/api/k8s/v1/api.gen.cjs +17 -0
- package/dist/api/k8s/v1/api.gen.d.ts +10 -1
- package/dist/api/k8s/v1/api.gen.js +17 -0
- package/dist/api/k8s/v1/index.gen.d.ts +1 -1
- package/dist/api/k8s/v1/types.gen.d.ts +13 -0
- package/dist/api/key_manager/index.gen.d.ts +5 -0
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +31 -0
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +17 -1
- package/dist/api/key_manager/v1alpha1/api.gen.js +32 -1
- package/dist/api/key_manager/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/key_manager/v1alpha1/marshalling.gen.cjs +7 -0
- package/dist/api/key_manager/v1alpha1/marshalling.gen.d.ts +2 -1
- package/dist/api/key_manager/v1alpha1/marshalling.gen.js +7 -0
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +33 -0
- package/dist/api/lb/index.gen.d.ts +5 -0
- package/dist/api/llm_inference/index.gen.d.ts +5 -0
- package/dist/api/marketplace/index.gen.d.ts +5 -0
- package/dist/api/mnq/index.gen.d.ts +5 -0
- package/dist/api/qaas/index.gen.d.ts +5 -0
- package/dist/api/qaas/v1alpha1/api.gen.d.ts +256 -0
- package/dist/api/qaas/v1alpha1/content.gen.d.ts +7 -0
- package/dist/api/qaas/v1alpha1/index.gen.d.ts +4 -0
- package/dist/api/qaas/v1alpha1/marshalling.gen.d.ts +22 -0
- package/dist/api/qaas/v1alpha1/types.gen.d.ts +470 -0
- package/dist/api/qaas/v1alpha1/validation-rules.gen.d.ts +10 -0
- package/dist/api/rdb/index.gen.d.ts +5 -0
- package/dist/api/redis/index.gen.d.ts +5 -0
- package/dist/api/registry/index.gen.d.ts +5 -0
- package/dist/api/secret/index.gen.d.ts +6 -0
- package/dist/api/serverless_sqldb/index.gen.d.ts +5 -0
- package/dist/api/tem/index.gen.d.ts +5 -0
- package/dist/api/tem/v1alpha1/content.gen.cjs +4 -1
- package/dist/api/tem/v1alpha1/content.gen.js +4 -1
- package/dist/api/tem/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/test/index.gen.d.ts +5 -0
- package/dist/api/vpc/index.gen.d.ts +6 -0
- package/dist/api/vpc/v2/marshalling.gen.cjs +1 -0
- package/dist/api/vpc/v2/marshalling.gen.js +1 -0
- package/dist/api/vpc/v2/types.gen.d.ts +3 -0
- package/dist/api/vpcgw/index.gen.d.ts +5 -0
- package/dist/api/webhosting/index.gen.d.ts +6 -0
- package/dist/api/webhosting/v1/api.gen.d.ts +326 -0
- package/dist/api/webhosting/v1/content.gen.d.ts +5 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +4 -0
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +29 -0
- package/dist/api/webhosting/v1/types.gen.d.ts +693 -0
- package/dist/api/webhosting/v1/validation-rules.gen.d.ts +72 -0
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -36,6 +36,7 @@ const unmarshalKey = (data) => {
|
|
|
36
36
|
id: data.id,
|
|
37
37
|
locked: data.locked,
|
|
38
38
|
name: data.name,
|
|
39
|
+
origin: data.origin,
|
|
39
40
|
projectId: data.project_id,
|
|
40
41
|
protected: data.protected,
|
|
41
42
|
region: data.region,
|
|
@@ -108,6 +109,7 @@ const marshalKeyUsage = (request, defaults) => ({
|
|
|
108
109
|
const marshalCreateKeyRequest = (request, defaults) => ({
|
|
109
110
|
description: request.description,
|
|
110
111
|
name: request.name,
|
|
112
|
+
origin: request.origin,
|
|
111
113
|
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
112
114
|
rotation_policy: request.rotationPolicy !== void 0 ? marshalKeyRotationPolicy(request.rotationPolicy) : void 0,
|
|
113
115
|
tags: request.tags,
|
|
@@ -126,6 +128,10 @@ const marshalGenerateDataKeyRequest = (request, defaults) => ({
|
|
|
126
128
|
algorithm: request.algorithm,
|
|
127
129
|
without_plaintext: request.withoutPlaintext
|
|
128
130
|
});
|
|
131
|
+
const marshalImportKeyMaterialRequest = (request, defaults) => ({
|
|
132
|
+
key_material: request.keyMaterial,
|
|
133
|
+
salt: request.salt
|
|
134
|
+
});
|
|
129
135
|
const marshalUpdateKeyRequest = (request, defaults) => ({
|
|
130
136
|
description: request.description,
|
|
131
137
|
name: request.name,
|
|
@@ -136,6 +142,7 @@ exports.marshalCreateKeyRequest = marshalCreateKeyRequest;
|
|
|
136
142
|
exports.marshalDecryptRequest = marshalDecryptRequest;
|
|
137
143
|
exports.marshalEncryptRequest = marshalEncryptRequest;
|
|
138
144
|
exports.marshalGenerateDataKeyRequest = marshalGenerateDataKeyRequest;
|
|
145
|
+
exports.marshalImportKeyMaterialRequest = marshalImportKeyMaterialRequest;
|
|
139
146
|
exports.marshalUpdateKeyRequest = marshalUpdateKeyRequest;
|
|
140
147
|
exports.unmarshalDataKey = unmarshalDataKey;
|
|
141
148
|
exports.unmarshalDecryptResponse = unmarshalDecryptResponse;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '../../../bridge';
|
|
2
|
-
import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, Key, ListKeysResponse, UpdateKeyRequest } from './types.gen';
|
|
2
|
+
import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, ImportKeyMaterialRequest, Key, ListKeysResponse, UpdateKeyRequest } from './types.gen';
|
|
3
3
|
export declare const unmarshalKey: (data: unknown) => Key;
|
|
4
4
|
export declare const unmarshalDataKey: (data: unknown) => DataKey;
|
|
5
5
|
export declare const unmarshalDecryptResponse: (data: unknown) => DecryptResponse;
|
|
@@ -9,4 +9,5 @@ export declare const marshalCreateKeyRequest: (request: CreateKeyRequest, defaul
|
|
|
9
9
|
export declare const marshalDecryptRequest: (request: DecryptRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
10
10
|
export declare const marshalEncryptRequest: (request: EncryptRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
11
11
|
export declare const marshalGenerateDataKeyRequest: (request: GenerateDataKeyRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
12
|
+
export declare const marshalImportKeyMaterialRequest: (request: ImportKeyMaterialRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
12
13
|
export declare const marshalUpdateKeyRequest: (request: UpdateKeyRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
@@ -34,6 +34,7 @@ const unmarshalKey = (data) => {
|
|
|
34
34
|
id: data.id,
|
|
35
35
|
locked: data.locked,
|
|
36
36
|
name: data.name,
|
|
37
|
+
origin: data.origin,
|
|
37
38
|
projectId: data.project_id,
|
|
38
39
|
protected: data.protected,
|
|
39
40
|
region: data.region,
|
|
@@ -106,6 +107,7 @@ const marshalKeyUsage = (request, defaults) => ({
|
|
|
106
107
|
const marshalCreateKeyRequest = (request, defaults) => ({
|
|
107
108
|
description: request.description,
|
|
108
109
|
name: request.name,
|
|
110
|
+
origin: request.origin,
|
|
109
111
|
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
110
112
|
rotation_policy: request.rotationPolicy !== void 0 ? marshalKeyRotationPolicy(request.rotationPolicy) : void 0,
|
|
111
113
|
tags: request.tags,
|
|
@@ -124,6 +126,10 @@ const marshalGenerateDataKeyRequest = (request, defaults) => ({
|
|
|
124
126
|
algorithm: request.algorithm,
|
|
125
127
|
without_plaintext: request.withoutPlaintext
|
|
126
128
|
});
|
|
129
|
+
const marshalImportKeyMaterialRequest = (request, defaults) => ({
|
|
130
|
+
key_material: request.keyMaterial,
|
|
131
|
+
salt: request.salt
|
|
132
|
+
});
|
|
127
133
|
const marshalUpdateKeyRequest = (request, defaults) => ({
|
|
128
134
|
description: request.description,
|
|
129
135
|
name: request.name,
|
|
@@ -135,6 +141,7 @@ export {
|
|
|
135
141
|
marshalDecryptRequest,
|
|
136
142
|
marshalEncryptRequest,
|
|
137
143
|
marshalGenerateDataKeyRequest,
|
|
144
|
+
marshalImportKeyMaterialRequest,
|
|
138
145
|
marshalUpdateKeyRequest,
|
|
139
146
|
unmarshalDataKey,
|
|
140
147
|
unmarshalDecryptResponse,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Region } from '../../../bridge';
|
|
2
2
|
export type DataKeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
|
|
3
3
|
export type KeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
|
|
4
|
+
export type KeyOrigin = 'unknown_origin' | 'scaleway_kms' | 'external';
|
|
4
5
|
export type KeyState = 'unknown_state' | 'enabled' | 'disabled' | 'pending_key_material';
|
|
5
6
|
export type ListKeysRequestOrderBy = 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
|
|
6
7
|
export interface KeyRotationPolicy {
|
|
@@ -54,6 +55,8 @@ export interface Key {
|
|
|
54
55
|
rotatedAt?: Date;
|
|
55
56
|
/** Key rotation policy. */
|
|
56
57
|
rotationPolicy?: KeyRotationPolicy;
|
|
58
|
+
/** Refer to the `Key.Origin` enum for a description of values. */
|
|
59
|
+
origin: KeyOrigin;
|
|
57
60
|
/** Region of the key. */
|
|
58
61
|
region: Region;
|
|
59
62
|
}
|
|
@@ -80,6 +83,8 @@ export type CreateKeyRequest = {
|
|
|
80
83
|
rotationPolicy?: KeyRotationPolicy;
|
|
81
84
|
/** Default value is `false`. */
|
|
82
85
|
unprotected: boolean;
|
|
86
|
+
/** Refer to the `Key.Origin` enum for a description of values. */
|
|
87
|
+
origin?: KeyOrigin;
|
|
83
88
|
};
|
|
84
89
|
export interface DataKey {
|
|
85
90
|
/** ID of the data encryption key. */
|
|
@@ -124,6 +129,15 @@ export interface DecryptResponse {
|
|
|
124
129
|
*/
|
|
125
130
|
ciphertext?: string;
|
|
126
131
|
}
|
|
132
|
+
export type DeleteKeyMaterialRequest = {
|
|
133
|
+
/**
|
|
134
|
+
* Region to target. If none is passed will use default region from the
|
|
135
|
+
* config.
|
|
136
|
+
*/
|
|
137
|
+
region?: Region;
|
|
138
|
+
/** ID of the key of which to delete the key material. */
|
|
139
|
+
keyId: string;
|
|
140
|
+
};
|
|
127
141
|
export type DeleteKeyRequest = {
|
|
128
142
|
/**
|
|
129
143
|
* Region to target. If none is passed will use default region from the
|
|
@@ -202,6 +216,25 @@ export type GetKeyRequest = {
|
|
|
202
216
|
/** ID of the key to target. */
|
|
203
217
|
keyId: string;
|
|
204
218
|
};
|
|
219
|
+
export type ImportKeyMaterialRequest = {
|
|
220
|
+
/**
|
|
221
|
+
* Region to target. If none is passed will use default region from the
|
|
222
|
+
* config.
|
|
223
|
+
*/
|
|
224
|
+
region?: Region;
|
|
225
|
+
/** The key's origin must be 'external'. */
|
|
226
|
+
keyId: string;
|
|
227
|
+
/**
|
|
228
|
+
* The key material The key material is a random sequence of bytes used to
|
|
229
|
+
* derive a cryptographic key.
|
|
230
|
+
*/
|
|
231
|
+
keyMaterial: string;
|
|
232
|
+
/**
|
|
233
|
+
* A salt can be used to improve the quality of randomness when the key
|
|
234
|
+
* material is generated from a low entropy source.
|
|
235
|
+
*/
|
|
236
|
+
salt?: string;
|
|
237
|
+
};
|
|
205
238
|
export type ListKeysRequest = {
|
|
206
239
|
/**
|
|
207
240
|
* Region to target. If none is passed will use default region from the
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
import { API as ParentAPI } from '../../../bridge';
|
|
2
|
+
import type { WaitForOptions } from '../../../bridge';
|
|
3
|
+
import type { Application, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateProcessRequest, CreateSessionRequest, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetJobCircuitRequest, GetJobRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, ListApplicationsRequest, ListApplicationsResponse, ListJobResultsRequest, ListJobResultsResponse, ListJobsRequest, ListJobsResponse, ListPlatformsRequest, ListPlatformsResponse, ListProcessResultsRequest, ListProcessResultsResponse, ListProcessesRequest, ListProcessesResponse, ListSessionACLsRequest, ListSessionACLsResponse, ListSessionsRequest, ListSessionsResponse, Platform, Process, Session, TerminateSessionRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen';
|
|
4
|
+
/**
|
|
5
|
+
* Quantum as a Service API.
|
|
6
|
+
*
|
|
7
|
+
* This API allows you to manage Scaleway Quantum as a Service.
|
|
8
|
+
*/
|
|
9
|
+
export declare class API extends ParentAPI {
|
|
10
|
+
/**
|
|
11
|
+
* Get job information. Retrieve information about the provided **job ID**,
|
|
12
|
+
* such as status, payload, and result.
|
|
13
|
+
*
|
|
14
|
+
* @param request - The request {@link GetJobRequest}
|
|
15
|
+
* @returns A Promise of Job
|
|
16
|
+
*/
|
|
17
|
+
getJob: (request: Readonly<GetJobRequest>) => Promise<Job>;
|
|
18
|
+
/**
|
|
19
|
+
* Waits for {@link Job} to be in a final state.
|
|
20
|
+
*
|
|
21
|
+
* @param request - The request {@link GetJobRequest}
|
|
22
|
+
* @param options - The waiting options
|
|
23
|
+
* @returns A Promise of Job
|
|
24
|
+
*/
|
|
25
|
+
waitForJob: (request: Readonly<GetJobRequest>, options?: Readonly<WaitForOptions<Job>>) => Promise<Job>;
|
|
26
|
+
protected pageOfListJobs: (request?: Readonly<ListJobsRequest>) => Promise<ListJobsResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* List all jobs within a project or session. Retrieve information about all
|
|
29
|
+
* jobs within a given project or session.
|
|
30
|
+
*
|
|
31
|
+
* @param request - The request {@link ListJobsRequest}
|
|
32
|
+
* @returns A Promise of ListJobsResponse
|
|
33
|
+
*/
|
|
34
|
+
listJobs: (request?: Readonly<ListJobsRequest>) => Promise<ListJobsResponse> & {
|
|
35
|
+
all: () => Promise<Job[]>;
|
|
36
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Job[], void, void>;
|
|
37
|
+
};
|
|
38
|
+
protected pageOfListJobResults: (request: Readonly<ListJobResultsRequest>) => Promise<ListJobResultsResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* List all results of a job. Retrieve all intermediate and final results of a
|
|
41
|
+
* job.
|
|
42
|
+
*
|
|
43
|
+
* @param request - The request {@link ListJobResultsRequest}
|
|
44
|
+
* @returns A Promise of ListJobResultsResponse
|
|
45
|
+
*/
|
|
46
|
+
listJobResults: (request: Readonly<ListJobResultsRequest>) => Promise<ListJobResultsResponse> & {
|
|
47
|
+
all: () => Promise<import("./types.gen").JobResult[]>;
|
|
48
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").JobResult[], void, void>;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Create a job. Create a job to be executed inside a session.
|
|
52
|
+
*
|
|
53
|
+
* @param request - The request {@link CreateJobRequest}
|
|
54
|
+
* @returns A Promise of Job
|
|
55
|
+
*/
|
|
56
|
+
createJob: (request: Readonly<CreateJobRequest>) => Promise<Job>;
|
|
57
|
+
/**
|
|
58
|
+
* Update job information. Update job information about the provided **job
|
|
59
|
+
* ID**.
|
|
60
|
+
*
|
|
61
|
+
* @param request - The request {@link UpdateJobRequest}
|
|
62
|
+
* @returns A Promise of Job
|
|
63
|
+
*/
|
|
64
|
+
updateJob: (request: Readonly<UpdateJobRequest>) => Promise<Job>;
|
|
65
|
+
/**
|
|
66
|
+
* Cancel a job. Cancel the job corresponding to the provided **job ID**.
|
|
67
|
+
*
|
|
68
|
+
* @param request - The request {@link CancelJobRequest}
|
|
69
|
+
* @returns A Promise of Job
|
|
70
|
+
*/
|
|
71
|
+
cancelJob: (request: Readonly<CancelJobRequest>) => Promise<Job>;
|
|
72
|
+
/**
|
|
73
|
+
* Delete a job. Delete the job corresponding to the provided **job ID**.
|
|
74
|
+
*
|
|
75
|
+
* @param request - The request {@link DeleteJobRequest}
|
|
76
|
+
*/
|
|
77
|
+
deleteJob: (request: Readonly<DeleteJobRequest>) => Promise<void>;
|
|
78
|
+
/**
|
|
79
|
+
* Get a job circuit. Retrieve the circuit of the provided **job ID**.
|
|
80
|
+
*
|
|
81
|
+
* @param request - The request {@link GetJobCircuitRequest}
|
|
82
|
+
* @returns A Promise of JobCircuit
|
|
83
|
+
*/
|
|
84
|
+
getJobCircuit: (request: Readonly<GetJobCircuitRequest>) => Promise<JobCircuit>;
|
|
85
|
+
/**
|
|
86
|
+
* Get platform information. Retrieve information about the provided
|
|
87
|
+
* **platform ID**, such as provider name, technology, and type.
|
|
88
|
+
*
|
|
89
|
+
* @param request - The request {@link GetPlatformRequest}
|
|
90
|
+
* @returns A Promise of Platform
|
|
91
|
+
*/
|
|
92
|
+
getPlatform: (request: Readonly<GetPlatformRequest>) => Promise<Platform>;
|
|
93
|
+
protected pageOfListPlatforms: (request?: Readonly<ListPlatformsRequest>) => Promise<ListPlatformsResponse>;
|
|
94
|
+
/**
|
|
95
|
+
* List all available platforms. Retrieve information about all platforms.
|
|
96
|
+
*
|
|
97
|
+
* @param request - The request {@link ListPlatformsRequest}
|
|
98
|
+
* @returns A Promise of ListPlatformsResponse
|
|
99
|
+
*/
|
|
100
|
+
listPlatforms: (request?: Readonly<ListPlatformsRequest>) => Promise<ListPlatformsResponse> & {
|
|
101
|
+
all: () => Promise<Platform[]>;
|
|
102
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Platform[], void, void>;
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
* Get session infrormation. Retrieve information about the provided **session
|
|
106
|
+
* ID**, such as name, status, and number of executed jobs.
|
|
107
|
+
*
|
|
108
|
+
* @param request - The request {@link GetSessionRequest}
|
|
109
|
+
* @returns A Promise of Session
|
|
110
|
+
*/
|
|
111
|
+
getSession: (request: Readonly<GetSessionRequest>) => Promise<Session>;
|
|
112
|
+
/**
|
|
113
|
+
* Waits for {@link Session} to be in a final state.
|
|
114
|
+
*
|
|
115
|
+
* @param request - The request {@link GetSessionRequest}
|
|
116
|
+
* @param options - The waiting options
|
|
117
|
+
* @returns A Promise of Session
|
|
118
|
+
*/
|
|
119
|
+
waitForSession: (request: Readonly<GetSessionRequest>, options?: Readonly<WaitForOptions<Session>>) => Promise<Session>;
|
|
120
|
+
protected pageOfListSessions: (request?: Readonly<ListSessionsRequest>) => Promise<ListSessionsResponse>;
|
|
121
|
+
/**
|
|
122
|
+
* List all sessions. Retrieve information about all sessions.
|
|
123
|
+
*
|
|
124
|
+
* @param request - The request {@link ListSessionsRequest}
|
|
125
|
+
* @returns A Promise of ListSessionsResponse
|
|
126
|
+
*/
|
|
127
|
+
listSessions: (request?: Readonly<ListSessionsRequest>) => Promise<ListSessionsResponse> & {
|
|
128
|
+
all: () => Promise<Session[]>;
|
|
129
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Session[], void, void>;
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* Create a session. Create a dedicated session for the specified platform.
|
|
133
|
+
*
|
|
134
|
+
* @param request - The request {@link CreateSessionRequest}
|
|
135
|
+
* @returns A Promise of Session
|
|
136
|
+
*/
|
|
137
|
+
createSession: (request: Readonly<CreateSessionRequest>) => Promise<Session>;
|
|
138
|
+
/**
|
|
139
|
+
* Update session information. Update session information of the provided
|
|
140
|
+
* **session ID**.
|
|
141
|
+
*
|
|
142
|
+
* @param request - The request {@link UpdateSessionRequest}
|
|
143
|
+
* @returns A Promise of Session
|
|
144
|
+
*/
|
|
145
|
+
updateSession: (request: Readonly<UpdateSessionRequest>) => Promise<Session>;
|
|
146
|
+
/**
|
|
147
|
+
* Terminate an existing session. Terminate a session by its unique ID and
|
|
148
|
+
* cancel all its attached jobs.
|
|
149
|
+
*
|
|
150
|
+
* @param request - The request {@link TerminateSessionRequest}
|
|
151
|
+
* @returns A Promise of Session
|
|
152
|
+
*/
|
|
153
|
+
terminateSession: (request: Readonly<TerminateSessionRequest>) => Promise<Session>;
|
|
154
|
+
/**
|
|
155
|
+
* Delete an existing session. Delete a session by its unique ID and delete
|
|
156
|
+
* all its attached jobs.
|
|
157
|
+
*
|
|
158
|
+
* @param request - The request {@link DeleteSessionRequest}
|
|
159
|
+
*/
|
|
160
|
+
deleteSession: (request: Readonly<DeleteSessionRequest>) => Promise<void>;
|
|
161
|
+
protected pageOfListSessionACLs: (request: Readonly<ListSessionACLsRequest>) => Promise<ListSessionACLsResponse>;
|
|
162
|
+
listSessionACLs: (request: Readonly<ListSessionACLsRequest>) => Promise<ListSessionACLsResponse> & {
|
|
163
|
+
all: () => Promise<import("./types.gen").SessionAccess[]>;
|
|
164
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").SessionAccess[], void, void>;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Create a process. Create a new process for the specified application on a
|
|
168
|
+
* specified platform.
|
|
169
|
+
*
|
|
170
|
+
* @param request - The request {@link CreateProcessRequest}
|
|
171
|
+
* @returns A Promise of Process
|
|
172
|
+
*/
|
|
173
|
+
createProcess: (request: Readonly<CreateProcessRequest>) => Promise<Process>;
|
|
174
|
+
/**
|
|
175
|
+
* Get process infrormation. Retrieve information about the provided **process
|
|
176
|
+
* ID**, such as name, status and progress.
|
|
177
|
+
*
|
|
178
|
+
* @param request - The request {@link GetProcessRequest}
|
|
179
|
+
* @returns A Promise of Process
|
|
180
|
+
*/
|
|
181
|
+
getProcess: (request: Readonly<GetProcessRequest>) => Promise<Process>;
|
|
182
|
+
/**
|
|
183
|
+
* Waits for {@link Process} to be in a final state.
|
|
184
|
+
*
|
|
185
|
+
* @param request - The request {@link GetProcessRequest}
|
|
186
|
+
* @param options - The waiting options
|
|
187
|
+
* @returns A Promise of Process
|
|
188
|
+
*/
|
|
189
|
+
waitForProcess: (request: Readonly<GetProcessRequest>, options?: Readonly<WaitForOptions<Process>>) => Promise<Process>;
|
|
190
|
+
protected pageOfListProcesses: (request?: Readonly<ListProcessesRequest>) => Promise<ListProcessesResponse>;
|
|
191
|
+
/**
|
|
192
|
+
* List all processes. Retrieve information about all processes.
|
|
193
|
+
*
|
|
194
|
+
* @param request - The request {@link ListProcessesRequest}
|
|
195
|
+
* @returns A Promise of ListProcessesResponse
|
|
196
|
+
*/
|
|
197
|
+
listProcesses: (request?: Readonly<ListProcessesRequest>) => Promise<ListProcessesResponse> & {
|
|
198
|
+
all: () => Promise<Process[]>;
|
|
199
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Process[], void, void>;
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* Update process information. Update process information of the provided
|
|
203
|
+
* **process ID**.
|
|
204
|
+
*
|
|
205
|
+
* @param request - The request {@link UpdateProcessRequest}
|
|
206
|
+
* @returns A Promise of Process
|
|
207
|
+
*/
|
|
208
|
+
updateProcess: (request: Readonly<UpdateProcessRequest>) => Promise<Process>;
|
|
209
|
+
/**
|
|
210
|
+
* Cancel a running process. Cancel a process by its unique ID. Intermediate
|
|
211
|
+
* results are still available.
|
|
212
|
+
*
|
|
213
|
+
* @param request - The request {@link CancelProcessRequest}
|
|
214
|
+
* @returns A Promise of Process
|
|
215
|
+
*/
|
|
216
|
+
cancelProcess: (request: Readonly<CancelProcessRequest>) => Promise<Process>;
|
|
217
|
+
/**
|
|
218
|
+
* Delete an existing process. Delete a process by its unique ID and delete
|
|
219
|
+
* all its data.
|
|
220
|
+
*
|
|
221
|
+
* @param request - The request {@link DeleteProcessRequest}
|
|
222
|
+
*/
|
|
223
|
+
deleteProcess: (request: Readonly<DeleteProcessRequest>) => Promise<void>;
|
|
224
|
+
protected pageOfListProcessResults: (request: Readonly<ListProcessResultsRequest>) => Promise<ListProcessResultsResponse>;
|
|
225
|
+
/**
|
|
226
|
+
* List all results of a process. Retrieve all intermediate and final result
|
|
227
|
+
* of a process.
|
|
228
|
+
*
|
|
229
|
+
* @param request - The request {@link ListProcessResultsRequest}
|
|
230
|
+
* @returns A Promise of ListProcessResultsResponse
|
|
231
|
+
*/
|
|
232
|
+
listProcessResults: (request: Readonly<ListProcessResultsRequest>) => Promise<ListProcessResultsResponse> & {
|
|
233
|
+
all: () => Promise<import("./types.gen").ProcessResult[]>;
|
|
234
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ProcessResult[], void, void>;
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* Get application information. Retrieve information about the provided
|
|
238
|
+
* **applcation ID**, such as name, type and compatible platforms.
|
|
239
|
+
*
|
|
240
|
+
* @param request - The request {@link GetApplicationRequest}
|
|
241
|
+
* @returns A Promise of Application
|
|
242
|
+
*/
|
|
243
|
+
getApplication: (request: Readonly<GetApplicationRequest>) => Promise<Application>;
|
|
244
|
+
protected pageOfListApplications: (request?: Readonly<ListApplicationsRequest>) => Promise<ListApplicationsResponse>;
|
|
245
|
+
/**
|
|
246
|
+
* List all available applications. Retrieve information about all
|
|
247
|
+
* applications.
|
|
248
|
+
*
|
|
249
|
+
* @param request - The request {@link ListApplicationsRequest}
|
|
250
|
+
* @returns A Promise of ListApplicationsResponse
|
|
251
|
+
*/
|
|
252
|
+
listApplications: (request?: Readonly<ListApplicationsRequest>) => Promise<ListApplicationsResponse> & {
|
|
253
|
+
all: () => Promise<Application[]>;
|
|
254
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Application[], void, void>;
|
|
255
|
+
};
|
|
256
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { JobStatus, ProcessStatus, SessionStatus } from './types.gen';
|
|
2
|
+
/** Lists transient statutes of the enum {@link JobStatus}. */
|
|
3
|
+
export declare const JOB_TRANSIENT_STATUSES: JobStatus[];
|
|
4
|
+
/** Lists transient statutes of the enum {@link ProcessStatus}. */
|
|
5
|
+
export declare const PROCESS_TRANSIENT_STATUSES: ProcessStatus[];
|
|
6
|
+
/** Lists transient statutes of the enum {@link SessionStatus}. */
|
|
7
|
+
export declare const SESSION_TRANSIENT_STATUSES: SessionStatus[];
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { API } from './api.gen';
|
|
2
|
+
export * from './content.gen';
|
|
3
|
+
export type { Application, ApplicationType, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateProcessRequest, CreateSessionRequest, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetJobCircuitRequest, GetJobRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, JobResult, JobStatus, ListApplicationsRequest, ListApplicationsRequestOrderBy, ListApplicationsResponse, ListJobResultsRequest, ListJobResultsRequestOrderBy, ListJobResultsResponse, ListJobsRequest, ListJobsRequestOrderBy, ListJobsResponse, ListPlatformsRequest, ListPlatformsRequestOrderBy, ListPlatformsResponse, ListProcessResultsRequest, ListProcessResultsRequestOrderBy, ListProcessResultsResponse, ListProcessesRequest, ListProcessesRequestOrderBy, ListProcessesResponse, ListSessionACLsRequest, ListSessionACLsRequestOrderBy, ListSessionACLsResponse, ListSessionsRequest, ListSessionsRequestOrderBy, ListSessionsResponse, Platform, PlatformAvailability, PlatformHardware, PlatformTechnology, PlatformType, Process, ProcessResult, ProcessStatus, Session, SessionAccess, SessionOriginType, SessionStatus, TerminateSessionRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest, } from './types.gen';
|
|
4
|
+
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { DefaultValues } from '../../../bridge';
|
|
2
|
+
import type { Application, CreateJobRequest, CreateProcessRequest, CreateSessionRequest, Job, JobCircuit, ListApplicationsResponse, ListJobResultsResponse, ListJobsResponse, ListPlatformsResponse, ListProcessResultsResponse, ListProcessesResponse, ListSessionACLsResponse, ListSessionsResponse, Platform, Process, Session, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen';
|
|
3
|
+
export declare const unmarshalJobCircuit: (data: unknown) => JobCircuit;
|
|
4
|
+
export declare const unmarshalApplication: (data: unknown) => Application;
|
|
5
|
+
export declare const unmarshalJob: (data: unknown) => Job;
|
|
6
|
+
export declare const unmarshalPlatform: (data: unknown) => Platform;
|
|
7
|
+
export declare const unmarshalProcess: (data: unknown) => Process;
|
|
8
|
+
export declare const unmarshalSession: (data: unknown) => Session;
|
|
9
|
+
export declare const unmarshalListApplicationsResponse: (data: unknown) => ListApplicationsResponse;
|
|
10
|
+
export declare const unmarshalListJobResultsResponse: (data: unknown) => ListJobResultsResponse;
|
|
11
|
+
export declare const unmarshalListJobsResponse: (data: unknown) => ListJobsResponse;
|
|
12
|
+
export declare const unmarshalListPlatformsResponse: (data: unknown) => ListPlatformsResponse;
|
|
13
|
+
export declare const unmarshalListProcessResultsResponse: (data: unknown) => ListProcessResultsResponse;
|
|
14
|
+
export declare const unmarshalListProcessesResponse: (data: unknown) => ListProcessesResponse;
|
|
15
|
+
export declare const unmarshalListSessionACLsResponse: (data: unknown) => ListSessionACLsResponse;
|
|
16
|
+
export declare const unmarshalListSessionsResponse: (data: unknown) => ListSessionsResponse;
|
|
17
|
+
export declare const marshalCreateJobRequest: (request: CreateJobRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
18
|
+
export declare const marshalCreateProcessRequest: (request: CreateProcessRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
19
|
+
export declare const marshalCreateSessionRequest: (request: CreateSessionRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
20
|
+
export declare const marshalUpdateJobRequest: (request: UpdateJobRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
21
|
+
export declare const marshalUpdateProcessRequest: (request: UpdateProcessRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
22
|
+
export declare const marshalUpdateSessionRequest: (request: UpdateSessionRequest, defaults: DefaultValues) => Record<string, unknown>;
|