@3dverse/api 0.8.11 → 0.8.13

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.
@@ -770,6 +770,63 @@ export declare function getConversionTaskMetadata<T extends 'arraybuffer' | 'str
770
770
  conversion_task_id: string;
771
771
  filename: string;
772
772
  }, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
773
+ export type SchedulePipeline_Object = {
774
+ asset_type: 'action_map' | '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';
775
+ asset_id: string;
776
+ };
777
+ export type SchedulePipeline_Object_Writable = {
778
+ pipeline_id: string;
779
+ };
780
+ /**
781
+ * Schedules a data pipeline to be run.
782
+ */
783
+ export declare function schedulePipeline({ data_pipeline_id, pipeline_name, folder_id, inputs, asset_refs, }: {
784
+ data_pipeline_id: string;
785
+ pipeline_name?: string;
786
+ folder_id: string;
787
+ inputs?: object;
788
+ asset_refs?: Array<SchedulePipeline_Object>;
789
+ }, headers?: AxiosRequestHeaders): AxiosPromise<SchedulePipeline_Object_Writable>;
790
+ export type GetPipeline_Pipeline = {
791
+ data_pipeline_id: string;
792
+ environment_id: string;
793
+ finished_at?: string;
794
+ folder_id: string;
795
+ jobs: Array<GetPipeline_Job>;
796
+ name: string;
797
+ pipeline_id: string;
798
+ progress: number;
799
+ queued_at?: string;
800
+ status: 'created' | 'downloading' | 'extracting' | 'pending-approval' | 'queued' | 'running' | 'passed-with-errors' | 'failed' | 'succeeded';
801
+ triggered_at: string;
802
+ user_id: string;
803
+ };
804
+ export type GetPipeline_Job = {
805
+ finished_at?: string;
806
+ job_id: string;
807
+ name: string;
808
+ pipeline_id: string;
809
+ progress: number;
810
+ queued_at?: string;
811
+ started_at?: string;
812
+ status: 'created' | 'queued' | 'running' | 'timed-out' | 'failed' | 'succeeded';
813
+ steps: Array<GetPipeline_Step>;
814
+ };
815
+ export type GetPipeline_Step = {
816
+ finished_at?: string;
817
+ job_id: string;
818
+ name: string;
819
+ progress: number;
820
+ started_at?: string;
821
+ status: 'created' | 'skipped' | 'queued' | 'running' | 'timed-out' | 'failed' | 'succeeded';
822
+ step_id: string;
823
+ };
824
+ /**
825
+ * Retrieves a specific instantiated Data Pipeline by its ID.
826
+ */
827
+ export declare function getPipeline({ pipeline_id, }: {
828
+ pipeline_id: string;
829
+ }, headers?: AxiosRequestHeaders): AxiosPromise<GetPipeline_Pipeline>;
773
830
  export type ListAssets_Filter = {
774
831
  asset_type?: Array<'action_map' | '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' | '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';
775
832
  asset_name?: string;
@@ -925,7 +982,7 @@ export declare function getAssetDependencies({ asset_container, asset_id, offset
925
982
  asset_id: string;
926
983
  offset?: number;
927
984
  limit?: number;
928
- depth?: 'all' | 'direct' | number;
985
+ depth?: 'all' | 'direct' | 'all-until-self-dependent' | number;
929
986
  filters?: GetAssetDependencies_Filter;
930
987
  properties?: Array<'name' | 'dependencies' | 'count' | 'public' | 'accessible' | 'payload_info'>;
931
988
  }, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetDependencies_Asset>>;
package/dist/index.js CHANGED
@@ -69,6 +69,7 @@ __export(index_exports, {
69
69
  getFolderAssets: () => getFolderAssets,
70
70
  getFolderInfo: () => getFolderInfo,
71
71
  getGroup: () => getGroup,
72
+ getPipeline: () => getPipeline,
72
73
  getRunningSessions: () => getRunningSessions,
73
74
  getSceneAABB: () => getSceneAABB,
74
75
  getSceneSessions: () => getSceneSessions,
@@ -105,6 +106,7 @@ __export(index_exports, {
105
106
  renameAsset: () => renameAsset,
106
107
  revokeMemberAccessToFolder: () => revokeMemberAccessToFolder,
107
108
  revokeMemberAccessToGroup: () => revokeMemberAccessToGroup,
109
+ schedulePipeline: () => schedulePipeline,
108
110
  setApiKey: () => setApiKey,
109
111
  setAssetThumbnail: () => setAssetThumbnail,
110
112
  setBaseURL: () => setBaseURL,
@@ -707,6 +709,35 @@ function getConversionTaskMetadata({
707
709
  responseType: responseType || "arraybuffer"
708
710
  });
709
711
  }
712
+ function schedulePipeline({
713
+ data_pipeline_id,
714
+ pipeline_name,
715
+ folder_id,
716
+ inputs,
717
+ asset_refs
718
+ }, headers) {
719
+ return axiosInstance({
720
+ method: "post",
721
+ url: "/pipelines",
722
+ data: {
723
+ data_pipeline_id,
724
+ pipeline_name,
725
+ folder_id,
726
+ inputs,
727
+ asset_refs
728
+ },
729
+ headers
730
+ });
731
+ }
732
+ function getPipeline({
733
+ pipeline_id
734
+ }, headers) {
735
+ return axiosInstance({
736
+ method: "get",
737
+ url: "/pipelines/" + pipeline_id,
738
+ headers
739
+ });
740
+ }
710
741
  function listAssets({
711
742
  offset = 0,
712
743
  limit = 10,
@@ -1248,6 +1279,7 @@ installInterceptors();
1248
1279
  getFolderAssets,
1249
1280
  getFolderInfo,
1250
1281
  getGroup,
1282
+ getPipeline,
1251
1283
  getRunningSessions,
1252
1284
  getSceneAABB,
1253
1285
  getSceneSessions,
@@ -1284,6 +1316,7 @@ installInterceptors();
1284
1316
  renameAsset,
1285
1317
  revokeMemberAccessToFolder,
1286
1318
  revokeMemberAccessToGroup,
1319
+ schedulePipeline,
1287
1320
  setApiKey,
1288
1321
  setAssetThumbnail,
1289
1322
  setBaseURL,