@bytescale/sdk 1.0.0-alpha.1

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

@@ -0,0 +1,135 @@
+/**
+ * @bytescale/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.
+     */
+    private copyFileWithHttpInfo;
+    /**
+     * Copies a file synchronously.
+     */
+    copyFile(requestParameters: CopyFileOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CopyFileResponse>;
+    /**
+     * Copies multiple files asynchronously.
+     */
+    private copyFileBatchWithHttpInfo;
+    /**
+     * Copies multiple files asynchronously.
+     */
+    copyFileBatch(requestParameters: CopyFileBatchOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsyncResponse>;
+    /**
+     * Deletes a file synchronously.
+     */
+    private deleteFileWithHttpInfo;
+    /**
+     * Deletes a file synchronously.
+     */
+    deleteFile(requestParameters: DeleteFileParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes multiple files asynchronously.
+     */
+    private deleteFileBatchWithHttpInfo;
+    /**
+     * Deletes multiple files asynchronously.
+     */
+    deleteFileBatch(requestParameters: DeleteFileBatchOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsyncResponse>;
+    /**
+     * Downloads a file in its original/unprocessed state.
+     */
+    private downloadFileWithHttpInfo;
+    /**
+     * Downloads a file in its original/unprocessed state.
+     */
+    downloadFile(requestParameters: DownloadFileParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.BinaryResult>;
+    /**
+     * Gets the full details (e.g. metadata, tags, etc.) for a file.
+     */
+    private getFileDetailsWithHttpInfo;
+    /**
+     * Gets the full details (e.g. metadata, tags, etc.) for a file.
+     */
+    getFileDetails(requestParameters: GetFileDetailsParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileDetails>;
+    /**
+     * Processes a file and returns the result.
+     */
+    private processFileWithHttpInfo;
+    /**
+     * Processes a file and returns the result.
+     */
+    processFile(requestParameters: ProcessFileParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.BinaryResult>;
+    /**
+     * Processes a file and saves the result.
+     */
+    private processFileAndSaveWithHttpInfo;
+    /**
+     * Processes a file and saves the result.
+     */
+    processFileAndSave(requestParameters: ProcessFileAndSaveOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessFileAndSaveResponse>;
+}
+/**
+ * @export
+ */
+export declare const ProcessFileCachePermEnum: {
+    readonly Auto: "auto";
+    readonly False: "false";
+    readonly True: "true";
+};
+export declare type ProcessFileCachePermEnum = typeof ProcessFileCachePermEnum[keyof typeof ProcessFileCachePermEnum];

package/dist/types/gen/apis/FolderApi.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @bytescale/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, CopyFolderBatchRequest, CopyFolderRequest, DeleteFolderBatchRequest, DeleteFolderRequest, FolderDetails, ListFolderResponse, PutFolderRequest } from "../models";
+export interface CopyFolderOperationParams {
+    accountId: string;
+    copyFolderRequest: CopyFolderRequest;
+}
+export interface CopyFolderBatchOperationParams {
+    accountId: string;
+    copyFolderBatchRequest: CopyFolderBatchRequest;
+}
+export interface DeleteFolderOperationParams {
+    accountId: string;
+    deleteFolderRequest: DeleteFolderRequest;
+}
+export interface DeleteFolderBatchOperationParams {
+    accountId: string;
+    deleteFolderBatchRequest: DeleteFolderBatchRequest;
+}
+export interface GetFolderDetailsParams {
+    accountId: string;
+    folderPath: string;
+}
+export interface ListFolderParams {
+    accountId: string;
+    folderPath: string;
+    cursor?: string;
+    dryRun?: boolean;
+    includeFiles?: boolean;
+    includeOverriddenStorage?: boolean;
+    includePhysicalFolders?: boolean;
+    includeVirtualFolders?: boolean;
+    limit?: number;
+    recursive?: boolean;
+}
+export interface PutFolderOperationParams {
+    accountId: string;
+    putFolderRequest: PutFolderRequest;
+}
+/**
+ *
+ */
+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;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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>;
+}

package/dist/types/gen/apis/JobApi.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @bytescale/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 { AccountJobType, JobSummary, ListRecentJobsResponse } from "../models";
+export interface CancelJobParams {
+    accountId: string;
+    jobId: string;
+    jobType: AccountJobType;
+}
+export interface GetJobParams {
+    accountId: string;
+    jobId: string;
+    jobType: AccountJobType;
+}
+export interface ListRecentJobsParams {
+    accountId: string;
+    jobType: Array<AccountJobType>;
+}
+/**
+ *
+ */
+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>;
+    /**
+     * 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;
+    /**
+     * Lists the most recently issued background jobs.  Requires a `secret_*` API key.
+     */
+    listRecentJobs(requestParameters: ListRecentJobsParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListRecentJobsResponse>;
+}

package/dist/types/gen/apis/UploadApi.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @bytescale/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 { BasicUploadResponse, BeginMultipartUploadRequest, BeginMultipartUploadResponse, CompleteUploadPartRequest, UploadFromUrlRequest, UploadPart, UploadPartList } from "../models";
+export interface BeginMultipartUploadOperationParams {
+    accountId: string;
+    beginMultipartUploadRequest: BeginMultipartUploadRequest;
+}
+export interface CompleteUploadPartOperationParams {
+    accountId: string;
+    uploadId: string;
+    uploadPartIndex: number;
+    completeUploadPartRequest: CompleteUploadPartRequest;
+}
+export interface GetUploadPartParams {
+    accountId: string;
+    uploadId: string;
+    uploadPartIndex: number;
+}
+export interface ListUploadPartsParams {
+    accountId: string;
+    uploadId: string;
+}
+export interface UploadFromUrlOperationParams {
+    accountId: string;
+    uploadFromUrlRequest: UploadFromUrlRequest;
+}
+/**
+ *
+ */
+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;
+    /**
+     * 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>;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Upload from a URL with a single HTTP request:
+     */
+    uploadFromUrl(requestParameters: UploadFromUrlOperationParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BasicUploadResponse>;
+}

package/dist/types/gen/apis/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./FileApi";
+export * from "./FolderApi";
+export * from "./JobApi";
+export * from "./UploadApi";

package/dist/types/gen/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./runtime";
+export * from "./apis";
+export * from "./models";