@3dverse/api 0.8.1 → 0.8.3
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/_prebuild/wrapper.d.ts +495 -220
- package/dist/index.js +258 -163
- package/dist/index.js.map +2 -2
- package/dist/index.mjs +257 -163
- package/dist/index.mjs.map +2 -2
- package/package.json +2 -2
@@ -2,28 +2,28 @@
|
|
2
2
|
* 3dverse Asset API v1.0
|
3
3
|
* # Getting Started
|
4
4
|
*
|
5
|
-
*
|
5
|
+
*Welcome to the 3dverse Asset API. This is the reference for the REST API endpoints.
|
6
6
|
*
|
7
|
-
|
7
|
+
*## NPM package
|
8
8
|
*
|
9
|
-
*
|
9
|
+
*We provide a TypeScript wrapper library to make typesafe API requests and get typed responses: [https://www.npmjs.com/package/@3dverse/api](https://www.npmjs.com/package/@3dverse/api).
|
10
10
|
*
|
11
|
-
|
11
|
+
*## Authentication
|
12
12
|
*
|
13
|
-
*
|
14
|
-
*
|
13
|
+
*To authenticate your API calls, you'll need to generate an API key via the [3dverse Console](https://console.3dverse.com) and send an `api_key` header with your API requests.
|
14
|
+
*Alternatively, you can create a user, generate a token for the user and authenticate with a `user_token`.
|
15
15
|
*
|
16
16
|
*
|
17
|
-
|
17
|
+
*---
|
18
18
|
*
|
19
19
|
*
|
20
20
|
* Contact: 3dverse Support (support@3dverse.com)
|
21
21
|
*
|
22
22
|
* DO NOT EDIT THIS FILE MANUALLY.
|
23
23
|
* This file has been generated automatically from its OpenAPI spec file.
|
24
|
-
* See
|
24
|
+
* See: https://gitlab.com/3dverse/platform/libs/js/openapi-client-library-generator
|
25
25
|
*/
|
26
|
-
import { AxiosPromise } from 'axios';
|
26
|
+
import { AxiosPromise, AxiosHeaders } from 'axios';
|
27
27
|
type UnionKeys<T> = T extends T ? keyof T : never;
|
28
28
|
type StrictUnionHelper<T, TAll> = T extends any ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>> : never;
|
29
29
|
type StrictUnion<T> = StrictUnionHelper<T, T>;
|
@@ -34,46 +34,64 @@ export type ListUsers_User_UserInfo = {
|
|
34
34
|
username: string;
|
35
35
|
registered_at: string;
|
36
36
|
};
|
37
|
-
|
37
|
+
/**
|
38
|
+
* Retrieve a list of all users in the current application.
|
39
|
+
*/
|
40
|
+
export declare function listUsers({ offset, limit, }: {
|
38
41
|
offset?: number;
|
39
42
|
limit?: number;
|
40
|
-
}): AxiosPromise<Array<ListUsers_User_UserInfo>>;
|
43
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<ListUsers_User_UserInfo>>;
|
41
44
|
export type RegisterUser_User_UserInfo = {
|
42
45
|
user_id: string;
|
43
46
|
username: string;
|
44
47
|
registered_at: string;
|
45
48
|
};
|
46
|
-
|
49
|
+
/**
|
50
|
+
* Registers the target user in the current application.
|
51
|
+
*/
|
52
|
+
export declare function registerUser({ username, }: {
|
47
53
|
username: string;
|
48
|
-
}): AxiosPromise<RegisterUser_User_UserInfo>;
|
54
|
+
}, headers?: AxiosHeaders): AxiosPromise<RegisterUser_User_UserInfo>;
|
49
55
|
export type GetUser_User_UserInfo = {
|
50
56
|
user_id: string;
|
51
57
|
username: string;
|
52
58
|
registered_at: string;
|
53
59
|
};
|
54
|
-
|
60
|
+
/**
|
61
|
+
* Retrieves details about the target user.
|
62
|
+
*/
|
63
|
+
export declare function getUser({ user_id, }: {
|
55
64
|
user_id: string;
|
56
|
-
}): AxiosPromise<GetUser_User_UserInfo>;
|
57
|
-
|
65
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetUser_User_UserInfo>;
|
66
|
+
/**
|
67
|
+
* Updates the details of the target user.
|
68
|
+
*/
|
69
|
+
export declare function updateUser({ user_id, username, }: {
|
58
70
|
user_id: string;
|
59
71
|
username: string;
|
60
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
72
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
61
73
|
export type DeleteUser_Object = {
|
62
74
|
deleted_assets?: DeleteUser_Object;
|
63
75
|
};
|
64
|
-
|
76
|
+
/**
|
77
|
+
* Deletes the target user.
|
78
|
+
*/
|
79
|
+
export declare function deleteUser({ user_id, }: {
|
65
80
|
user_id: string;
|
66
|
-
}): AxiosPromise<DeleteUser_Object>;
|
81
|
+
}, headers?: AxiosHeaders): AxiosPromise<DeleteUser_Object>;
|
67
82
|
export type GenerateUserToken_Token = {
|
68
83
|
user_token?: string;
|
69
84
|
expires_in?: number;
|
70
85
|
expires_on?: number;
|
71
86
|
};
|
72
|
-
|
87
|
+
/**
|
88
|
+
* Generates a user token. This user token identifies the user when making a request.
|
89
|
+
*/
|
90
|
+
export declare function generateUserToken({ user_id, scope, ttl, }: {
|
73
91
|
user_id: string;
|
74
|
-
scope:
|
92
|
+
scope: 'read' | 'write' | 'manage';
|
75
93
|
ttl?: string;
|
76
|
-
}): AxiosPromise<GenerateUserToken_Token>;
|
94
|
+
}, headers?: AxiosHeaders): AxiosPromise<GenerateUserToken_Token>;
|
77
95
|
export type GetUserGroups_Group_GroupInfo = {
|
78
96
|
group_id: string;
|
79
97
|
name: string;
|
@@ -84,12 +102,15 @@ export type GetUserGroups_Group_GroupInfo = {
|
|
84
102
|
export type GetUserGroups_GroupMember_GroupAccess = {
|
85
103
|
user_id: string;
|
86
104
|
joined_at?: string;
|
87
|
-
group_access:
|
88
|
-
folder_access:
|
105
|
+
group_access: 'read' | 'write' | 'manage';
|
106
|
+
folder_access: 'read' | 'write' | 'manage';
|
89
107
|
};
|
90
|
-
|
108
|
+
/**
|
109
|
+
* Lists all user groups.
|
110
|
+
*/
|
111
|
+
export declare function getUserGroups({ user_id, }: {
|
91
112
|
user_id: string;
|
92
|
-
}): AxiosPromise<Array<GetUserGroups_Group_GroupInfo>>;
|
113
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetUserGroups_Group_GroupInfo>>;
|
93
114
|
export type GetUserUploadTasks_UploadTask = {
|
94
115
|
upload_task_id: string;
|
95
116
|
folder_id: string;
|
@@ -108,19 +129,22 @@ export type GetUserUploadTasks_ConversionTask = {
|
|
108
129
|
asset_id: string;
|
109
130
|
source_file_id: string;
|
110
131
|
source_file_name: string;
|
111
|
-
conversion_pipeline:
|
132
|
+
conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'beta-pipeline';
|
112
133
|
progress: number;
|
113
134
|
status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
|
114
135
|
};
|
115
|
-
|
136
|
+
/**
|
137
|
+
* Lists all upload tasks of the target user.
|
138
|
+
*/
|
139
|
+
export declare function getUserUploadTasks({ user_id, offset, limit, }: {
|
116
140
|
user_id: string;
|
117
141
|
offset?: number;
|
118
142
|
limit?: number;
|
119
|
-
}): AxiosPromise<Array<GetUserUploadTasks_UploadTask>>;
|
143
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetUserUploadTasks_UploadTask>>;
|
120
144
|
export type CreateGroup_GroupMember_GroupAccess = {
|
121
145
|
user_id: string;
|
122
|
-
group_access:
|
123
|
-
folder_access:
|
146
|
+
group_access: 'read' | 'write' | 'manage';
|
147
|
+
folder_access: 'read' | 'write' | 'manage';
|
124
148
|
};
|
125
149
|
export type CreateGroup_Group_GroupInfo = {
|
126
150
|
group_id: string;
|
@@ -132,14 +156,17 @@ export type CreateGroup_Group_GroupInfo = {
|
|
132
156
|
export type CreateGroup_GroupMember_GroupAccess_Writable = {
|
133
157
|
user_id: string;
|
134
158
|
joined_at?: string;
|
135
|
-
group_access:
|
136
|
-
folder_access:
|
159
|
+
group_access: 'read' | 'write' | 'manage';
|
160
|
+
folder_access: 'read' | 'write' | 'manage';
|
137
161
|
};
|
138
|
-
|
162
|
+
/**
|
163
|
+
* Creates a new user group.
|
164
|
+
*/
|
165
|
+
export declare function createGroup({ name, description, members, }: {
|
139
166
|
name: string;
|
140
167
|
description?: string;
|
141
168
|
members: Array<CreateGroup_GroupMember_GroupAccess>;
|
142
|
-
}): AxiosPromise<CreateGroup_Group_GroupInfo>;
|
169
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateGroup_Group_GroupInfo>;
|
143
170
|
export type GetGroup_Group_GroupInfo = {
|
144
171
|
group_id: string;
|
145
172
|
name: string;
|
@@ -150,32 +177,47 @@ export type GetGroup_Group_GroupInfo = {
|
|
150
177
|
export type GetGroup_GroupMember_GroupAccess = {
|
151
178
|
user_id: string;
|
152
179
|
joined_at?: string;
|
153
|
-
group_access:
|
154
|
-
folder_access:
|
180
|
+
group_access: 'read' | 'write' | 'manage';
|
181
|
+
folder_access: 'read' | 'write' | 'manage';
|
155
182
|
};
|
156
|
-
|
183
|
+
/**
|
184
|
+
* Gets a group details.
|
185
|
+
*/
|
186
|
+
export declare function getGroup({ group_id, }: {
|
157
187
|
group_id: string;
|
158
|
-
}): AxiosPromise<GetGroup_Group_GroupInfo>;
|
159
|
-
|
188
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetGroup_Group_GroupInfo>;
|
189
|
+
/**
|
190
|
+
* Updates a group details.
|
191
|
+
*/
|
192
|
+
export declare function updateGroupDescription({ group_id, name, description, }: {
|
160
193
|
group_id: string;
|
161
194
|
name: string;
|
162
195
|
description: string;
|
163
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
164
|
-
|
196
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
197
|
+
/**
|
198
|
+
* Deletes a group and all its access rights.
|
199
|
+
*/
|
200
|
+
export declare function deleteGroup({ group_id, }: {
|
165
201
|
group_id: string;
|
166
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
167
|
-
|
202
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
203
|
+
/**
|
204
|
+
* Grants member access to the group.
|
205
|
+
*/
|
206
|
+
export declare function grantMemberAccessToGroup({ group_id, member_type, member_id, group_access, folder_access, }: {
|
168
207
|
group_id: string;
|
169
|
-
member_type:
|
208
|
+
member_type: 'users' | 'groups';
|
170
209
|
member_id: string;
|
171
|
-
group_access:
|
172
|
-
folder_access:
|
173
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
174
|
-
|
210
|
+
group_access: 'read' | 'write' | 'manage';
|
211
|
+
folder_access: 'read' | 'write' | 'manage';
|
212
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
213
|
+
/**
|
214
|
+
* Revoke requested user access to group.
|
215
|
+
*/
|
216
|
+
export declare function revokeMemberAccessToGroup({ group_id, member_type, member_id, }: {
|
175
217
|
group_id: string;
|
176
|
-
member_type:
|
218
|
+
member_type: 'users' | 'groups';
|
177
219
|
member_id: string;
|
178
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
220
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
179
221
|
export type ListFolders_Folder = {
|
180
222
|
folder_id: string;
|
181
223
|
parent_folder_id?: string;
|
@@ -191,10 +233,13 @@ export type ListFolders_Object = {
|
|
191
233
|
username: string;
|
192
234
|
registered_at: string;
|
193
235
|
};
|
194
|
-
|
236
|
+
/**
|
237
|
+
* Lists all accessible folders.
|
238
|
+
*/
|
239
|
+
export declare function listFolders({ offset, limit, }: {
|
195
240
|
offset?: number;
|
196
241
|
limit?: number;
|
197
|
-
}): AxiosPromise<Array<ListFolders_Folder>>;
|
242
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<ListFolders_Folder>>;
|
198
243
|
export type CreateFolder_Folder = {
|
199
244
|
name: string;
|
200
245
|
subfolders?: Array<CreateFolder_Folder>;
|
@@ -214,10 +259,13 @@ export type CreateFolder_Object = {
|
|
214
259
|
username: string;
|
215
260
|
registered_at: string;
|
216
261
|
};
|
217
|
-
|
262
|
+
/**
|
263
|
+
* Creates a folder.
|
264
|
+
*/
|
265
|
+
export declare function createFolder({ name, subfolders, }: {
|
218
266
|
name: string;
|
219
267
|
subfolders?: Array<CreateFolder_Folder>;
|
220
|
-
}): AxiosPromise<CreateFolder_Folder_Writable>;
|
268
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateFolder_Folder_Writable>;
|
221
269
|
export type GetFolderInfo_Folder = {
|
222
270
|
folder_id: string;
|
223
271
|
parent_folder_id?: string;
|
@@ -233,20 +281,32 @@ export type GetFolderInfo_Object = {
|
|
233
281
|
username: string;
|
234
282
|
registered_at: string;
|
235
283
|
};
|
236
|
-
|
284
|
+
/**
|
285
|
+
* Gets the requested folder details.
|
286
|
+
*/
|
287
|
+
export declare function getFolderInfo({ folder_id, }: {
|
237
288
|
folder_id: string;
|
238
|
-
}): AxiosPromise<GetFolderInfo_Folder>;
|
239
|
-
|
289
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetFolderInfo_Folder>;
|
290
|
+
/**
|
291
|
+
* Move folders inside the specified folder.
|
292
|
+
*/
|
293
|
+
export declare function moveFolders({ folder_id, folder_ids, }: {
|
240
294
|
folder_id: string;
|
241
295
|
folder_ids: Array<string>;
|
242
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
243
|
-
|
296
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
297
|
+
/**
|
298
|
+
* Updates the folder details.
|
299
|
+
*/
|
300
|
+
export declare function updateFolder({ folder_id, name, }: {
|
244
301
|
folder_id: string;
|
245
302
|
name?: string;
|
246
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
247
|
-
|
303
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
304
|
+
/**
|
305
|
+
* Deletes the requested folder. The target folder must be empty.
|
306
|
+
*/
|
307
|
+
export declare function deleteFolder({ folder_id, }: {
|
248
308
|
folder_id: string;
|
249
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
309
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
250
310
|
export type ListFolderAccesses_Object = {
|
251
311
|
users?: Array<ListFolderAccesses_UserInfo_FolderAccess>;
|
252
312
|
groups?: Array<ListFolderAccesses_GroupInfo_FolderAccess>;
|
@@ -254,27 +314,36 @@ export type ListFolderAccesses_Object = {
|
|
254
314
|
export type ListFolderAccesses_UserInfo_FolderAccess = {
|
255
315
|
user_id: string;
|
256
316
|
username: string;
|
257
|
-
access:
|
317
|
+
access: 'read' | 'write' | 'manage';
|
258
318
|
};
|
259
319
|
export type ListFolderAccesses_GroupInfo_FolderAccess = {
|
260
320
|
group_id: string;
|
261
321
|
name: string;
|
262
|
-
access:
|
322
|
+
access: 'read' | 'write' | 'manage';
|
263
323
|
};
|
264
|
-
|
324
|
+
/**
|
325
|
+
* List member access to the targeted folder.
|
326
|
+
*/
|
327
|
+
export declare function listFolderAccesses({ folder_id, }: {
|
265
328
|
folder_id: string;
|
266
|
-
}): AxiosPromise<ListFolderAccesses_Object>;
|
267
|
-
|
329
|
+
}, headers?: AxiosHeaders): AxiosPromise<ListFolderAccesses_Object>;
|
330
|
+
/**
|
331
|
+
* Grants member access to the targeted folder.
|
332
|
+
*/
|
333
|
+
export declare function grantMemberAccessToFolder({ folder_id, member_type, member_id, access, }: {
|
268
334
|
folder_id: string;
|
269
|
-
member_type:
|
335
|
+
member_type: 'users' | 'groups';
|
270
336
|
member_id: string;
|
271
|
-
access:
|
272
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
273
|
-
|
337
|
+
access: 'read' | 'write' | 'manage';
|
338
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
339
|
+
/**
|
340
|
+
* Revokes member access to a target folder.
|
341
|
+
*/
|
342
|
+
export declare function revokeMemberAccessToFolder({ folder_id, member_type, member_id, }: {
|
274
343
|
folder_id: string;
|
275
|
-
member_type:
|
344
|
+
member_type: 'users' | 'groups';
|
276
345
|
member_id: string;
|
277
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
346
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
278
347
|
export type CreateSubfolder_Folder = {
|
279
348
|
name: string;
|
280
349
|
subfolders?: Array<CreateSubfolder_Folder>;
|
@@ -294,11 +363,14 @@ export type CreateSubfolder_Object = {
|
|
294
363
|
username: string;
|
295
364
|
registered_at: string;
|
296
365
|
};
|
297
|
-
|
366
|
+
/**
|
367
|
+
* Creates a subfolder.
|
368
|
+
*/
|
369
|
+
export declare function createSubfolder({ folder_id, name, subfolders, }: {
|
298
370
|
folder_id: string;
|
299
371
|
name: string;
|
300
372
|
subfolders?: Array<CreateSubfolder_Folder>;
|
301
|
-
}): AxiosPromise<CreateSubfolder_Folder_Writable>;
|
373
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateSubfolder_Folder_Writable>;
|
302
374
|
export type ListFolderSubFolders_Folder = {
|
303
375
|
folder_id: string;
|
304
376
|
parent_folder_id?: string;
|
@@ -314,16 +386,22 @@ export type ListFolderSubFolders_Object = {
|
|
314
386
|
username: string;
|
315
387
|
registered_at: string;
|
316
388
|
};
|
317
|
-
|
389
|
+
/**
|
390
|
+
* Lists all subfolders of requested folder. This request can be recursive.
|
391
|
+
*/
|
392
|
+
export declare function listFolderSubFolders({ folder_id, }: {
|
318
393
|
folder_id: string;
|
319
|
-
}): AxiosPromise<Array<ListFolderSubFolders_Folder>>;
|
394
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<ListFolderSubFolders_Folder>>;
|
320
395
|
export type UploadSourceFiles_Object = {
|
321
396
|
upload_task_id?: string;
|
322
397
|
};
|
323
|
-
|
398
|
+
/**
|
399
|
+
* Uploads the specified source file(s).
|
400
|
+
*/
|
401
|
+
export declare function uploadSourceFiles({ folder_id, body, }: {
|
324
402
|
folder_id: string;
|
325
403
|
body: FormData;
|
326
|
-
}): AxiosPromise<UploadSourceFiles_Object>;
|
404
|
+
}, headers?: AxiosHeaders): AxiosPromise<UploadSourceFiles_Object>;
|
327
405
|
export type GetSourceFilesInFolder_Filters = {
|
328
406
|
source_file_name?: string;
|
329
407
|
};
|
@@ -333,16 +411,22 @@ export type GetSourceFilesInFolder_SourceFile = {
|
|
333
411
|
name: string;
|
334
412
|
size: number;
|
335
413
|
};
|
336
|
-
|
414
|
+
/**
|
415
|
+
* Lists all source files in a folder.
|
416
|
+
*/
|
417
|
+
export declare function getSourceFilesInFolder({ folder_id, offset, limit, filters, }: {
|
337
418
|
folder_id: string;
|
338
419
|
offset?: number;
|
339
420
|
limit?: number;
|
340
421
|
filters?: GetSourceFilesInFolder_Filters;
|
341
|
-
}): AxiosPromise<Array<GetSourceFilesInFolder_SourceFile>>;
|
342
|
-
|
422
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetSourceFilesInFolder_SourceFile>>;
|
423
|
+
/**
|
424
|
+
* Move source files inside the specified folder.
|
425
|
+
*/
|
426
|
+
export declare function moveSourceFiles({ folder_id, source_file_ids, }: {
|
343
427
|
folder_id: string;
|
344
428
|
source_file_ids: Array<string>;
|
345
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
429
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
346
430
|
export type GetUploadTasksInFolder_UploadTask = {
|
347
431
|
upload_task_id: string;
|
348
432
|
folder_id: string;
|
@@ -361,19 +445,22 @@ export type GetUploadTasksInFolder_ConversionTask = {
|
|
361
445
|
asset_id: string;
|
362
446
|
source_file_id: string;
|
363
447
|
source_file_name: string;
|
364
|
-
conversion_pipeline:
|
448
|
+
conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'beta-pipeline';
|
365
449
|
progress: number;
|
366
450
|
status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
|
367
451
|
};
|
368
|
-
|
452
|
+
/**
|
453
|
+
* Lists all upload tasks in a folder.
|
454
|
+
*/
|
455
|
+
export declare function getUploadTasksInFolder({ folder_id, offset, limit, }: {
|
369
456
|
folder_id: string;
|
370
457
|
offset?: number;
|
371
458
|
limit?: number;
|
372
|
-
}): AxiosPromise<Array<GetUploadTasksInFolder_UploadTask>>;
|
459
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetUploadTasksInFolder_UploadTask>>;
|
373
460
|
export type GetFolderAssets_Filters = {
|
374
461
|
asset_name?: string;
|
375
|
-
asset_type?:
|
376
|
-
source_file?:
|
462
|
+
asset_type?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
463
|
+
source_file?: Array<string> | string | 'exclude';
|
377
464
|
};
|
378
465
|
export type GetFolderAssets_AssetCount = {
|
379
466
|
total: number;
|
@@ -408,25 +495,28 @@ export type GetFolderAssets_Object = {
|
|
408
495
|
asset_id: string;
|
409
496
|
name: string;
|
410
497
|
};
|
411
|
-
|
498
|
+
/**
|
499
|
+
* Lists assets.
|
500
|
+
*/
|
501
|
+
export declare function getFolderAssets({ folder_id, offset, limit, filter, recursive, }: {
|
412
502
|
folder_id: string;
|
413
503
|
offset?: number;
|
414
504
|
limit?: number;
|
415
505
|
filter?: GetFolderAssets_Filters;
|
416
506
|
recursive?: boolean;
|
417
|
-
}): AxiosPromise<GetFolderAssets__index_AssetList_AssetList>;
|
507
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetFolderAssets__index_AssetList_AssetList>;
|
418
508
|
export type CreateAsset_NewAsset = {
|
419
|
-
asset_type:
|
509
|
+
asset_type: 'action_map' | 'algorithm' | 'animation_graph' | 'animation_sequence' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
|
420
510
|
name: string;
|
421
511
|
};
|
422
512
|
export type CreateAsset_AssetDuplication = {
|
423
|
-
asset_type:
|
513
|
+
asset_type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
424
514
|
copy_from_asset_id: string;
|
425
515
|
new_asset_name?: string;
|
426
516
|
options?: CreateAsset_DuplicationOptions;
|
427
517
|
};
|
428
518
|
export type CreateAsset_DuplicationOptions = {
|
429
|
-
asset_types?: Array<
|
519
|
+
asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
430
520
|
max_depth?: number;
|
431
521
|
};
|
432
522
|
export type CreateAsset_AssetDuplicationResult = {
|
@@ -437,32 +527,44 @@ export type CreateAsset_AssetDuplicationResult = {
|
|
437
527
|
export type CreateAsset_SourceToCopyAssetIdMap = {
|
438
528
|
[source_asset_id: string]: string;
|
439
529
|
};
|
440
|
-
|
530
|
+
/**
|
531
|
+
* Creates a new asset.
|
532
|
+
*/
|
533
|
+
export declare function createAsset({ folder_id, asset_creation_options, }: {
|
441
534
|
folder_id: string;
|
442
535
|
asset_creation_options: StrictUnion<CreateAsset_NewAsset | CreateAsset_AssetDuplication>;
|
443
|
-
}): AxiosPromise<CreateAsset_AssetDuplicationResult>;
|
444
|
-
|
536
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateAsset_AssetDuplicationResult>;
|
537
|
+
/**
|
538
|
+
* Move assets inside the specified folder.
|
539
|
+
*/
|
540
|
+
export declare function moveAssets({ folder_id, asset_ids, }: {
|
445
541
|
folder_id: string;
|
446
542
|
asset_ids: Array<string>;
|
447
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
543
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
448
544
|
export type CreateMaterial_Object = {
|
449
545
|
asset_id: string;
|
450
546
|
};
|
451
|
-
|
547
|
+
/**
|
548
|
+
* Creates a material.
|
549
|
+
*/
|
550
|
+
export declare function createMaterial({ folder_id, dataJson, isDoubleSided, name, shaderRef, }: {
|
452
551
|
folder_id: string;
|
453
552
|
dataJson: object;
|
454
553
|
isDoubleSided: boolean;
|
455
554
|
name: string;
|
456
555
|
shaderRef: string;
|
457
|
-
}): AxiosPromise<CreateMaterial_Object>;
|
556
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateMaterial_Object>;
|
458
557
|
export type CreateCubemap_Object = {
|
459
558
|
asset_id: string;
|
460
559
|
};
|
461
|
-
|
560
|
+
/**
|
561
|
+
* Creates a cubemap.
|
562
|
+
*/
|
563
|
+
export declare function createCubemap({ folder_id, faces, name, }: {
|
462
564
|
folder_id: string;
|
463
565
|
faces: Array<string>;
|
464
566
|
name: string;
|
465
|
-
}): AxiosPromise<CreateCubemap_Object>;
|
567
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateCubemap_Object>;
|
466
568
|
export type ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse = {
|
467
569
|
asset_ids: ImportAssets_AssetIds;
|
468
570
|
skipped_files?: Array<string>;
|
@@ -472,11 +574,45 @@ export type ImportAssets_AssetIds = {
|
|
472
574
|
overwritten: Array<string>;
|
473
575
|
skipped: Array<string>;
|
474
576
|
};
|
475
|
-
|
577
|
+
/**
|
578
|
+
* Imports or replaces multiple assets submitted as a package.
|
579
|
+
* The package must be a zip archive containing the assets to import.
|
580
|
+
* The package should contain the assets themselves at the root level of the archive with their descriptions in JSON format, and their payloads (e.g. textures, meshes, etc.)
|
581
|
+
* and contain all the assets' dependencies if they do not already exist.
|
582
|
+
* Supported assets are :
|
583
|
+
* - scene
|
584
|
+
* - mesh
|
585
|
+
* - material
|
586
|
+
* - animation
|
587
|
+
* - animation_set
|
588
|
+
* - animation_graph
|
589
|
+
* - skeleton
|
590
|
+
* - texture_1d
|
591
|
+
* - texture
|
592
|
+
* - texture_3d
|
593
|
+
* - collision_geometry
|
594
|
+
* - cubemap
|
595
|
+
* - volume_material
|
596
|
+
* - event_map
|
597
|
+
* - action_map
|
598
|
+
* - sound
|
599
|
+
* - point_cloud
|
600
|
+
* The packaged assets' files should be named according to the following pattern:
|
601
|
+
* ``` json
|
602
|
+
* - desc.[asset_type].{uuid}
|
603
|
+
* - payload.[mesh|texture|animation|skeleton|texture_1d|texture_3d|collision_geometry|sound].{uuid}
|
604
|
+
* - payload.[texture_1d|texture|texture_3d].mips[0-16].{uuid}
|
605
|
+
* - payload.point_cloud.[position|color].{uuid}
|
606
|
+
* - payload.texture_3d.histogram.{uuid}
|
607
|
+
* ```
|
608
|
+
* The package may also contain an overwrite.json file that describes which assets to overwrite.
|
609
|
+
* The overwrite.json file is only used if the overwrite query parameter is set to only-specified.
|
610
|
+
*/
|
611
|
+
export declare function importAssets({ folder_id, overwrite, body, }: {
|
476
612
|
folder_id: string;
|
477
613
|
overwrite?: StrictUnion<'never' | 'only-specified' | 'always'>;
|
478
|
-
body: ArrayBuffer;
|
479
|
-
}): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
|
614
|
+
body: ArrayBuffer | ReadableStream;
|
615
|
+
}, headers?: AxiosHeaders): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
|
480
616
|
export type GetSessionsInFolder_Session = {
|
481
617
|
session_id: string;
|
482
618
|
scene_id: string;
|
@@ -496,9 +632,12 @@ export type GetSessionsInFolder_UserInfo = {
|
|
496
632
|
user_id: string;
|
497
633
|
username: string;
|
498
634
|
};
|
499
|
-
|
635
|
+
/**
|
636
|
+
* Lists all sessions running on scenes contained in a specified folder.
|
637
|
+
*/
|
638
|
+
export declare function getSessionsInFolder({ folder_id, }: {
|
500
639
|
folder_id: string;
|
501
|
-
}): AxiosPromise<Array<GetSessionsInFolder_Session>>;
|
640
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetSessionsInFolder_Session>>;
|
502
641
|
export type ListSourceFiles_Filters = {
|
503
642
|
source_file_name?: string;
|
504
643
|
};
|
@@ -508,31 +647,46 @@ export type ListSourceFiles_SourceFile = {
|
|
508
647
|
name: string;
|
509
648
|
size: number;
|
510
649
|
};
|
511
|
-
|
650
|
+
/**
|
651
|
+
* List source files.
|
652
|
+
*/
|
653
|
+
export declare function listSourceFiles({ offset, limit, filters, }: {
|
512
654
|
offset?: number;
|
513
655
|
limit?: number;
|
514
656
|
filters?: ListSourceFiles_Filters;
|
515
|
-
}): AxiosPromise<Array<ListSourceFiles_SourceFile>>;
|
516
|
-
|
657
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<ListSourceFiles_SourceFile>>;
|
658
|
+
/**
|
659
|
+
* Deletes the target source files. Deleting a source file is permanent.
|
660
|
+
*/
|
661
|
+
export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
|
517
662
|
source_file_ids: Array<string>;
|
518
663
|
delete_assets?: boolean;
|
519
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
520
|
-
|
664
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
665
|
+
/**
|
666
|
+
* Downloads the target source file.
|
667
|
+
*/
|
668
|
+
export declare function downloadSourceFile<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ source_file_id, }: {
|
521
669
|
source_file_id: string;
|
522
|
-
}): AxiosPromise<ArrayBuffer>;
|
670
|
+
}, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
523
671
|
export type GetSourceFileDetails_SourceFile = {
|
524
672
|
source_file_id: string;
|
525
673
|
source_file_original_name: string;
|
526
674
|
name: string;
|
527
675
|
size: number;
|
528
676
|
};
|
529
|
-
|
677
|
+
/**
|
678
|
+
* Get source file details.
|
679
|
+
*/
|
680
|
+
export declare function getSourceFileDetails({ source_file_id, }: {
|
530
681
|
source_file_id: string;
|
531
|
-
}): AxiosPromise<GetSourceFileDetails_SourceFile>;
|
532
|
-
|
682
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetSourceFileDetails_SourceFile>;
|
683
|
+
/**
|
684
|
+
* Updates details for a specific source file.
|
685
|
+
*/
|
686
|
+
export declare function updateSourceFileDetails({ source_file_id, name, }: {
|
533
687
|
source_file_id: string;
|
534
688
|
name: string;
|
535
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
689
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
536
690
|
export type GetSourceFileAssets__index_AssetList_AssetList = {
|
537
691
|
action_maps?: Array<GetSourceFileAssets_Object>;
|
538
692
|
algorithms?: Array<GetSourceFileAssets_Object>;
|
@@ -562,13 +716,19 @@ export type GetSourceFileAssets_Object = {
|
|
562
716
|
asset_id: string;
|
563
717
|
name: string;
|
564
718
|
};
|
565
|
-
|
719
|
+
/**
|
720
|
+
* Lists all assets generated from the requested source file.
|
721
|
+
*/
|
722
|
+
export declare function getSourceFileAssets({ source_file_id, }: {
|
566
723
|
source_file_id: string;
|
567
|
-
}): AxiosPromise<GetSourceFileAssets__index_AssetList_AssetList>;
|
568
|
-
|
724
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetSourceFileAssets__index_AssetList_AssetList>;
|
725
|
+
/**
|
726
|
+
* Lists all upload tasks. These upload tasks relate to uploaded source files.
|
727
|
+
*/
|
728
|
+
export declare function getUploadTasks({ offset, limit, }: {
|
569
729
|
offset?: number;
|
570
730
|
limit?: number;
|
571
|
-
}): AxiosPromise<any>;
|
731
|
+
}, headers?: AxiosHeaders): AxiosPromise<any>;
|
572
732
|
export type GetUploadTask_UploadTask = {
|
573
733
|
upload_task_id: string;
|
574
734
|
folder_id: string;
|
@@ -587,15 +747,25 @@ export type GetUploadTask_ConversionTask = {
|
|
587
747
|
asset_id: string;
|
588
748
|
source_file_id: string;
|
589
749
|
source_file_name: string;
|
590
|
-
conversion_pipeline:
|
750
|
+
conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'beta-pipeline';
|
591
751
|
progress: number;
|
592
752
|
status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
|
593
753
|
};
|
594
|
-
|
754
|
+
/**
|
755
|
+
* Gets information related to an upload task. This upload task relates to uploaded source files.
|
756
|
+
*/
|
757
|
+
export declare function getUploadTask({ upload_task_id, }: {
|
595
758
|
upload_task_id: string;
|
596
|
-
}): AxiosPromise<GetUploadTask_UploadTask>;
|
759
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetUploadTask_UploadTask>;
|
760
|
+
/**
|
761
|
+
* Gets metadata related to a conversion task. This metadata is produced by the conversion task.
|
762
|
+
*/
|
763
|
+
export declare function getConversionTaskMetadata<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_id, filename, }: {
|
764
|
+
asset_id: string;
|
765
|
+
filename: string;
|
766
|
+
}, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
597
767
|
export type ListAssets_Filter = {
|
598
|
-
asset_type?:
|
768
|
+
asset_type?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
599
769
|
asset_name?: string;
|
600
770
|
include_public_assets?: boolean;
|
601
771
|
};
|
@@ -628,28 +798,40 @@ export type ListAssets_Object = {
|
|
628
798
|
asset_id: string;
|
629
799
|
name: string;
|
630
800
|
};
|
631
|
-
|
801
|
+
/**
|
802
|
+
* Returns a list of all assets.
|
803
|
+
*/
|
804
|
+
export declare function listAssets({ offset, limit, filter, }: {
|
632
805
|
offset?: number;
|
633
806
|
limit?: number;
|
634
807
|
filter?: ListAssets_Filter;
|
635
|
-
}): AxiosPromise<ListAssets__index_AssetList_AssetList>;
|
636
|
-
|
808
|
+
}, headers?: AxiosHeaders): AxiosPromise<ListAssets__index_AssetList_AssetList>;
|
809
|
+
/**
|
810
|
+
* Batch delete assets. You **MUST NOT** reference assets.
|
811
|
+
*/
|
812
|
+
export declare function deleteAssets({ asset_ids, }: {
|
637
813
|
asset_ids: Array<string>;
|
638
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
639
|
-
|
640
|
-
|
814
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
815
|
+
/**
|
816
|
+
* Deletes the asset.
|
817
|
+
*/
|
818
|
+
export declare function deleteAsset({ asset_container, asset_id, }: {
|
819
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
641
820
|
asset_id: string;
|
642
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
821
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
643
822
|
export type GetAssetSourceFile_SourceFile = {
|
644
823
|
source_file_id: string;
|
645
824
|
source_file_original_name: string;
|
646
825
|
name: string;
|
647
826
|
size: number;
|
648
827
|
};
|
649
|
-
|
650
|
-
|
828
|
+
/**
|
829
|
+
* Gets the source file of the specified asset.
|
830
|
+
*/
|
831
|
+
export declare function getAssetSourceFile({ asset_container, asset_id, }: {
|
832
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
651
833
|
asset_id: string;
|
652
|
-
}): AxiosPromise<GetAssetSourceFile_SourceFile>;
|
834
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetAssetSourceFile_SourceFile>;
|
653
835
|
export type GetAssetDetails__index_AssetDetails_AssetDetails = {
|
654
836
|
asset_id: string;
|
655
837
|
contributors?: Array<GetAssetDetails_Contributor>;
|
@@ -658,7 +840,7 @@ export type GetAssetDetails__index_AssetDetails_AssetDetails = {
|
|
658
840
|
last_edited_at?: string;
|
659
841
|
last_edited_by?: GetAssetDetails_LastEditedBy;
|
660
842
|
name: string;
|
661
|
-
type:
|
843
|
+
type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
662
844
|
};
|
663
845
|
export type GetAssetDetails_Contributor = {
|
664
846
|
contribution_count: number;
|
@@ -674,10 +856,13 @@ export type GetAssetDetails_LastEditedBy = {
|
|
674
856
|
user_id: string;
|
675
857
|
username: string;
|
676
858
|
};
|
677
|
-
|
678
|
-
|
859
|
+
/**
|
860
|
+
* Gets the asset details from the specified asset.
|
861
|
+
*/
|
862
|
+
export declare function getAssetDetails({ asset_container, asset_id, }: {
|
863
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
679
864
|
asset_id: string;
|
680
|
-
}): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
|
865
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
|
681
866
|
export type GetAssetFolder_Folder = {
|
682
867
|
folder_id: string;
|
683
868
|
parent_folder_id?: string;
|
@@ -693,18 +878,21 @@ export type GetAssetFolder_Object = {
|
|
693
878
|
username: string;
|
694
879
|
registered_at: string;
|
695
880
|
};
|
696
|
-
|
697
|
-
|
881
|
+
/**
|
882
|
+
* Gets the asset folder from the specified asset.
|
883
|
+
*/
|
884
|
+
export declare function getAssetFolder({ asset_container, asset_id, }: {
|
885
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
698
886
|
asset_id: string;
|
699
|
-
}): AxiosPromise<GetAssetFolder_Folder>;
|
887
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetAssetFolder_Folder>;
|
700
888
|
export type GetAssetDependencies_Filter = {
|
701
|
-
with_asset_types?: Array<
|
702
|
-
without_asset_types?: Array<
|
889
|
+
with_asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
890
|
+
without_asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
703
891
|
public?: StrictUnion<'include' | 'exclude' | 'restrict-to'>;
|
704
892
|
};
|
705
893
|
export type GetAssetDependencies_Asset = {
|
706
894
|
asset_id: string;
|
707
|
-
asset_type:
|
895
|
+
asset_type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
708
896
|
properties?: GetAssetDependencies_Object;
|
709
897
|
};
|
710
898
|
export type GetAssetDependencies_Object = {
|
@@ -723,18 +911,21 @@ export type GetAssetDependencies_Dependency = {
|
|
723
911
|
asset_id: string;
|
724
912
|
count: number;
|
725
913
|
};
|
726
|
-
|
727
|
-
|
914
|
+
/**
|
915
|
+
* Gets the asset dependencies from the specified asset.
|
916
|
+
*/
|
917
|
+
export declare function getAssetDependencies({ asset_container, asset_id, offset, limit, depth, filters, properties, }: {
|
918
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
728
919
|
asset_id: string;
|
729
920
|
offset?: number;
|
730
921
|
limit?: number;
|
731
|
-
depth?:
|
922
|
+
depth?: 'all' | 'direct' | number;
|
732
923
|
filters?: GetAssetDependencies_Filter;
|
733
924
|
properties?: Array<StrictUnion<'name' | 'dependencies' | 'count' | 'public' | 'payload_info'>>;
|
734
|
-
}): AxiosPromise<Array<GetAssetDependencies_Asset>>;
|
925
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetAssetDependencies_Asset>>;
|
735
926
|
export type GetAssetReferences_Asset = {
|
736
927
|
asset_id: string;
|
737
|
-
asset_type:
|
928
|
+
asset_type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
738
929
|
properties?: GetAssetReferences_Object;
|
739
930
|
};
|
740
931
|
export type GetAssetReferences_Object = {
|
@@ -742,13 +933,16 @@ export type GetAssetReferences_Object = {
|
|
742
933
|
direct_count?: number;
|
743
934
|
is_public?: boolean;
|
744
935
|
};
|
745
|
-
|
746
|
-
|
936
|
+
/**
|
937
|
+
* Gets the asset references from the specified asset.
|
938
|
+
*/
|
939
|
+
export declare function getAssetReferences({ asset_container, asset_id, offset, limit, properties, }: {
|
940
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
747
941
|
asset_id: string;
|
748
942
|
offset?: number;
|
749
943
|
limit?: number;
|
750
944
|
properties?: Array<StrictUnion<'name' | 'count' | 'public'>>;
|
751
|
-
}): AxiosPromise<Array<GetAssetReferences_Asset>>;
|
945
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetAssetReferences_Asset>>;
|
752
946
|
export type GetAssetDescription_ActionMap = {
|
753
947
|
actions: GetAssetDescription_Object;
|
754
948
|
name: string;
|
@@ -944,58 +1138,91 @@ export type GetAssetDescription_VolumeMaterial = {
|
|
944
1138
|
roughnessLUT?: Array<GetAssetDescription_Object>;
|
945
1139
|
uuid: string;
|
946
1140
|
};
|
947
|
-
|
948
|
-
|
1141
|
+
/**
|
1142
|
+
* Gets the asset description from the specified asset.
|
1143
|
+
*/
|
1144
|
+
export declare function getAssetDescription({ asset_container, asset_id, }: {
|
1145
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
949
1146
|
asset_id: string;
|
950
|
-
}): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Algorithm | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
|
951
|
-
|
952
|
-
|
1147
|
+
}, headers?: AxiosHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Algorithm | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
|
1148
|
+
/**
|
1149
|
+
* Updates asset description. Supports only updating name.
|
1150
|
+
*/
|
1151
|
+
export declare function renameAsset({ asset_container, asset_id, name, }: {
|
1152
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
953
1153
|
asset_id: string;
|
954
1154
|
name?: string;
|
955
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
956
|
-
|
957
|
-
|
1155
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
1156
|
+
/**
|
1157
|
+
* Gets the asset payload from the specified asset.
|
1158
|
+
*/
|
1159
|
+
export declare function getAssetPayload<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container_with_payload, asset_id, sub_resource, }: {
|
1160
|
+
asset_container_with_payload: 'animations' | 'animation_sequences' | 'collision_geometries' | 'meshes' | 'point_clouds' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d';
|
958
1161
|
asset_id: string;
|
959
1162
|
sub_resource?: StrictUnion<string | 'histogram' | 'position' | 'color'>;
|
960
|
-
}): AxiosPromise<ArrayBuffer>;
|
961
|
-
|
962
|
-
|
1163
|
+
}, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
1164
|
+
/**
|
1165
|
+
* Gets the asset history from the specified asset.
|
1166
|
+
*/
|
1167
|
+
export declare function getAssetHistory({ asset_container, asset_id, }: {
|
1168
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
963
1169
|
asset_id: string;
|
964
|
-
}): AxiosPromise<object>;
|
965
|
-
|
966
|
-
|
1170
|
+
}, headers?: AxiosHeaders): AxiosPromise<object>;
|
1171
|
+
/**
|
1172
|
+
* Gets the asset metadata from the specified asset.
|
1173
|
+
*/
|
1174
|
+
export declare function getAssetMeta({ asset_container, asset_id, }: {
|
1175
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
967
1176
|
asset_id: string;
|
968
|
-
}): AxiosPromise<object>;
|
969
|
-
|
970
|
-
|
1177
|
+
}, headers?: AxiosHeaders): AxiosPromise<object>;
|
1178
|
+
/**
|
1179
|
+
* Gets the code of the specified asset.
|
1180
|
+
*/
|
1181
|
+
export declare function getAssetCode({ asset_container_with_code, asset_id, }: {
|
1182
|
+
asset_container_with_code: 'algorithms' | 'animation_sequences' | 'modules' | 'scripts' | 'shaders';
|
971
1183
|
asset_id: string;
|
972
|
-
}): AxiosPromise<string>;
|
973
|
-
|
974
|
-
|
1184
|
+
}, headers?: AxiosHeaders): AxiosPromise<string>;
|
1185
|
+
/**
|
1186
|
+
* Gets the asset thumbnail from the specified asset.
|
1187
|
+
*/
|
1188
|
+
export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, size, default_url, }: {
|
1189
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
975
1190
|
asset_id: string;
|
976
|
-
size:
|
1191
|
+
size: 'large' | 'medium' | 'small' | 'tiny';
|
977
1192
|
default_url?: string;
|
978
|
-
}): AxiosPromise<ArrayBuffer>;
|
979
|
-
|
980
|
-
|
1193
|
+
}, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
1194
|
+
/**
|
1195
|
+
* Assigns a thumbnail to the specified asset.
|
1196
|
+
*/
|
1197
|
+
export declare function setAssetThumbnail({ asset_container, asset_id, body, }: {
|
1198
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
981
1199
|
asset_id: string;
|
982
|
-
body: ArrayBuffer;
|
983
|
-
}, contentType: 'image/jpg' | 'image/png'): Promise<import("axios").AxiosResponse<any, any>>;
|
984
|
-
|
985
|
-
|
1200
|
+
body: ArrayBuffer | ReadableStream;
|
1201
|
+
}, contentType: 'image/jpg' | 'image/png', headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
1202
|
+
/**
|
1203
|
+
* Gets the asset custom types from the specified asset recursively.
|
1204
|
+
*/
|
1205
|
+
export declare function getAssetCustomTypes({ asset_container_with_custom_types, asset_id, }: {
|
1206
|
+
asset_container_with_custom_types: 'modules';
|
986
1207
|
asset_id: string;
|
987
|
-
}): AxiosPromise<object>;
|
988
|
-
|
989
|
-
|
1208
|
+
}, headers?: AxiosHeaders): AxiosPromise<object>;
|
1209
|
+
/**
|
1210
|
+
* Packages and downloads the target asset.
|
1211
|
+
*/
|
1212
|
+
export declare function packageAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, }: {
|
1213
|
+
asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
990
1214
|
asset_id: string;
|
991
|
-
}): AxiosPromise<ArrayBuffer>;
|
992
|
-
|
993
|
-
|
1215
|
+
}, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
1216
|
+
/**
|
1217
|
+
* Downloads an asset payload in a given format. Only mesh is supported for the moment. This endpoint requires special export permission.
|
1218
|
+
*/
|
1219
|
+
export declare function exportAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container_exportable, asset_id, format, scale, sub_mesh_index, }: {
|
1220
|
+
asset_container_exportable: 'meshes' | 'sounds';
|
994
1221
|
asset_id: string;
|
995
|
-
format:
|
1222
|
+
format: 'obj' | 'stl';
|
996
1223
|
scale?: number;
|
997
1224
|
sub_mesh_index?: number;
|
998
|
-
}): AxiosPromise<ArrayBuffer>;
|
1225
|
+
}, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
999
1226
|
export type GetSceneSessions_Session = {
|
1000
1227
|
session_id: string;
|
1001
1228
|
scene_id: string;
|
@@ -1015,16 +1242,22 @@ export type GetSceneSessions_UserInfo = {
|
|
1015
1242
|
user_id: string;
|
1016
1243
|
username: string;
|
1017
1244
|
};
|
1018
|
-
|
1245
|
+
/**
|
1246
|
+
* Lists all sessions running a specified scene.
|
1247
|
+
*/
|
1248
|
+
export declare function getSceneSessions({ scene_id, }: {
|
1019
1249
|
scene_id: string;
|
1020
|
-
}): AxiosPromise<Array<GetSceneSessions_Session>>;
|
1250
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetSceneSessions_Session>>;
|
1021
1251
|
export type GetSceneAabb_Object = {
|
1022
1252
|
max: Array<number>;
|
1023
1253
|
min: Array<number>;
|
1024
1254
|
};
|
1025
|
-
|
1255
|
+
/**
|
1256
|
+
* Get the axis aligned bounding box of the specified scene.
|
1257
|
+
*/
|
1258
|
+
export declare function getSceneAABB({ scene_id, }: {
|
1026
1259
|
scene_id: string;
|
1027
|
-
}): AxiosPromise<GetSceneAabb_Object>;
|
1260
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetSceneAabb_Object>;
|
1028
1261
|
export type CreateEntity_animation_controller = {
|
1029
1262
|
animation_controller: CreateEntity_AnimationController;
|
1030
1263
|
};
|
@@ -1366,10 +1599,16 @@ export type CreateEntity_volume_ref = {
|
|
1366
1599
|
export type CreateEntity_VolumeReference = {
|
1367
1600
|
texture3dRef: string;
|
1368
1601
|
};
|
1369
|
-
export
|
1602
|
+
export type CreateEntity_Object = {
|
1603
|
+
entity_id: string;
|
1604
|
+
};
|
1605
|
+
/**
|
1606
|
+
* Create a new entity in a scene.
|
1607
|
+
*/
|
1608
|
+
export declare function createEntity({ scene_id, entity_components, }: {
|
1370
1609
|
scene_id: string;
|
1371
|
-
entity_components:
|
1372
|
-
}): AxiosPromise<
|
1610
|
+
entity_components: CreateEntity_animation_controller | CreateEntity_bone | CreateEntity_box_geometry | CreateEntity_camera | CreateEntity_capsule_geometry | CreateEntity_character_controller | CreateEntity_collision_geometry_ref | CreateEntity_cylinder_geometry | CreateEntity_debug_name | CreateEntity_decal_projector | CreateEntity_environment | CreateEntity_joint | CreateEntity_lineage | CreateEntity_local_aabb | CreateEntity_local_transform | CreateEntity_material | CreateEntity_material_ref | CreateEntity_mesh_ref | CreateEntity_orthographic_lens | CreateEntity_overrider | CreateEntity_perspective_lens | CreateEntity_physics_material | CreateEntity_plane_geometry | CreateEntity_point_cloud_ref | CreateEntity_point_light | CreateEntity_reflection_probe | CreateEntity_revolute_joint | CreateEntity_rigid_body | CreateEntity_scene_ref | CreateEntity_script_element | CreateEntity_script_map | CreateEntity_shadow_caster | CreateEntity_skeleton_ref | CreateEntity_sound_ref | CreateEntity_sphere_geometry | CreateEntity_spot_light | CreateEntity_stereoscopic_lens | CreateEntity_tags | CreateEntity_volume_filter | CreateEntity_volume_material_ref | CreateEntity_volume_ref;
|
1611
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateEntity_Object>;
|
1373
1612
|
export type GetEntity_animation_controller = {
|
1374
1613
|
animation_controller: GetEntity_AnimationController;
|
1375
1614
|
};
|
@@ -1717,11 +1956,14 @@ export type GetEntity_Entity = {
|
|
1717
1956
|
export type GetEntity_EntityUid = {
|
1718
1957
|
value: string;
|
1719
1958
|
};
|
1720
|
-
|
1959
|
+
/**
|
1960
|
+
* Get a specific entity from a scene.
|
1961
|
+
*/
|
1962
|
+
export declare function getEntity({ scene_id, entity_id, compute_global_transform, }: {
|
1721
1963
|
scene_id: string;
|
1722
1964
|
entity_id: string;
|
1723
1965
|
compute_global_transform?: boolean;
|
1724
|
-
}): AxiosPromise<(GetEntity_animation_controller | GetEntity_bone | GetEntity_box_geometry | GetEntity_camera | GetEntity_capsule_geometry | GetEntity_character_controller | GetEntity_collision_geometry_ref | GetEntity_cylinder_geometry | GetEntity_debug_name | GetEntity_decal_projector | GetEntity_environment | GetEntity_joint | GetEntity_lineage | GetEntity_local_aabb | GetEntity_local_transform | GetEntity_material | GetEntity_material_ref | GetEntity_mesh_ref | GetEntity_orthographic_lens | GetEntity_overrider | GetEntity_perspective_lens | GetEntity_physics_material | GetEntity_plane_geometry | GetEntity_point_cloud_ref | GetEntity_point_light | GetEntity_reflection_probe | GetEntity_revolute_joint | GetEntity_rigid_body | GetEntity_scene_ref | GetEntity_script_element | GetEntity_script_map | GetEntity_shadow_caster | GetEntity_skeleton_ref | GetEntity_sound_ref | GetEntity_sphere_geometry | GetEntity_spot_light | GetEntity_stereoscopic_lens | GetEntity_tags | GetEntity_volume_filter | GetEntity_volume_material_ref | GetEntity_volume_ref) & GetEntity_Entity>;
|
1966
|
+
}, headers?: AxiosHeaders): AxiosPromise<(GetEntity_animation_controller | GetEntity_bone | GetEntity_box_geometry | GetEntity_camera | GetEntity_capsule_geometry | GetEntity_character_controller | GetEntity_collision_geometry_ref | GetEntity_cylinder_geometry | GetEntity_debug_name | GetEntity_decal_projector | GetEntity_environment | GetEntity_joint | GetEntity_lineage | GetEntity_local_aabb | GetEntity_local_transform | GetEntity_material | GetEntity_material_ref | GetEntity_mesh_ref | GetEntity_orthographic_lens | GetEntity_overrider | GetEntity_perspective_lens | GetEntity_physics_material | GetEntity_plane_geometry | GetEntity_point_cloud_ref | GetEntity_point_light | GetEntity_reflection_probe | GetEntity_revolute_joint | GetEntity_rigid_body | GetEntity_scene_ref | GetEntity_script_element | GetEntity_script_map | GetEntity_shadow_caster | GetEntity_skeleton_ref | GetEntity_sound_ref | GetEntity_sphere_geometry | GetEntity_spot_light | GetEntity_stereoscopic_lens | GetEntity_tags | GetEntity_volume_filter | GetEntity_volume_material_ref | GetEntity_volume_ref) & GetEntity_Entity>;
|
1725
1967
|
export type UpdateEntity_animation_controller = {
|
1726
1968
|
animation_controller: UpdateEntity_AnimationController;
|
1727
1969
|
};
|
@@ -2063,18 +2305,27 @@ export type UpdateEntity_volume_ref = {
|
|
2063
2305
|
export type UpdateEntity_VolumeReference = {
|
2064
2306
|
texture3dRef: string;
|
2065
2307
|
};
|
2066
|
-
|
2308
|
+
/**
|
2309
|
+
* Update a specific entity from a scene.
|
2310
|
+
*/
|
2311
|
+
export declare function updateEntity({ scene_id, entity_id, entity_components, }: {
|
2067
2312
|
scene_id: string;
|
2068
2313
|
entity_id: string;
|
2069
|
-
entity_components:
|
2070
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
2071
|
-
|
2314
|
+
entity_components: UpdateEntity_animation_controller | UpdateEntity_bone | UpdateEntity_box_geometry | UpdateEntity_camera | UpdateEntity_capsule_geometry | UpdateEntity_character_controller | UpdateEntity_collision_geometry_ref | UpdateEntity_cylinder_geometry | UpdateEntity_debug_name | UpdateEntity_decal_projector | UpdateEntity_environment | UpdateEntity_joint | UpdateEntity_lineage | UpdateEntity_local_aabb | UpdateEntity_local_transform | UpdateEntity_material | UpdateEntity_material_ref | UpdateEntity_mesh_ref | UpdateEntity_orthographic_lens | UpdateEntity_overrider | UpdateEntity_perspective_lens | UpdateEntity_physics_material | UpdateEntity_plane_geometry | UpdateEntity_point_cloud_ref | UpdateEntity_point_light | UpdateEntity_reflection_probe | UpdateEntity_revolute_joint | UpdateEntity_rigid_body | UpdateEntity_scene_ref | UpdateEntity_script_element | UpdateEntity_script_map | UpdateEntity_shadow_caster | UpdateEntity_skeleton_ref | UpdateEntity_sound_ref | UpdateEntity_sphere_geometry | UpdateEntity_spot_light | UpdateEntity_stereoscopic_lens | UpdateEntity_tags | UpdateEntity_volume_filter | UpdateEntity_volume_material_ref | UpdateEntity_volume_ref;
|
2315
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
2316
|
+
/**
|
2317
|
+
* Delete a specific entity from a scene.
|
2318
|
+
*/
|
2319
|
+
export declare function deleteEntity({ scene_id, entity_id, }: {
|
2072
2320
|
scene_id: string;
|
2073
2321
|
entity_id: string;
|
2074
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
2075
|
-
|
2322
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
2323
|
+
/**
|
2324
|
+
* Get the settings of a scene.
|
2325
|
+
*/
|
2326
|
+
export declare function getSceneSettings({ scene_id, }: {
|
2076
2327
|
scene_id: string;
|
2077
|
-
}): AxiosPromise<object>;
|
2328
|
+
}, headers?: AxiosHeaders): AxiosPromise<object>;
|
2078
2329
|
export type GetRunningSessions_Filter = {
|
2079
2330
|
user_id?: string;
|
2080
2331
|
scene_id?: string;
|
@@ -2099,17 +2350,23 @@ export type GetRunningSessions_UserInfo = {
|
|
2099
2350
|
user_id: string;
|
2100
2351
|
username: string;
|
2101
2352
|
};
|
2102
|
-
|
2353
|
+
/**
|
2354
|
+
* Lists all running rendering sessions.
|
2355
|
+
*/
|
2356
|
+
export declare function getRunningSessions({ filters, }: {
|
2103
2357
|
filters?: GetRunningSessions_Filter;
|
2104
|
-
}): AxiosPromise<Array<GetRunningSessions_Session>>;
|
2358
|
+
}, headers?: AxiosHeaders): AxiosPromise<Array<GetRunningSessions_Session>>;
|
2105
2359
|
export type CreateSession_Object = {
|
2106
2360
|
session_id: string;
|
2107
2361
|
};
|
2108
|
-
|
2362
|
+
/**
|
2363
|
+
* Create a new rendering session.
|
2364
|
+
*/
|
2365
|
+
export declare function createSession({ scene_id, renderer_version, is_transient, }: {
|
2109
2366
|
scene_id: string;
|
2110
2367
|
renderer_version?: string;
|
2111
2368
|
is_transient?: boolean;
|
2112
|
-
}): AxiosPromise<CreateSession_Object>;
|
2369
|
+
}, headers?: AxiosHeaders): AxiosPromise<CreateSession_Object>;
|
2113
2370
|
export type GetSession_Session = {
|
2114
2371
|
session_id: string;
|
2115
2372
|
scene_id: string;
|
@@ -2129,12 +2386,18 @@ export type GetSession_UserInfo = {
|
|
2129
2386
|
user_id: string;
|
2130
2387
|
username: string;
|
2131
2388
|
};
|
2132
|
-
|
2389
|
+
/**
|
2390
|
+
* Retrieves details about the target session.
|
2391
|
+
*/
|
2392
|
+
export declare function getSession({ session_id, }: {
|
2133
2393
|
session_id: string;
|
2134
|
-
}): AxiosPromise<GetSession_Session>;
|
2135
|
-
|
2394
|
+
}, headers?: AxiosHeaders): AxiosPromise<GetSession_Session>;
|
2395
|
+
/**
|
2396
|
+
* Forcefully terminates a session.
|
2397
|
+
*/
|
2398
|
+
export declare function killSession({ session_id, }: {
|
2136
2399
|
session_id: string;
|
2137
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
2400
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
2138
2401
|
export type JoinSession_SessionToken = {
|
2139
2402
|
session_token: string;
|
2140
2403
|
endpoint_info: JoinSession_Object;
|
@@ -2144,13 +2407,19 @@ export type JoinSession_Object = {
|
|
2144
2407
|
port: number;
|
2145
2408
|
ssl_port: number;
|
2146
2409
|
};
|
2147
|
-
|
2410
|
+
/**
|
2411
|
+
* Creates a new client for the user and returns a token to join the session.
|
2412
|
+
*/
|
2413
|
+
export declare function joinSession({ session_id, }: {
|
2148
2414
|
session_id: string;
|
2149
|
-
}): AxiosPromise<JoinSession_SessionToken>;
|
2150
|
-
|
2415
|
+
}, headers?: AxiosHeaders): AxiosPromise<JoinSession_SessionToken>;
|
2416
|
+
/**
|
2417
|
+
* Kick a client from a running session.
|
2418
|
+
*/
|
2419
|
+
export declare function kickClientFromSession({ session_id, client_id, }: {
|
2151
2420
|
session_id: string;
|
2152
2421
|
client_id: string;
|
2153
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
2422
|
+
}, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
2154
2423
|
export type JoinSessionAsGuest_SessionToken = {
|
2155
2424
|
session_token: string;
|
2156
2425
|
endpoint_info: JoinSessionAsGuest_Object;
|
@@ -2160,11 +2429,17 @@ export type JoinSessionAsGuest_Object = {
|
|
2160
2429
|
port: number;
|
2161
2430
|
ssl_port: number;
|
2162
2431
|
};
|
2163
|
-
|
2432
|
+
/**
|
2433
|
+
* Join a session as guest. The guest token is required in the `guest_token` header.
|
2434
|
+
*/
|
2435
|
+
export declare function joinSessionAsGuest(headers?: AxiosHeaders): AxiosPromise<JoinSessionAsGuest_SessionToken>;
|
2164
2436
|
export type GenerateGuestToken_GuestToken = {
|
2165
2437
|
guest_token?: string;
|
2166
2438
|
};
|
2167
|
-
|
2439
|
+
/**
|
2440
|
+
* Generates a token to join the session as a guest.
|
2441
|
+
*/
|
2442
|
+
export declare function generateGuestToken({ session_id, }: {
|
2168
2443
|
session_id: string;
|
2169
|
-
}): AxiosPromise<GenerateGuestToken_GuestToken>;
|
2444
|
+
}, headers?: AxiosHeaders): AxiosPromise<GenerateGuestToken_GuestToken>;
|
2170
2445
|
export {};
|