@bytescale/sdk 1.4.0 → 3.0.0-alpha.1

package/dist/types/public/shared/generated/models/index.d.ts

@@ -720,66 +720,11 @@ export interface FileDownloadGrants {
     downloadFile: Array<string>;
 }
 /**
+ * @type FilePathDefinition
  * The path to upload the file to.
  * @export
- * @interface FilePathDefinition
  */
-export interface FilePathDefinition {
-    /**
-     * The file name to upload the file with.
-     *
-     * Must not contain `/`.
-     *
-     * Supports path variables.
-     * @type {string}
-     * @memberof FilePathDefinition
-     */
-    fileName?: string;
-    /**
-     * The file name to upload the file with.
-     *
-     * Must not contain `/`.
-     *
-     * Supports path variables.
-     * @type {string}
-     * @memberof FilePathDefinition
-     */
-    fileNameFallback?: string;
-    /**
-     * If `true` then path variables like `{UTC_DATE}` in the `fileName` will be replaced. You can escape `{` characters with a `\`.
-     *
-     * If `false` then path variables like `{UTC_DATE}` in the `fileName` will be taken literally.
-     *
-     * Default: true
-     * @type {boolean}
-     * @memberof FilePathDefinition
-     */
-    fileNameVariablesEnabled?: boolean;
-    /**
-     * Absolute or relative path to a folder in your Bytescale account's storage.
-     *
-     * Relative paths are relative to the API key's default folder (configured per API key in the Bytescale Dashboard).
-     *
-     * Should not end with `/`.
-     *
-     * Does not support path traversals (e.g. `..`).
-     *
-     * Supports path variables.
-     * @type {string}
-     * @memberof FilePathDefinition
-     */
-    folderPath?: string;
-    /**
-     * If `true` then path variables like `{UTC_DATE}` in the `folderPath` will be replaced. You can escape `{` characters with a `\`.
-     *
-     * If `false` then path variables like `{UTC_DATE}` in the `folderPath` will be taken literally.
-     *
-     * Default: true
-     * @type {boolean}
-     * @memberof FilePathDefinition
-     */
-    folderPathVariablesEnabled?: boolean;
-}
+export declare type FilePathDefinition = DynamicFilePath | string;
 /**
  * Summary information about a file (a subset of the FileDetails type).
  * @export
@@ -1280,64 +1225,11 @@ export interface ListRecentJobsResponse {
  */
 export declare type MultipartUploadProtocol = "1.0" | "1.1";
 /**
+ * @type ObjectSummary
  * Summary information about a file or folder.
- * @export
- * @interface ObjectSummary
- */
-export interface ObjectSummary {
-    /**
-     * Absolute path to a folder. Begins with a `/`. Should not end with a `/`.
-     * @type {string}
-     * @memberof ObjectSummary
-     */
-    folderPath: string;
-    /**
-     *
-     * @type {FolderSettingsStorageLayerSummary}
-     * @memberof ObjectSummary
-     */
-    settings: FolderSettingsStorageLayerSummary;
-    /**
-     *
-     * @type {string}
-     * @memberof ObjectSummary
-     */
-    type: ObjectSummaryTypeEnum;
-    /**
-     *
-     * @type {boolean}
-     * @memberof ObjectSummary
-     */
-    virtual: boolean;
-    /**
-     * Absolute path to a file. Begins with a `/`.
-     * @type {string}
-     * @memberof ObjectSummary
-     */
-    filePath: string;
-    /**
-     * URL for a raw file hosted on the Bytescale CDN.
-     * @type {string}
-     * @memberof ObjectSummary
-     */
-    fileUrl: string;
-    /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
-     * @memberof ObjectSummary
-     */
-    lastModified: number;
-    /**
-     * Size in bytes.
-     * @type {number}
-     * @memberof ObjectSummary
-     */
-    size: number;
-}
-/**
  * @export
  */
-export declare type ObjectSummaryTypeEnum = "File";
+export declare type ObjectSummary = FileSummary | FolderSummary;
 /**
  * Specifies the folder settings to use when creating or updating a folder.
  * @export
@@ -1626,11 +1518,110 @@ export interface ProcessFileAndSaveRequest {
     tags?: CopyableFileDataFileTagNameArray;
 }
 /**
+ * @type ProcessFileAndSaveResponse
  * Response body for ProcessFileAndSave.
  * @export
- * @interface ProcessFileAndSaveResponse
  */
-export interface ProcessFileAndSaveResponse {
+export declare type ProcessFileAndSaveResponse = ProcessFileAndSaveResponseAsync | ProcessFileAndSaveResponseSync;
+/**
+ * Response body for ProcessFileAndSave operations where the File Processing API operation is an asynchronous operation (e.g. a video transcoding job).
+ * @export
+ * @interface ProcessFileAndSaveResponseAsync
+ */
+export interface ProcessFileAndSaveResponseAsync {
+    /**
+     * Link to the documentation that describes how to get a job's status from its job ID.
+     * @type {string}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    jobDocs: ProcessFileAndSaveResponseAsyncJobDocsEnum;
+    /**
+     * Job ID.
+     * @type {string}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    jobId: string;
+    /**
+     *
+     * @type {AccountJobType}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    jobType: AccountJobType;
+    /**
+     * URL for the job's status.
+     *
+     * You can `GET` this URL to retrieve the job's status.
+     *
+     * You must authorize your `GET` request with a ```secret_*``` API key when accessing the URL.
+     * @type {string}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    jobUrl: string;
+    /**
+     * Your account ID.
+     *
+     * This is visible on the settings page:
+     *
+     * https://www.bytescale.com/dashboard/settings
+     * @type {string}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    accountId: string;
+    /**
+     * Epoch milliseconds (since midnight 1 January 1970, UTC).
+     * @type {number}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    created: number;
+    /**
+     *
+     * @type {JobSummaryError}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    error: JobSummaryError | null;
+    /**
+     * Epoch milliseconds (since midnight 1 January 1970, UTC).
+     * @type {number}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    lastUpdated: number;
+    /**
+     *
+     * @type {AccountJobStatus}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    status: AccountJobStatus;
+    /**
+     * An arbitrary JSON object.
+     * @type {{ [key: string]: any; }}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    summary: {
+        [key: string]: any;
+    };
+    /**
+     * True for asynchronous file processing operations (e.g. video transcoding).
+     *
+     * For asynchronous operations, the response body will contain information about the background job that's processing the file, which can then be polled via the GetJob operation.
+     * @type {boolean}
+     * @memberof ProcessFileAndSaveResponseAsync
+     */
+    async: ProcessFileAndSaveResponseAsyncAsyncEnum;
+}
+/**
+ * @export
+ */
+export declare type ProcessFileAndSaveResponseAsyncJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
+/**
+ * @export
+ */
+export declare type ProcessFileAndSaveResponseAsyncAsyncEnum = true;
+/**
+ * Response body for ProcessFileAndSave operations where the File Processing API operation is a synchronous operation (e.g. an image processing job).
+ * @export
+ * @interface ProcessFileAndSaveResponseSync
+ */
+export interface ProcessFileAndSaveResponseSync {
     /**
      * Your account ID.
      *
@@ -1638,36 +1629,46 @@ export interface ProcessFileAndSaveResponse {
      *
      * https://www.bytescale.com/dashboard/settings
      * @type {string}
-     * @memberof ProcessFileAndSaveResponse
+     * @memberof ProcessFileAndSaveResponseSync
      */
     accountId: string;
     /**
-     * The `filePath` of the transformed file.
+     * False for synchronous file processing operations (e.g. image processing).
      *
-     * Transformations that produce multiple files — like the Archive Processing API running in `extract` mode — save files under this path. The `basePath` itself references a "summary file" that contains relative links to the other files produced by the transformation.
+     * For synchronous operations, the response body will contain links to the transformed file.
+     * @type {boolean}
+     * @memberof ProcessFileAndSaveResponseSync
+     */
+    async: ProcessFileAndSaveResponseSyncAsyncEnum;
+    /**
+     * The `filePath` of the transformed file.
      *
-     * Asynchronous transformations — like the Video Processing API — save a "summary file" to the `basePath` immediately. The file contains a summary of the work being performed and its current status. The file is updated periodically until the transformation completes.
+     * If the transformation outputs multiple artifacts, then each artifact's path will be a child of this path.
      * @type {string}
-     * @memberof ProcessFileAndSaveResponse
+     * @memberof ProcessFileAndSaveResponseSync
      */
-    basePath: string;
+    filePath: string;
     /**
      * URL for an http(s) resource.
      * @type {string}
-     * @memberof ProcessFileAndSaveResponse
+     * @memberof ProcessFileAndSaveResponseSync
      */
-    baseUrl: string;
+    fileUrl: string;
     /**
      * JSON response returned by certain transformation APIs.
      *
      * Structure varies between transformation APIs (please consult the documentation of the individual transformation APIs).
      * @type {{ [key: string]: any; }}
-     * @memberof ProcessFileAndSaveResponse
+     * @memberof ProcessFileAndSaveResponseSync
      */
     summary?: {
         [key: string]: any;
     };
 }
+/**
+ * @export
+ */
+export declare type ProcessFileAndSaveResponseSyncAsyncEnum = false;
 /**
  * @type ProcessFileTransformationParamsParameterValue
  *
@@ -2022,222 +2023,27 @@ export interface SpecifiedFieldValueStorageLayerUpdateOrNullValue {
  */
 export declare type SpecifiedFieldValueStorageLayerUpdateOrNullValueTypeEnum = "GoogleStorage";
 /**
+ * @type StorageLayerSummary
  * Storage layer summary information, describing an existing folder's storage layer.
  *
  * This data type does not contain credentials.
  * @export
- * @interface StorageLayerSummary
  */
-export interface StorageLayerSummary {
-    /**
-     * The type of this storage layer.
-     * @type {string}
-     * @memberof StorageLayerSummary
-     */
-    type: StorageLayerSummaryTypeEnum;
-    /**
-     * Base URL to proxy requests to. Should contain a trailing `/`.
-     *
-     * If `baseUrl` is set to `null`, then this folder will behave as an open reverse proxy.
-     *
-     * *Example 1:* if the `baseUrl` is `null` and the folder you're configuring the storage layer on is:
-     *
-     * `https://upcdn.io/abc1234/raw/demo`
-     *
-     * Then you can issue requests such as:
-     *
-     * `https://upcdn.io/abc1234/raw/demo/https://images.unsplash.com/example.jpg`
-     *
-     * *Example 2:* if the `baseUrl` is:
-     *
-     * `https://images.unsplash.com/`
-     *
-     * And the folder you're configuring the storage layer on is:
-     *
-     * `https://upcdn.io/abc1234/raw/demo`
-     *
-     * Then you can issue requests such as:
-     *
-     * `https://upcdn.io/abc1234/raw/demo/test/example.jpg`
-     *
-     * Which will be routed to the URL:
-     *
-     * `https://images.unsplash.com/test/example.jpg`
-     * @type {string}
-     * @memberof StorageLayerSummary
-     */
-    baseUrl: string | null;
-    /**
-     *
-     * @type {PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket}
-     * @memberof StorageLayerSummary
-     */
-    bucket: PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket;
-    /**
-     * If `true` then writes Google Storage objects with full `filePath` as key, prefixed with the `objectKeyPrefix`.
-     *
-     * If `false` then writes Google Storage objects using a relative `filePath` in relation to folder's path, prefixed with the `objectKeyPrefix`.
-     * @type {boolean}
-     * @memberof StorageLayerSummary
-     */
-    useAbsolutePaths: boolean;
-    /**
-     * Enables S3 transfer acceleration, providing improved file upload speeds for larger files.
-     *
-     * Note: this setting must also be enabled on the S3 bucket.
-     * @type {boolean}
-     * @memberof StorageLayerSummary
-     */
-    useTransferAcceleration: boolean;
-    /**
-     * Cloudflare Account ID.
-     * @type {string}
-     * @memberof StorageLayerSummary
-     */
-    cloudflareAccountId: string;
-}
-/**
- * @export
- */
-export declare type StorageLayerSummaryTypeEnum = "GoogleStorage";
+export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
 /**
+ * @type StorageLayerUpdate
  * Data type used to update or create a folder's storage layer.
  *
  * This data type may contain credentials.
  * @export
- * @interface StorageLayerUpdate
  */
-export interface StorageLayerUpdate {
-    /**
-     * The type of this storage layer.
-     * @type {string}
-     * @memberof StorageLayerUpdate
-     */
-    type: StorageLayerUpdateTypeEnum;
-    /**
-     * Base URL to proxy requests to. Should contain a trailing `/`.
-     *
-     * If `baseUrl` is set to `null`, then this folder will behave as an open reverse proxy.
-     *
-     * *Example 1:* if the `baseUrl` is `null` and the folder you're configuring the storage layer on is:
-     *
-     * `https://upcdn.io/abc1234/raw/demo`
-     *
-     * Then you can issue requests such as:
-     *
-     * `https://upcdn.io/abc1234/raw/demo/https://images.unsplash.com/example.jpg`
-     *
-     * *Example 2:* if the `baseUrl` is:
-     *
-     * `https://images.unsplash.com/`
-     *
-     * And the folder you're configuring the storage layer on is:
-     *
-     * `https://upcdn.io/abc1234/raw/demo`
-     *
-     * Then you can issue requests such as:
-     *
-     * `https://upcdn.io/abc1234/raw/demo/test/example.jpg`
-     *
-     * Which will be routed to the URL:
-     *
-     * `https://images.unsplash.com/test/example.jpg`
-     * @type {string}
-     * @memberof StorageLayerUpdate
-     */
-    baseUrl: string | null;
-    /**
-     *
-     * @type {PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket}
-     * @memberof StorageLayerUpdate
-     */
-    bucket: PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket;
-    /**
-     *
-     * @type {GoogleStorageCredentials}
-     * @memberof StorageLayerUpdate
-     */
-    credentials: GoogleStorageCredentials;
-    /**
-     * If `true` then writes Google Storage objects with full `filePath` as key, prefixed with the `objectKeyPrefix`.
-     *
-     * If `false` then writes Google Storage objects using a relative `filePath` in relation to folder's path, prefixed with the `objectKeyPrefix`.
-     * @type {boolean}
-     * @memberof StorageLayerUpdate
-     */
-    useAbsolutePaths: boolean;
-    /**
-     * Enables S3 transfer acceleration, providing improved file upload speeds for larger files.
-     *
-     * Note: this setting must also be enabled on the S3 bucket.
-     * @type {boolean}
-     * @memberof StorageLayerUpdate
-     */
-    useTransferAcceleration: boolean;
-    /**
-     * Cloudflare Account ID.
-     * @type {string}
-     * @memberof StorageLayerUpdate
-     */
-    cloudflareAccountId: string;
-}
-/**
- * @export
- */
-export declare type StorageLayerUpdateTypeEnum = "GoogleStorage";
+export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
 /**
+ * @type TagCondition
  * Expresses a condition that matches files by their tags.
- * @export
- * @interface TagCondition
- */
-export interface TagCondition {
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagCondition
-     */
-    left: TagCondition;
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagCondition
-     */
-    right: TagCondition;
-    /**
-     *
-     * @type {string}
-     * @memberof TagCondition
-     */
-    type: TagConditionTypeEnum;
-    /**
-     * File tag scope, e.g. for a transformation definition, a CDN download access token, or an API key's tag whitelist.
-     * @type {string}
-     * @memberof TagCondition
-     */
-    equals: string;
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagCondition
-     */
-    condition: TagCondition;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof TagCondition
-     */
-    any: Array<string>;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof TagCondition
-     */
-    all: Array<string>;
-}
-/**
  * @export
  */
-export declare type TagConditionTypeEnum = "All";
+export declare type TagCondition = TagConditionAll | TagConditionAnd | TagConditionAny | TagConditionEquals | TagConditionNot | TagConditionOr;
 /**
  *
  * @export
@@ -2406,74 +2212,23 @@ export interface UnspecifiedFieldValue {
  */
 export declare type UnspecifiedFieldValueSetEnum = false;
 /**
+ * @type UpdatableFieldFolderDescriptionOrNull
  *
- * @export
- * @interface UpdatableFieldFolderDescriptionOrNull
- */
-export interface UpdatableFieldFolderDescriptionOrNull {
-    /**
-     * This field is always `true`.
-     * @type {boolean}
-     * @memberof UpdatableFieldFolderDescriptionOrNull
-     */
-    set: UpdatableFieldFolderDescriptionOrNullSetEnum;
-    /**
-     * The value to set into the field.
-     * @type {string}
-     * @memberof UpdatableFieldFolderDescriptionOrNull
-     */
-    value: string | null;
-}
-/**
  * @export
  */
-export declare type UpdatableFieldFolderDescriptionOrNullSetEnum = true;
+export declare type UpdatableFieldFolderDescriptionOrNull = SpecifiedFieldValueFolderDescriptionOrNull | UnspecifiedFieldValue;
 /**
+ * @type UpdatableFieldPublicPermissionsArrayOrNull
  *
- * @export
- * @interface UpdatableFieldPublicPermissionsArrayOrNull
- */
-export interface UpdatableFieldPublicPermissionsArrayOrNull {
-    /**
-     * This field is always `true`.
-     * @type {boolean}
-     * @memberof UpdatableFieldPublicPermissionsArrayOrNull
-     */
-    set: UpdatableFieldPublicPermissionsArrayOrNullSetEnum;
-    /**
-     * The value to set into the field.
-     * @type {Array<PublicPermissions>}
-     * @memberof UpdatableFieldPublicPermissionsArrayOrNull
-     */
-    value: Array<PublicPermissions> | null;
-}
-/**
  * @export
  */
-export declare type UpdatableFieldPublicPermissionsArrayOrNullSetEnum = true;
+export declare type UpdatableFieldPublicPermissionsArrayOrNull = SpecifiedFieldValuePublicPermissionsArrayOrNull | UnspecifiedFieldValue;
 /**
+ * @type UpdatableFieldStorageLayerUpdateOrNull
  *
- * @export
- * @interface UpdatableFieldStorageLayerUpdateOrNull
- */
-export interface UpdatableFieldStorageLayerUpdateOrNull {
-    /**
-     * This field is always `true`.
-     * @type {boolean}
-     * @memberof UpdatableFieldStorageLayerUpdateOrNull
-     */
-    set: UpdatableFieldStorageLayerUpdateOrNullSetEnum;
-    /**
-     *
-     * @type {SpecifiedFieldValueStorageLayerUpdateOrNullValue}
-     * @memberof UpdatableFieldStorageLayerUpdateOrNull
-     */
-    value: SpecifiedFieldValueStorageLayerUpdateOrNullValue | null;
-}
-/**
  * @export
  */
-export declare type UpdatableFieldStorageLayerUpdateOrNullSetEnum = true;
+export declare type UpdatableFieldStorageLayerUpdateOrNull = SpecifiedFieldValueStorageLayerUpdateOrNull | UnspecifiedFieldValue;
 /**
  * Request body for UploadFromUrl.
  * @export

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "1.4.0",
+  "version": "3.0.0-alpha.1",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",