@bytescale/sdk 3.34.0 → 3.36.0

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

@@ -2,12 +2,12 @@
  *
  * @export
  */
-export declare type AccountJobStatus = "Created" | "Pending" | "Running" | "Rollback" | "Failed" | "Succeeded" | "Cancelling" | "Cancelled";
+export type AccountJobStatus = "Created" | "Pending" | "Running" | "Rollback" | "Failed" | "Succeeded" | "Cancelling" | "Cancelled";
 /**
  * Job type.
  * @export
  */
-export declare type AccountJobType = "ProcessImageJob" | "ProcessVideoJob" | "ProcessAudioJob" | "AntivirusJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
+export type AccountJobType = "ProcessImageJob" | "ProcessVideoJob" | "ProcessAudioJob" | "AntivirusJob" | "ResetCacheJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
 /**
  * Response body from an API endpoint that performs work asynchronously (i.e. does not complete the work immediately).
  * @export
@@ -46,12 +46,12 @@ export interface AsyncResponse {
 /**
  * @export
  */
-export declare type AsyncResponseJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
+export type AsyncResponseJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
 /**
  * AWS Region.
  * @export
  */
-export declare type AwsRegion = "us-east-2" | "us-east-1" | "us-west-1" | "us-west-2" | "af-south-1" | "ap-east-1" | "ap-south-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-south-1" | "ap-northeast-3" | "ap-northeast-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-northeast-1" | "ca-central-1" | "ca-west-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-south-1" | "eu-west-3" | "eu-south-2" | "eu-north-1" | "eu-central-2" | "il-central-1" | "me-south-1" | "me-central-1" | "sa-east-1";
+export type AwsRegion = "us-east-2" | "us-east-1" | "us-west-1" | "us-west-2" | "af-south-1" | "ap-east-1" | "ap-south-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-south-1" | "ap-northeast-3" | "ap-northeast-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-northeast-1" | "ca-central-1" | "ca-west-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-south-1" | "eu-west-3" | "eu-south-2" | "eu-north-1" | "eu-central-2" | "il-central-1" | "me-south-1" | "me-central-1" | "sa-east-1";
 /**
  * Response body for BasicUpload.
  * @export
@@ -68,6 +68,12 @@ export interface BasicUploadResponse {
      * @memberof BasicUploadResponse
      */
     accountId: string;
+    /**
+     * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
+     * @type {string}
+     * @memberof BasicUploadResponse
+     */
+    etag: string;
     /**
      * Absolute path to a file. Begins with a `/`.
      * @type {string}
@@ -180,6 +186,52 @@ export interface BeginMultipartUploadResponseUploadParts {
      */
     count: number;
 }
+/**
+ * @type CompleteMultipartUploadResponse
+ * Response body for CompleteUploadPart.
+ * @export
+ */
+export type CompleteMultipartUploadResponse = CompleteMultipartUploadResponseCompleted | CompleteMultipartUploadResponsePending;
+/**
+ * Response body for CompleteUploadPart when the final upload part is marked as completed.
+ * @export
+ * @interface CompleteMultipartUploadResponseCompleted
+ */
+export interface CompleteMultipartUploadResponseCompleted {
+    /**
+     * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
+     * @type {string}
+     * @memberof CompleteMultipartUploadResponseCompleted
+     */
+    etag: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompleteMultipartUploadResponseCompleted
+     */
+    status: CompleteMultipartUploadResponseCompletedStatusEnum;
+}
+/**
+ * @export
+ */
+export type CompleteMultipartUploadResponseCompletedStatusEnum = "Completed";
+/**
+ * Response body for CompleteUploadPart when additional upload parts still need to be marked as completed.
+ * @export
+ * @interface CompleteMultipartUploadResponsePending
+ */
+export interface CompleteMultipartUploadResponsePending {
+    /**
+     *
+     * @type {string}
+     * @memberof CompleteMultipartUploadResponsePending
+     */
+    status: CompleteMultipartUploadResponsePendingStatusEnum;
+}
+/**
+ * @export
+ */
+export type CompleteMultipartUploadResponsePendingStatusEnum = "Pending";
 /**
  * Request body for CompleteUploadPart.
  * @export
@@ -187,7 +239,7 @@ export interface BeginMultipartUploadResponseUploadParts {
  */
 export interface CompleteUploadPartRequest {
     /**
-     * The file's ETag. An ETag (or entity tag) is an identifier for a specific version of a file.
+     * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
      * @type {string}
      * @memberof CompleteUploadPartRequest
      */
@@ -291,7 +343,7 @@ export interface CopyFolderRequest {
      */
     copyOverriddenStorage?: boolean;
     /**
-     * If `true` then copies virtual folder settings at the current path and below, else only files will be copied.
+     * If `true` then copies virtual folders at the current path and below, else only files will be copied.
      *
      * Virtual folders are folders that have been created using the PutFolder operation.
      *
@@ -315,9 +367,9 @@ export interface CopyFolderRequest {
      */
     metadata?: CopyableFileDataFileMetadata;
     /**
-     * If `true` then copies files and virtual folders that are descendants of the `source` folder.
+     * If `true` then copies files and folders that are descendants of the `source` folder.
      *
-     * If `false` then only copies files that are direct children of the `source` folder, and does not copy descendant virtual folders (children or otherwise).
+     * If `false` then only copies files that are direct children of the `source` folder, and does not copy descendant folders (children or otherwise).
      *
      * Default: true
      * @type {boolean}
@@ -560,7 +612,7 @@ export interface DigitalOceanStorage {
 /**
  * @export
  */
-export declare type DigitalOceanStorageTypeEnum = "DigitalOceanSpace";
+export type DigitalOceanStorageTypeEnum = "DigitalOceanSpace";
 /**
  *
  * @export
@@ -691,7 +743,7 @@ export interface ErrorResponseError {
  *
  * @export
  */
-export declare type FileCopyStatusCopied = "Copied";
+export type FileCopyStatusCopied = "Copied";
 /**
  * Contains full information about a file, including its file metadata, file tags, original file name, and MIME type.
  * @export
@@ -795,7 +847,7 @@ export interface FileDownloadGrants {
  * The path to upload the file to.
  * @export
  */
-export declare type FilePathDefinition = DynamicFilePath | string;
+export type FilePathDefinition = DynamicFilePath | string;
 /**
  * Summary information about a file (a subset of the FileDetails type).
  * @export
@@ -836,7 +888,7 @@ export interface FileSummary {
 /**
  * @export
  */
-export declare type FileSummaryTypeEnum = "File";
+export type FileSummaryTypeEnum = "File";
 /**
  *
  * @export
@@ -879,7 +931,7 @@ export interface FolderDetails {
 /**
  * @export
  */
-export declare type FolderDetailsTypeEnum = "Folder";
+export type FolderDetailsTypeEnum = "Folder";
 /**
  * The FolderSettings inherited by the current path.
  *
@@ -966,7 +1018,7 @@ export interface FolderSummary {
 /**
  * @export
  */
-export declare type FolderSummaryTypeEnum = "Folder";
+export type FolderSummaryTypeEnum = "Folder";
 /**
  * Storage layer used for storing files in Google Storage, as opposed to Bytescale's built-in storage.
  *
@@ -1005,7 +1057,7 @@ export interface GoogleStorage {
 /**
  * @export
  */
-export declare type GoogleStorageTypeEnum = "GoogleStorage";
+export type GoogleStorageTypeEnum = "GoogleStorage";
 /**
  *
  * @export
@@ -1043,7 +1095,7 @@ export interface InternalStorageV1 {
 /**
  * @export
  */
-export declare type InternalStorageV1TypeEnum = "InternalStorageV1";
+export type InternalStorageV1TypeEnum = "InternalStorageV1";
 /**
  * Default storage layer used for files uploaded via the Bytescale API V2 (latest version).
  *
@@ -1068,7 +1120,7 @@ export interface InternalStorageV2 {
 /**
  * @export
  */
-export declare type InternalStorageV2TypeEnum = "InternalStorageV2";
+export type InternalStorageV2TypeEnum = "InternalStorageV2";
 /**
  * Summary information about an asynchronous background job (for example, a folder deletion).
  * @export
@@ -1149,7 +1201,7 @@ export interface JobSummary {
 /**
  * @export
  */
-export declare type JobSummaryJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
+export type JobSummaryJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
 /**
  *
  * @export
@@ -1227,13 +1279,13 @@ export interface ListRecentJobsResponse {
  * - `1.1`: this protocol version uses multipart uploads for all files. When this protocol is used, files only exist after the last CompleteUploadPart request is made. This protocol simplifies client code, and fixes a known issue in the `2.0` protocol for file TTLs (described above).
  * @export
  */
-export declare type MultipartUploadProtocol = "1.0" | "1.1";
+export type MultipartUploadProtocol = "1.0" | "1.1";
 /**
  * @type ObjectSummary
  * Summary information about a file or folder.
  * @export
  */
-export declare type ObjectSummary = FileSummary | FolderSummary;
+export type ObjectSummary = FileSummary | FolderSummary;
 /**
  * Specifies the folder settings to use when creating or updating a folder.
  * @export
@@ -1269,7 +1321,7 @@ export interface PatchFolderSettings {
  * - `"Grandchildren+"`: Permissions apply to the grandchildren (files and folders) of this path and their descendants only.
  * @export
  */
-export declare type PathPermissionScope = "Children" | "Grandchildren+" | "This";
+export type PathPermissionScope = "Children" | "Grandchildren+" | "This";
 /**
  * From T, pick a set of properties whose keys are in the union K
  * @export
@@ -1300,7 +1352,7 @@ export interface PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentia
 /**
  * @export
  */
-export declare type PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsTypeEnum = "DigitalOceanSpace";
+export type PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsTypeEnum = "DigitalOceanSpace";
 /**
  *
  * @export
@@ -1356,7 +1408,7 @@ export interface PickGoogleStorageExcludeKeyofGoogleStorageCredentials {
 /**
  * @export
  */
-export declare type PickGoogleStorageExcludeKeyofGoogleStorageCredentialsTypeEnum = "GoogleStorage";
+export type PickGoogleStorageExcludeKeyofGoogleStorageCredentialsTypeEnum = "GoogleStorage";
 /**
  *
  * @export
@@ -1412,7 +1464,7 @@ export interface PickR2StorageExcludeKeyofR2StorageCredentials {
 /**
  * @export
  */
-export declare type PickR2StorageExcludeKeyofR2StorageCredentialsTypeEnum = "R2";
+export type PickR2StorageExcludeKeyofR2StorageCredentialsTypeEnum = "R2";
 /**
  *
  * @export
@@ -1470,7 +1522,7 @@ export interface PickS3StorageExcludeKeyofS3StorageCredentials {
 /**
  * @export
  */
-export declare type PickS3StorageExcludeKeyofS3StorageCredentialsTypeEnum = "S3";
+export type PickS3StorageExcludeKeyofS3StorageCredentialsTypeEnum = "S3";
 /**
  *
  * @export
@@ -1532,7 +1584,7 @@ export interface ProcessFileAndSaveRequest {
  * Response body for ProcessFileAndSave.
  * @export
  */
-export declare type ProcessFileAndSaveResponse = ProcessFileAndSaveResponseAsync | ProcessFileAndSaveResponseSync;
+export type ProcessFileAndSaveResponse = ProcessFileAndSaveResponseAsync | ProcessFileAndSaveResponseSync;
 /**
  * Response body for ProcessFileAndSave operations where the File Processing API operation is asynchronous (e.g. a video transcoding job).
  * @export
@@ -1621,11 +1673,11 @@ export interface ProcessFileAndSaveResponseAsync {
 /**
  * @export
  */
-export declare type ProcessFileAndSaveResponseAsyncJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
+export type ProcessFileAndSaveResponseAsyncJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
 /**
  * @export
  */
-export declare type ProcessFileAndSaveResponseAsyncAsyncEnum = true;
+export type ProcessFileAndSaveResponseAsyncAsyncEnum = true;
 /**
  * Response body for ProcessFileAndSave operations where the File Processing API operation is synchronous (e.g. an image processing job).
  * @export
@@ -1676,7 +1728,7 @@ export interface ProcessFileAndSaveResponseSync {
 /**
  * @export
  */
-export declare type ProcessFileAndSaveResponseSyncAsyncEnum = false;
+export type ProcessFileAndSaveResponseSyncAsyncEnum = false;
 /**
  * Permissions applied to anonymous users who attempt to download files from a folder.
  *
@@ -1786,7 +1838,7 @@ export interface R2Storage {
 /**
  * @export
  */
-export declare type R2StorageTypeEnum = "R2";
+export type R2StorageTypeEnum = "R2";
 /**
  *
  * @export
@@ -1806,6 +1858,50 @@ export interface R2StorageCredentials {
      */
     r2AccessKey: string;
 }
+/**
+ * Request body for ResetCache.
+ *
+ * You can choose to reset the edge cache, or permanent cache, or both caches.
+ *
+ * *Warning:* Resetting the permanent cache (by setting ```resetPermanentCache: true```) may lead to a significant increase in processing time if numerous file transformations need to be re-performed upon their next request.
+ *
+ * *Recommended:* Prevent cache resets by adding a ```?v=<etag>``` querystring parameter to your URLs. This ensures your URLs change when your files change, eliminating the need for cache resets. The `etag` field is returned by GetFileDetails and all upload operations.
+ *
+ * *Example patterns:*
+ *
+ * - ```"/*"```
+ * - ```"/raw/example.jpg"```
+ * - ```"/image/example.jpg"```
+ * - ```"/image/customers/abc/*"```
+ *
+ * You may only use ```*``` at the end of the pattern. You must not include your account ID prefix in the pattern.
+ * @export
+ * @interface ResetCacheRequest
+ */
+export interface ResetCacheRequest {
+    /**
+     * The URL pattern to reset the cache for, excluding the account ID, but including the delivery method prefix (e.g. "raw", "image", etc.).
+     *
+     * May end with a `*` to indicate that all files with this prefix are to be removed from the cache.
+     *
+     * Specify `/*` to reset your entire cache.
+     * @type {string}
+     * @memberof ResetCacheRequest
+     */
+    pattern: string;
+    /**
+     * If `true` then resets the edge cache for the location(s) specified by `pattern`.
+     * @type {boolean}
+     * @memberof ResetCacheRequest
+     */
+    resetEdgeCache: boolean;
+    /**
+     * If `true` then resets the permanent cache for the location(s) specified by `pattern`.
+     * @type {boolean}
+     * @memberof ResetCacheRequest
+     */
+    resetPermanentCache: boolean;
+}
 /**
  * Storage layer used for storing files in custom S3 buckets, as opposed to Bytescale's built-in storage.
  *
@@ -1852,7 +1948,7 @@ export interface S3Storage {
 /**
  * @export
  */
-export declare type S3StorageTypeEnum = "S3";
+export type S3StorageTypeEnum = "S3";
 /**
  *
  * @export
@@ -1894,7 +1990,7 @@ export interface SpecifiedFieldValueEmptiableFolderDescription {
 /**
  * @export
  */
-export declare type SpecifiedFieldValueEmptiableFolderDescriptionSetEnum = true;
+export type SpecifiedFieldValueEmptiableFolderDescriptionSetEnum = true;
 /**
  * This data type specifies the field must be updated.
  * @export
@@ -1917,7 +2013,7 @@ export interface SpecifiedFieldValueEmptiablePublicPermissionsArray {
 /**
  * @export
  */
-export declare type SpecifiedFieldValueEmptiablePublicPermissionsArraySetEnum = true;
+export type SpecifiedFieldValueEmptiablePublicPermissionsArraySetEnum = true;
 /**
  * This data type specifies the field must be updated.
  * @export
@@ -1940,7 +2036,7 @@ export interface SpecifiedFieldValueEmptiableStorageLayerUpdate {
 /**
  * @export
  */
-export declare type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true;
+export type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true;
 /**
  * @type StorageLayerSummary
  * Storage layer summary information, describing an existing folder's storage layer.
@@ -1948,7 +2044,7 @@ export declare type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true
  * This data type does not contain credentials.
  * @export
  */
-export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
+export type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
 /**
  * @type StorageLayerUpdate
  * Data type used to update or create a folder's storage layer.
@@ -1956,7 +2052,7 @@ export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2
  * This data type may contain credentials.
  * @export
  */
-export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
+export type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
 /**
  * @type TransformationParamValue
  * A single transformation parameter provided to a Bytescale File Processing API.
@@ -1964,7 +2060,7 @@ export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | I
  * See TransformationParams for more information.
  * @export
  */
-export declare type TransformationParamValue = boolean | number | string;
+export type TransformationParamValue = boolean | number | string;
 /**
  * @type TransformationParams
  * Transformation parameters provided to a Bytescale File Processing API.
@@ -1996,7 +2092,7 @@ export declare type TransformationParamValue = boolean | number | string;
  * The `extendedParams` field supports up to 400KB of transformation parameter data.
  * @export
  */
-export declare type TransformationParams = Array<{
+export type TransformationParams = Array<{
     [key: string]: TransformationParamValue;
 }> | {
     [key: string]: TransformationParamValue;
@@ -2017,25 +2113,25 @@ export interface UnspecifiedFieldValue {
 /**
  * @export
  */
-export declare type UnspecifiedFieldValueSetEnum = false;
+export type UnspecifiedFieldValueSetEnum = false;
 /**
  * @type UpdatableFieldEmptiableFolderDescription
  *
  * @export
  */
-export declare type UpdatableFieldEmptiableFolderDescription = SpecifiedFieldValueEmptiableFolderDescription | UnspecifiedFieldValue;
+export type UpdatableFieldEmptiableFolderDescription = SpecifiedFieldValueEmptiableFolderDescription | UnspecifiedFieldValue;
 /**
  * @type UpdatableFieldEmptiablePublicPermissionsArray
  *
  * @export
  */
-export declare type UpdatableFieldEmptiablePublicPermissionsArray = SpecifiedFieldValueEmptiablePublicPermissionsArray | UnspecifiedFieldValue;
+export type UpdatableFieldEmptiablePublicPermissionsArray = SpecifiedFieldValueEmptiablePublicPermissionsArray | UnspecifiedFieldValue;
 /**
  * @type UpdatableFieldEmptiableStorageLayerUpdate
  *
  * @export
  */
-export declare type UpdatableFieldEmptiableStorageLayerUpdate = SpecifiedFieldValueEmptiableStorageLayerUpdate | UnspecifiedFieldValue;
+export type UpdatableFieldEmptiableStorageLayerUpdate = SpecifiedFieldValueEmptiableStorageLayerUpdate | UnspecifiedFieldValue;
 /**
  * Request body for UploadFromUrl.
  * @export
@@ -2187,7 +2283,7 @@ export interface WebStorage {
 /**
  * @export
  */
-export declare type WebStorageTypeEnum = "Web";
+export type WebStorageTypeEnum = "Web";
 /**
  *
  * @export

package/dist/types/public/shared/generated/runtime.d.ts

@@ -93,22 +93,22 @@ export declare class BytescaleApiError extends Error {
     readonly details: any | undefined;
     constructor(response: ErrorResponse);
 }
-export declare type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
-export declare type Json = any;
-export declare type HTTPMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
-export declare type HTTPHeaders = {
+export type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
+export type Json = any;
+export type HTTPMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+export type HTTPHeaders = {
     [key: string]: string;
 };
-export declare type HTTPQuery = {
+export type HTTPQuery = {
     [key: string]: string | number | null | boolean | HTTPQuery;
 };
-export declare type HTTPBody = Json | FormData | URLSearchParams;
-export declare type HTTPRequestInit = {
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
     headers?: HTTPHeaders;
     method: HTTPMethod;
     body?: HTTPBody;
 };
-export declare type InitOverrideFunction = (requestContext: {
+export type InitOverrideFunction = (requestContext: {
     init: HTTPRequestInit;
     context: RequestOpts;
 }) => Promise<RequestInit>;