@3dverse/api 0.8.5 → 0.8.7

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.
@@ -624,9 +624,9 @@ export type GetSessionsInFolder_Session = {
624
624
  country_code: string;
625
625
  continent_code: string;
626
626
  is_transient_session: boolean;
627
- clients: Array<GetSessionsInFolder_UserInfo>;
627
+ clients: Array<GetSessionsInFolder_Client_UserInfo>;
628
628
  };
629
- export type GetSessionsInFolder_UserInfo = {
629
+ export type GetSessionsInFolder_Client_UserInfo = {
630
630
  client_id?: string;
631
631
  client_type?: StrictUnion<'user' | 'guest'>;
632
632
  user_id: string;
@@ -1234,9 +1234,9 @@ export type GetSceneSessions_Session = {
1234
1234
  country_code: string;
1235
1235
  continent_code: string;
1236
1236
  is_transient_session: boolean;
1237
- clients: Array<GetSceneSessions_UserInfo>;
1237
+ clients: Array<GetSceneSessions_Client_UserInfo>;
1238
1238
  };
1239
- export type GetSceneSessions_UserInfo = {
1239
+ export type GetSceneSessions_Client_UserInfo = {
1240
1240
  client_id?: string;
1241
1241
  client_type?: StrictUnion<'user' | 'guest'>;
1242
1242
  user_id: string;
@@ -2477,9 +2477,9 @@ export type GetRunningSessions_Session = {
2477
2477
  country_code: string;
2478
2478
  continent_code: string;
2479
2479
  is_transient_session: boolean;
2480
- clients: Array<GetRunningSessions_UserInfo>;
2480
+ clients: Array<GetRunningSessions_Client_UserInfo>;
2481
2481
  };
2482
- export type GetRunningSessions_UserInfo = {
2482
+ export type GetRunningSessions_Client_UserInfo = {
2483
2483
  client_id?: string;
2484
2484
  client_type?: StrictUnion<'user' | 'guest'>;
2485
2485
  user_id: string;
@@ -2497,10 +2497,11 @@ export type CreateSession_Object = {
2497
2497
  /**
2498
2498
  * Create a new rendering session.
2499
2499
  */
2500
- export declare function createSession({ scene_id, renderer_version, is_transient, }: {
2500
+ export declare function createSession({ scene_id, renderer_version, is_transient, options, }: {
2501
2501
  scene_id: string;
2502
2502
  renderer_version?: string;
2503
2503
  is_transient?: boolean;
2504
+ options?: object;
2504
2505
  }, headers?: AxiosHeaders): AxiosPromise<CreateSession_Object>;
2505
2506
  export type GetSession_Session = {
2506
2507
  session_id: string;
@@ -2513,9 +2514,9 @@ export type GetSession_Session = {
2513
2514
  country_code: string;
2514
2515
  continent_code: string;
2515
2516
  is_transient_session: boolean;
2516
- clients: Array<GetSession_UserInfo>;
2517
+ clients: Array<GetSession_Client_UserInfo>;
2517
2518
  };
2518
- export type GetSession_UserInfo = {
2519
+ export type GetSession_Client_UserInfo = {
2519
2520
  client_id?: string;
2520
2521
  client_type?: StrictUnion<'user' | 'guest'>;
2521
2522
  user_id: string;
@@ -2548,6 +2549,19 @@ export type JoinSession_Object = {
2548
2549
  export declare function joinSession({ session_id, }: {
2549
2550
  session_id: string;
2550
2551
  }, headers?: AxiosHeaders): AxiosPromise<JoinSession_SessionToken>;
2552
+ export type GetClient_Client_UserInfo = {
2553
+ client_id?: string;
2554
+ client_type?: StrictUnion<'user' | 'guest'>;
2555
+ user_id: string;
2556
+ username: string;
2557
+ };
2558
+ /**
2559
+ * Retrieves details about the target client.
2560
+ */
2561
+ export declare function getClient({ session_id, client_id, }: {
2562
+ session_id: string;
2563
+ client_id: string;
2564
+ }, headers?: AxiosHeaders): AxiosPromise<GetClient_Client_UserInfo>;
2551
2565
  /**
2552
2566
  * Kick a client from a running session.
2553
2567
  */
package/dist/index.js CHANGED
@@ -63,6 +63,7 @@ __export(library_exports, {
63
63
  getAssetReferences: () => getAssetReferences,
64
64
  getAssetSourceFile: () => getAssetSourceFile,
65
65
  getAssetThumbnail: () => getAssetThumbnail,
66
+ getClient: () => getClient,
66
67
  getConversionTaskMetadata: () => getConversionTaskMetadata,
67
68
  getEntity: () => getEntity,
68
69
  getFolderAssets: () => getFolderAssets,
@@ -1027,7 +1028,8 @@ function getRunningSessions({
1027
1028
  function createSession({
1028
1029
  scene_id,
1029
1030
  renderer_version,
1030
- is_transient = false
1031
+ is_transient = false,
1032
+ options
1031
1033
  }, headers) {
1032
1034
  return axiosInstance({
1033
1035
  method: "post",
@@ -1035,7 +1037,8 @@ function createSession({
1035
1037
  data: {
1036
1038
  scene_id,
1037
1039
  renderer_version,
1038
- is_transient
1040
+ is_transient,
1041
+ options
1039
1042
  },
1040
1043
  headers
1041
1044
  });
@@ -1067,6 +1070,16 @@ function joinSession({
1067
1070
  headers
1068
1071
  });
1069
1072
  }
1073
+ function getClient({
1074
+ session_id,
1075
+ client_id
1076
+ }, headers) {
1077
+ return axiosInstance({
1078
+ method: "get",
1079
+ url: "/sessions/" + session_id + "/clients/" + client_id,
1080
+ headers
1081
+ });
1082
+ }
1070
1083
  function kickClientFromSession({
1071
1084
  session_id,
1072
1085
  client_id
@@ -1224,6 +1237,7 @@ function uploadSourceFiles({
1224
1237
  getAssetReferences,
1225
1238
  getAssetSourceFile,
1226
1239
  getAssetThumbnail,
1240
+ getClient,
1227
1241
  getConversionTaskMetadata,
1228
1242
  getEntity,
1229
1243
  getFolderAssets,