@imposium-hub/components 1.44.4 → 1.45.0

package/dist/esm/services/API.d.ts

@@ -0,0 +1,181 @@
+export interface IImposiumAPI {
+    getAssets(filters: any, storyId: string, unprocessed?: boolean): any;
+    getAssetItem(assetId: string): any;
+    uploadAsset(storyId: string, tags: string, file: File, onUploadProgress: (e: any) => void, fileName?: string): Promise<any | Error>;
+    cancelUploadAssets(alias: string): any;
+    deleteAsset(assetId: string): any;
+    deleteAssets(assetIds: string[]): any;
+    copyAsset(assetId: string, data: any): any;
+    addAssetTag(assetId: string, tag: string): any;
+    addAssetTags(assetId: string, tags: string[]): any;
+    deleteAssetTag(assetId: string, tag: string): any;
+    updateAsset(assetId: string, data: any): any;
+    getAssetTags(storyId: string): any;
+    duplicateAsset(assetId: string, assetName: string): any;
+    getStory(storyId: string): any;
+    saveStory(storyId: any, story: any): any;
+    newStory(story: any): any;
+    deleteStory(storyId: string): any;
+    getStoryStatus(storyId: string): any;
+    revertVersion(storyId: string, versionId: string): any;
+    getStoryVersions(storyId: string): any;
+    processStoryFile(storyId: string, file_key?: string, url?: string): any;
+    getExperiences(storyId: string, params: any): any;
+    createExperience(storyId: string, inventory: any, compositionId?: string, useWorkingCopy?: boolean): any;
+    getExperience(experienceId: string, poll: boolean): any;
+    blockByExperience(experienceId: string): any;
+    triggerEvent(experienceId: string, compositionId?: string, useWorkingCopy?: boolean): any;
+    getBatches(storyId: string, params?: any): any;
+    getBatch(batchId: string, page: number): any;
+    getBatchProgress(batchId: string): any;
+    createFreshBatch(storyId: string, batchName: string): any;
+    updateBatchName(batchId: string, name: string): any;
+    importBatchDataFromCsv(batchId: string, csvFileKey: string, embed?: boolean, accessKey?: string, compId?: string, addMedia?: boolean): Promise<any | Error>;
+    updateBatchColumns(batchId: string, columns: any): any;
+    insertNewRow(batchId: string, rowIndex: number): any;
+    updateCellValue(batchId: string, colIndex: number, rowIndex: number, value: string): any;
+    prepareBatchForRender(batchId: string): any;
+    checkBatchExportStatus(batchId: string): any;
+    invokeBatchExportJob(batchId: string): any;
+    duplicateBatch(batchId: string): any;
+    downloadBatchExport(batchId: string, exportId: number): any;
+    deleteBatch(batchId: string): any;
+    invokeBatchRenderJob(batchId: string): any;
+    cancelBatchRenderJob(batchId: string): any;
+    getJob(jobId: string): any;
+    pollJob(jobId: string): any;
+    getJobLogUrl(jobId: string): any;
+    getJobLog(url: string): any;
+    getSignedUrl(storyId: string, file: File): any;
+    uploadToSignedUrl(url: string, file: File, onUploadProgress?: any): any;
+    checkS3Bucket(bucket: string): any;
+    createS3Bucket(bucket: string, region: string, readOnly: boolean, cloudFront: boolean): any;
+    runCut(storyId: string, actId: string, sceneId: string, cutId: string): any;
+    runReRenderCuts(storyId: string, actId: string, sceneId: string): any;
+    runProcessBaseVideo(storyId: string, fileKey: string): any;
+    runPublish(storyId: string, message: string): any;
+    cancelPublish(storyId: string): any;
+    cancelJobPolling(): any;
+    getAccssCredentials(): any;
+    createAccessCredentials(name: string): any;
+    deleteAccessCrednetials(access_key_id: string): any;
+    getUsers(organizationId: string, page: number, itemsPerPage: number): any;
+    addUser(organizationId: string, email: string, roleId: number): any;
+    updateRole(organizationId: string, userId: string, roleId: number): any;
+    deleteUser(organizationId: string, userId: string): any;
+    getPlayerMetrics(storyId: string, start: number, end: number, alias: string): any;
+    getSystemMetrics(storyId: string, start: number, end: number, step: number, alias: string): any;
+    getOrganizations(page: number, itemsPerPage: number): Promise<any[]>;
+    addOrganization(orgName: string): any;
+    cancelExperiencePolling(): any;
+    createCompositionAsset(storyId: string, compositionData: any, name?: string): Promise<any | Error>;
+    getAccountInfo(orgId: string): Promise<any | Error>;
+}
+export default class API {
+    private http;
+    private awsHttp;
+    private pollingInterval;
+    private experiencePollTimer;
+    private jobPollTimer;
+    private cancelTokenCache;
+    private cancelTokens;
+    constructor(baseURL: string, idToken: string, organizationId?: string);
+    private doRequest;
+    private cancelPrevious;
+    private clearCache;
+    private doAWSRequest;
+    saveStory: (storyId: string, story: any) => Promise<any | Error>;
+    newStory: (story: any) => Promise<any | Error>;
+    deleteStory: (storyId: string) => Promise<any | Error>;
+    getStoryStatus: (storyId: string) => Promise<any | Error>;
+    getStoryVersions: (storyId: string) => Promise<any | Error>;
+    revertVersion: (storyId: string, versionId: string) => Promise<any | Error>;
+    getSignedUrl: (storyId: string, file: File) => Promise<any | Error>;
+    uploadToSignedUrl: (url: any, file: any, onUploadProgress?: any) => Promise<any | Error>;
+    checkS3Bucket: (bucket: string) => Promise<any | Error>;
+    createS3Bucket: (bucket: string, region: string, readOnly: boolean, cloudFront: boolean) => Promise<any | Error>;
+    processStoryFile: (storyId: string, file_key?: string, url?: string) => Promise<any | Error>;
+    getAssets: (filters: any, storyId: string, unprocessed?: boolean) => Promise<any | Error>;
+    getAssetItem: (assetId: string) => Promise<any | Error>;
+    duplicateAsset: (assetId: string, assetName: string) => Promise<any | Error>;
+    private cancelRequest;
+    private clearCancelTokes;
+    uploadAsset: (storyId: string, tags: string, file: File, onUploadProgress: (e: any) => void, fileName?: string) => Promise<any | Error>;
+    cancelUploadAssets: (alias: string) => void;
+    createCompositionAsset: (storyId: string, compositionData: any, name?: string) => Promise<any | Error>;
+    createStaticCompositionAsset: (storyId: string, compositionData: any) => Promise<any | Error>;
+    deleteAsset: (assetId: string) => Promise<any | Error>;
+    deleteAssets: (assetIds: string[]) => Promise<any | Error>;
+    copyAsset: (assetId: string, data: any) => Promise<any | Error>;
+    addAssetTag: (assetId: string, tag: any) => Promise<any | Error>;
+    addAssetTags: (assetId: string, tags: any) => Promise<any | Error>;
+    deleteAssetTag: (assetId: string, tag: string) => Promise<any | Error>;
+    updateAsset: (assetId: string, data: any) => Promise<any | Error>;
+    getAssetTags: (storyId: string) => Promise<any | Error>;
+    getStory: (storyId: string) => Promise<any | Error>;
+    getExperiences: (storyId: string, params: any) => Promise<any | Error>;
+    exportExperiences: (storyId: string, params: any) => Promise<any | Error>;
+    blockByExperience: (experienceId: string) => Promise<any | Error>;
+    getBatches: (storyId: string, params?: any) => Promise<any | Error>;
+    getBatch: (batchId: string, page: number) => Promise<any | Error>;
+    getBatchProgress: (batchId: string) => Promise<any | Error>;
+    createFreshBatch: (storyId: string, batchName: string) => Promise<any | Error>;
+    updateBatchName: (batchId: string, name: string) => Promise<any | Error>;
+    importBatchDataFromCsv: (batchId: string, csvFileKey: string, embed?: boolean, accessKey?: string, compId?: string, addMedia?: boolean) => Promise<any | Error>;
+    updateBatchColumns: (batchId: string, columns: any[]) => Promise<any | Error>;
+    insertNewRow: (batchId: string, rowIndex: number) => Promise<any | Error>;
+    updateCellValue: (batchId: string, colIndex: number, rowIndex: number, value: string) => Promise<any | Error>;
+    prepareBatchForRender: (batchId: string) => Promise<any | Error>;
+    checkBatchExportStatus: (batchId: string) => Promise<any | Error>;
+    invokeBatchExportJob: (batchId: string) => Promise<any | Error>;
+    downloadBatchExport: (batchId: string, exportId: number) => Promise<any | Error>;
+    duplicateBatch: (batchId: string) => Promise<any | Error>;
+    deleteBatch: (batchId: string) => Promise<any | Error>;
+    updateModerationStatus: (experienceId: string, status: string, reason?: string) => Promise<any>;
+    addOrReplaceNote: (experienceId: string, notes: string) => Promise<any>;
+    getJob: (jobId: string) => Promise<any | Error>;
+    runCut: (storyId: string, actId: string, sceneId: string, cutId: string) => Promise<any | Error>;
+    runReRenderCuts: (storyId: string, actId: string, sceneId: string) => Promise<any | Error>;
+    runProcessBaseVideo: (storyId: string, fileKey: string) => Promise<any | Error>;
+    runPublish: (storyId: string, message: string) => Promise<any | Error>;
+    cancelPublish: (storyId: string) => Promise<any | Error>;
+    pollJob: (jobId: string) => Promise<any | Error>;
+    private pollForJob;
+    private pollForExperience;
+    cancelExperiencePolling(): Promise<void>;
+    cancelJobPolling(): Promise<void>;
+    getJobLogUrl: (jobId: string) => Promise<any | Error>;
+    getJobLog: (url: string) => Promise<any | Error>;
+    createExperience: (storyId: string, inventory?: any, compositionId?: string, useWorkingCopy?: boolean) => Promise<any | Error>;
+    deleteExperience: (experienceId: string, eraseMedia?: boolean) => Promise<any | Error>;
+    triggerEvent: (experienceId: string, compositionId?: string, useWorkingCopy?: boolean) => Promise<any | Error>;
+    getExperience: (experienceId: string, poll?: boolean) => Promise<any | Error>;
+    private experienceFormData;
+    getAccssCredentials: () => Promise<any | Error>;
+    createAccessCredentials: (name: string) => Promise<any | Error>;
+    deleteAccessCrednetials: (access_key_id: string) => Promise<any | Error>;
+    invokeBatchRenderJob: (batchId: string) => Promise<any | Error>;
+    cancelBatchRenderJob: (batchId: string) => Promise<any | Error>;
+    getUsers: (organizationId: string, page: number, itemsPerPage: number) => Promise<any | Error>;
+    addUser: (organizationId: string, email: string, roleId: number) => Promise<any | Error>;
+    resendInvite: (orgId: string, email: string) => Promise<any | Error>;
+    revokeInvite: (orgId: string, email: string) => Promise<any | Error>;
+    updateInviteRole: (orgId: string, email: string, role: number) => Promise<any | Error>;
+    updateRole: (organizationId: string, userId: string, roleId: number) => Promise<any | Error>;
+    deleteUser: (organizationId: string, userId: string) => Promise<any | Error>;
+    getPlayerMetrics: (storyId: string, start: number, end: number, alias?: string) => Promise<any>;
+    getSystemMetrics: (storyId: string, start: number, end: number, step: number, alias?: string) => Promise<any>;
+    getOrganizations: (page: number, itemsPerPage: number) => Promise<any[]>;
+    addOrganization: (orgName: string, defaultStory?: string) => Promise<any>;
+    updateOrgName: (orgId: string, orgName: string) => Promise<any>;
+    deleteOrg: (orgId: string) => any;
+    changeOrgPlan: (orgId: string, tier: number) => Promise<any>;
+    getAccountInfo: (orgId: string) => Promise<any>;
+    cancelOrgPlan: (orgId: string) => Promise<any>;
+    getNextBillingPeriod: (orgId: string) => Promise<any>;
+    getRedirectToBillingPortal: (orgId: string) => Promise<any>;
+    getRedirectToRenew: (orgId: string, tier: number) => Promise<any>;
+    getAPIUsageOverview: (startDate?: number, endDate?: number) => Promise<any>;
+    getUsageGraph: (metric: string, startDate: number, endDate: number) => Promise<any>;
+    getBillingPeriods: () => any;
+}