@bytescale/sdk 1.0.0-alpha.2 → 1.0.0-alpha.3

package/dist/types/generated/apis/FileApi.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @bytescale/api
+ * Bytescale API
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: hello@bytescale.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from "../runtime";
+import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse } from "../models";
+export interface CopyFileOperationParams {
+    accountId: string;
+    copyFileRequest: CopyFileRequest;
+}
+export interface CopyFileBatchOperationParams {
+    accountId: string;
+    copyFileBatchRequest: CopyFileBatchRequest;
+}
+export interface DeleteFileParams {
+    accountId: string;
+    filePath: string;
+}
+export interface DeleteFileBatchOperationParams {
+    accountId: string;
+    deleteFileBatchRequest: DeleteFileBatchRequest;
+}
+export interface DownloadFileParams {
+    accountId: string;
+    filePath: string;
+    cache?: boolean;
+    cacheTtl?: number;
+    version?: string;
+}
+export interface GetFileDetailsParams {
+    accountId: string;
+    filePath: string;
+}
+export interface ProcessFileParams {
+    accountId: string;
+    filePath: string;
+    transformation: string;
+    artifact?: string;
+    cache?: boolean;
+    cachePerm?: ProcessFileCachePermEnum;
+    cacheTtl?: number;
+    large?: boolean;
+    version?: string;
+}
+export interface ProcessFileAndSaveOperationParams {
+    accountId: string;
+    filePath: string;
+    transformation: string;
+    processFileAndSaveRequest: ProcessFileAndSaveRequest;
+}
+/**
+ *
+ */
+export declare class FileApi extends runtime.BaseAPI {
+    /**
+     * Copies a file synchronously.
+     */
+    copyFile(params: CopyFileOperationParams): Promise<CopyFileResponse>;
+    /**
+     * Copies multiple files asynchronously.
+     */
+    copyFileBatch(params: CopyFileBatchOperationParams): Promise<AsyncResponse>;
+    /**
+     * Deletes a file synchronously.
+     */
+    deleteFile(params: DeleteFileParams): Promise<void>;
+    /**
+     * Deletes multiple files asynchronously.
+     */
+    deleteFileBatch(params: DeleteFileBatchOperationParams): Promise<AsyncResponse>;
+    /**
+     * Downloads a file in its original/unprocessed state.
+     */
+    downloadFile(params: DownloadFileParams): Promise<runtime.BinaryResult>;
+    /**
+     * Gets the full details (e.g. metadata, tags, etc.) for a file.
+     */
+    getFileDetails(params: GetFileDetailsParams): Promise<FileDetails>;
+    /**
+     * Processes a file and returns the result.
+     */
+    processFile(params: ProcessFileParams): Promise<runtime.BinaryResult>;
+    /**
+     * Processes a file and saves the result.
+     */
+    processFileAndSave(params: ProcessFileAndSaveOperationParams): Promise<ProcessFileAndSaveResponse>;
+}
+/**
+ * @export
+ */
+export declare type ProcessFileCachePermEnum = "auto" | "false" | "true";

package/dist/types/{gen → generated}/apis/FolderApi.d.ts

@@ -1,5 +1,5 @@
 /**
- * @bytescale/bytescale-api
+ * @bytescale/api
  * Bytescale API
  *
  * The version of the OpenAPI document: 2.0.0
@@ -54,57 +54,29 @@ export declare class FolderApi extends runtime.BaseAPI {
     /**
      * Copies a folder asynchronously.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
      */
-    private copyFolderWithHttpInfo;
-    /**
-     * Copies a folder asynchronously.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
-     */
-    copyFolder(requestParameters: CopyFolderOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsyncResponse>;
-    /**
-     * Copies multiple folders asynchronously.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
-     */
-    private copyFolderBatchWithHttpInfo;
+    copyFolder(params: CopyFolderOperationParams): Promise<AsyncResponse>;
     /**
      * Copies multiple folders asynchronously.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
      */
-    copyFolderBatch(requestParameters: CopyFolderBatchOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsyncResponse>;
+    copyFolderBatch(params: CopyFolderBatchOperationParams): Promise<AsyncResponse>;
     /**
      * Deletes a folder asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
      */
-    private deleteFolderWithHttpInfo;
-    /**
-     * Deletes a folder asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
-     */
-    deleteFolder(requestParameters: DeleteFolderOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsyncResponse>;
+    deleteFolder(params: DeleteFolderOperationParams): Promise<AsyncResponse>;
     /**
      * Deletes multiple folders asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
      */
-    private deleteFolderBatchWithHttpInfo;
-    /**
-     * Deletes multiple folders asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
-     */
-    deleteFolderBatch(requestParameters: DeleteFolderBatchOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsyncResponse>;
+    deleteFolderBatch(params: DeleteFolderBatchOperationParams): Promise<AsyncResponse>;
     /**
      * Gets the full details (e.g. permission, storage layer, etc.) for a folder.  Returns an empty object if no settings have been configured for this folder.
      */
-    private getFolderDetailsWithHttpInfo;
-    /**
-     * Gets the full details (e.g. permission, storage layer, etc.) for a folder.  Returns an empty object if no settings have been configured for this folder.
-     */
-    getFolderDetails(requestParameters: GetFolderDetailsParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderDetails>;
-    /**
-     * Lists the folder\'s contents.  The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter.  Pagination is complete when the response includes `isPaginationComplete=true`.
-     */
-    private listFolderWithHttpInfo;
+    getFolderDetails(params: GetFolderDetailsParams): Promise<FolderDetails>;
     /**
      * Lists the folder\'s contents.  The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter.  Pagination is complete when the response includes `isPaginationComplete=true`.
      */
-    listFolder(requestParameters: ListFolderParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFolderResponse>;
-    /**
-     * Creates or updates the folder specified by the `folderPath`.  If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings).  Note: you don\'t need to create folders before uploading files to them.
-     */
-    private putFolderWithHttpInfo;
+    listFolder(params: ListFolderParams): Promise<ListFolderResponse>;
     /**
      * Creates or updates the folder specified by the `folderPath`.  If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings).  Note: you don\'t need to create folders before uploading files to them.
      */
-    putFolder(requestParameters: PutFolderOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderDetails>;
+    putFolder(params: PutFolderOperationParams): Promise<FolderDetails>;
 }

package/dist/types/{gen → generated}/apis/JobApi.d.ts

@@ -1,5 +1,5 @@
 /**
- * @bytescale/bytescale-api
+ * @bytescale/api
  * Bytescale API
  *
  * The version of the OpenAPI document: 2.0.0
@@ -32,25 +32,13 @@ export declare class JobApi extends runtime.BaseAPI {
     /**
      * Cancels an in-progress background job.  Requires a `secret_*` API key.
      */
-    private cancelJobWithHttpInfo;
-    /**
-     * Cancels an in-progress background job.  Requires a `secret_*` API key.
-     */
-    cancelJob(requestParameters: CancelJobParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    cancelJob(params: CancelJobParams): Promise<void>;
     /**
      * Gets information on a background job.  Requires a `secret_*` API key.
      */
-    private getJobWithHttpInfo;
-    /**
-     * Gets information on a background job.  Requires a `secret_*` API key.
-     */
-    getJob(requestParameters: GetJobParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobSummary>;
-    /**
-     * Lists the most recently issued background jobs.  Requires a `secret_*` API key.
-     */
-    private listRecentJobsWithHttpInfo;
+    getJob(params: GetJobParams): Promise<JobSummary>;
     /**
      * Lists the most recently issued background jobs.  Requires a `secret_*` API key.
      */
-    listRecentJobs(requestParameters: ListRecentJobsParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListRecentJobsResponse>;
+    listRecentJobs(params: ListRecentJobsParams): Promise<ListRecentJobsResponse>;
 }

package/dist/types/{gen → generated}/apis/UploadApi.d.ts

@@ -1,5 +1,5 @@
 /**
- * @bytescale/bytescale-api
+ * @bytescale/api
  * Bytescale API
  *
  * The version of the OpenAPI document: 2.0.0
@@ -41,41 +41,21 @@ export declare class UploadApi extends runtime.BaseAPI {
     /**
      * Begins a new multipart file upload process.
      */
-    private beginMultipartUploadWithHttpInfo;
-    /**
-     * Begins a new multipart file upload process.
-     */
-    beginMultipartUpload(requestParameters: BeginMultipartUploadOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BeginMultipartUploadResponse>;
-    /**
-     * Marks an upload part as uploaded.  You must call this endpoint after you have successfully issued a `PUT` request to the `uploadUrl` on the corresponding UploadPart.
-     */
-    private completeUploadPartWithHttpInfo;
+    beginMultipartUpload(params: BeginMultipartUploadOperationParams): Promise<BeginMultipartUploadResponse>;
     /**
      * Marks an upload part as uploaded.  You must call this endpoint after you have successfully issued a `PUT` request to the `uploadUrl` on the corresponding UploadPart.
      */
-    completeUploadPart(requestParameters: CompleteUploadPartOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    completeUploadPart(params: CompleteUploadPartOperationParams): Promise<void>;
     /**
      * Gets a remaining upload part for a multipart file upload.
      */
-    private getUploadPartWithHttpInfo;
-    /**
-     * Gets a remaining upload part for a multipart file upload.
-     */
-    getUploadPart(requestParameters: GetUploadPartParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadPart>;
-    /**
-     * Lists the remaining upload parts for a multipart file upload.  An empty array is returned when the upload is complete.
-     */
-    private listUploadPartsWithHttpInfo;
+    getUploadPart(params: GetUploadPartParams): Promise<UploadPart>;
     /**
      * Lists the remaining upload parts for a multipart file upload.  An empty array is returned when the upload is complete.
      */
-    listUploadParts(requestParameters: ListUploadPartsParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadPartList>;
-    /**
-     * Upload from a URL with a single HTTP request:
-     */
-    private uploadFromUrlWithHttpInfo;
+    listUploadParts(params: ListUploadPartsParams): Promise<UploadPartList>;
     /**
      * Upload from a URL with a single HTTP request:
      */
-    uploadFromUrl(requestParameters: UploadFromUrlOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BasicUploadResponse>;
+    uploadFromUrl(params: UploadFromUrlOperationParams): Promise<BasicUploadResponse>;
 }