@bytescale/sdk 3.34.0 → 3.35.0

package/dist/types/private/StreamUtils.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import type * as stream from "stream";
 export declare class StreamUtils {
     static create(): stream.Readable;

package/dist/types/private/UploadManagerBase.d.ts

@@ -1,9 +1,10 @@
-import { BytescaleApiClientConfig, FileDetails, UploadPart } from "../public/shared/generated";
+import { BytescaleApiClientConfig, UploadPart } from "../public/shared/generated";
 import { UploadManagerInterface } from "./model/UploadManagerInterface";
 import { PreUploadInfo } from "./model/PreUploadInfo";
 import { UploadSourceBlob } from "./model/UploadSourceProcessed";
 import { PutUploadPartResult } from "./model/PutUploadPartResult";
 import { AddCancellationHandler } from "./model/AddCancellationHandler";
+import { UploadResult } from "./model/UploadResult";
 import { UploadManagerParams, UploadSource } from "../public/shared/CommonTypes";
 /**
  * Methods common to UploadManagerNode and UploadManagerBrowser.
@@ -16,7 +17,7 @@ export declare abstract class UploadManagerBase<TSource, TInit> implements Uploa
     private readonly intervalMs;
     private readonly uploadApi;
     constructor(config: BytescaleApiClientConfig);
-    upload(request: UploadManagerParams): Promise<FileDetails>;
+    upload(request: UploadManagerParams): Promise<UploadResult>;
     protected getBlobInfo({ value: { name, size, type } }: UploadSourceBlob): Partial<PreUploadInfo> & {
         size: number;
     };

package/dist/types/private/UploadManagerBrowserWorkerBase.d.ts

@@ -3,7 +3,7 @@ import { UploadSourceProcessedBrowser, UploadSourceProcessedWorker } from "./mod
 import { PreUploadInfo } from "./model/PreUploadInfo";
 import { UploadPart } from "../public/shared/generated";
 import { UploadManagerParams, UploadSource } from "../public/shared/CommonTypes";
-declare type BrowserOrWorkerUploadSource = UploadSourceProcessedBrowser | UploadSourceProcessedWorker;
+type BrowserOrWorkerUploadSource = UploadSourceProcessedBrowser | UploadSourceProcessedWorker;
 /**
  * The "browser" and "worker" runtimes support the same input types, but the former uses XHR and the latter uses Fetch.
  */

package/dist/types/private/dtos/AuthSwConfigDto.d.ts

@@ -1,2 +1,2 @@
 import { AuthSwConfigEntryDto } from "./AuthSwConfigEntryDto";
-export declare type AuthSwConfigDto = AuthSwConfigEntryDto[];
+export type AuthSwConfigDto = AuthSwConfigEntryDto[];

package/dist/types/private/model/AddCancellationHandler.d.ts

@@ -1 +1 @@
-export declare type AddCancellationHandler = (cancellationHandler: () => void) => void;
+export type AddCancellationHandler = (cancellationHandler: () => void) => void;

package/dist/types/private/model/OnPartProgress.d.ts

@@ -1 +1 @@
-export declare type OnPartProgress = (bytesSentTotalForPart: number) => void;
+export type OnPartProgress = (bytesSentTotalForPart: number) => void;

package/dist/types/private/model/ServiceWorkerConfig.d.ts

@@ -1,4 +1,4 @@
-export declare type ServiceWorkerConfig = ServiceWorkerConfigUninitialized | ServiceWorkerConfigInitialized;
+export type ServiceWorkerConfig = ServiceWorkerConfigUninitialized | ServiceWorkerConfigInitialized;
 export interface ServiceWorkerConfigUninitialized {
     serviceWorkerScope: undefined;
     serviceWorkerScript: string;

package/dist/types/private/model/UploadResult.d.ts

@@ -0,0 +1,7 @@
+import { FileDetails } from "../../public/shared/generated";
+export type UploadResult = Omit<FileDetails, "etag"> & {
+    /**
+     * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
+     */
+    etag: string;
+};

package/dist/types/private/model/UploadSourceProcessed.d.ts

@@ -17,7 +17,7 @@ export interface UploadSourceStream {
     type: "Stream";
     value: NodeChunkedStream;
 }
-export declare type UploadSourceProcessedIsomorphic = UploadSourceBlob | UploadSourceArrayBuffer;
-export declare type UploadSourceProcessedBrowser = UploadSourceProcessedIsomorphic;
-export declare type UploadSourceProcessedWorker = UploadSourceProcessedIsomorphic;
-export declare type UploadSourceProcessedNode = UploadSourceStream | UploadSourceBuffer | UploadSourceProcessedIsomorphic;
+export type UploadSourceProcessedIsomorphic = UploadSourceBlob | UploadSourceArrayBuffer;
+export type UploadSourceProcessedBrowser = UploadSourceProcessedIsomorphic;
+export type UploadSourceProcessedWorker = UploadSourceProcessedIsomorphic;
+export type UploadSourceProcessedNode = UploadSourceStream | UploadSourceBuffer | UploadSourceProcessedIsomorphic;

package/dist/types/public/node/UploadManagerNode.d.ts

@@ -5,7 +5,7 @@ import { PreUploadInfo } from "../../private/model/PreUploadInfo";
 import { UploadPart } from "../shared/generated";
 import { AddCancellationHandler } from "../../private/model/AddCancellationHandler";
 import { UploadManagerParams, UploadSource } from "../shared/CommonTypes";
-declare type UploadManagerNodeInit = undefined | {
+type UploadManagerNodeInit = undefined | {
     chunkedStream: NodeChunkedStream;
     chunkedStreamPromise: Promise<void>;
 };

package/dist/types/public/shared/CommonTypes.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { BeginMultipartUploadRequest } from "./generated";
 /**
  * Workaround for tsc aliases, where we cannot export implementation-less modules in our dists.
@@ -18,7 +19,7 @@ export interface UploadProgress {
     bytesTotal: number;
     progress: number;
 }
-export declare type UploadSource = NodeJS.ReadableStream | BlobLike | Buffer | string;
+export type UploadSource = NodeJS.ReadableStream | BlobLike | Buffer | string;
 export interface UploadManagerParams extends Omit<BeginMultipartUploadRequest, "size" | "protocol"> {
     cancellationToken?: CancellationToken;
     data: UploadSource;

package/dist/types/public/shared/UrlBuilderTypes.d.ts

@@ -2,8 +2,8 @@
  * Workaround for tsc aliases, where we cannot export implementation-less modules in our dists.
  */
 export declare const UrlBuilderTypesNoOp = false;
-export declare type ParameterGroup = Record<string, string | number | boolean | undefined | null>;
-export declare type KeyValuePair = [string, string];
+export type ParameterGroup = Record<string, string | number | boolean | undefined | null>;
+export type KeyValuePair = [string, string];
 export interface UrlBuilderParams {
     /**
      * The account that manages the file.
@@ -20,9 +20,9 @@ export interface UrlBuilderParams {
      */
     options?: UrlBuilderOptions;
 }
-export declare type UrlBuilderOptions = UrlBuilderOptionsRaw | UrlBuilderTransformationOptions;
-export declare type UrlBuilderTransformationOptions = UrlBuilderTransformationApiOptions | UrlBuilderOptionsPreset;
-export declare type UrlBuilderTransformationApiOptions = UrlBuilderOptionsImage | UrlBuilderOptionsVideo | UrlBuilderOptionsAudio | UrlBuilderOptionsArchive;
+export type UrlBuilderOptions = UrlBuilderOptionsRaw | UrlBuilderTransformationOptions;
+export type UrlBuilderTransformationOptions = UrlBuilderTransformationApiOptions | UrlBuilderOptionsPreset;
+export type UrlBuilderTransformationApiOptions = UrlBuilderOptionsImage | UrlBuilderOptionsVideo | UrlBuilderOptionsAudio | UrlBuilderOptionsArchive;
 export interface UrlBuilderOptionsBase extends NonDeprecatedCommonQueryParams, DeprecatedCommonQueryParams {
     /**
      * The base URL of the Bytescale CDN. (Excludes trailing "/".)
@@ -131,7 +131,7 @@ export interface UrlBuilderOptionsTransformationApi<T> extends UrlBuilderOptions
      */
     transformationParams?: T | T[];
 }
-export declare type UrlBuilderOptionsTransformation = UrlBuilderOptionsTransformationOnly & UrlBuilderOptionsBase;
+export type UrlBuilderOptionsTransformation = UrlBuilderOptionsTransformationOnly & UrlBuilderOptionsBase;
 export interface UrlBuilderOptionsTransformationOnly {
     /**
      * The transformation artifact to download.

package/dist/types/public/shared/generated/apis/CacheApi.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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, ResetCacheRequest } from "../models";
+export interface ResetCacheOperationParams {
+    accountId: string;
+    resetCacheRequest: ResetCacheRequest;
+}
+export declare class CacheApi extends runtime.BaseAPI {
+    /**
+     * Resets the Bytescale CDN cache for a specific path, path prefix, or for your entire account.  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.
+     */
+    resetCache(params: ResetCacheOperationParams): Promise<AsyncResponse>;
+}

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

@@ -63,12 +63,6 @@ export interface ProcessFileParams {
      * The name of the File Processing API (e.g. `image`, `video`, `audio`) or transformation preset (created in the Bytescale Dashboard) to use when processing the file.
      */
     transformation: string;
-    /**
-     * Some transformations output multiple files, called artifacts.
-     *
-     * You can download each individual transformation artifact by specifying its path with this parameter
-     */
-    artifact?: string;
     /**
      * Specifies whether to cache the transformed result.
      *
@@ -79,6 +73,12 @@ export interface ProcessFileParams {
      * Default: true
      */
     cache?: boolean;
+    /**
+     * Some transformations output multiple files, called artifacts.
+     *
+     * You can download each individual transformation artifact by specifying its path with this parameter
+     */
+    artifact?: string;
     /**
      * Only serve transformations from the cache; do not perform new transformations on cache miss.
      *
@@ -197,4 +197,4 @@ export declare class FileApi extends runtime.BaseAPI {
 /**
  * @export
  */
-export declare type ProcessFileCachePermEnum = "auto" | "false" | "true";
+export type ProcessFileCachePermEnum = "auto" | "false" | "true";

package/dist/types/public/shared/generated/apis/JobApi.d.ts

@@ -35,7 +35,7 @@ export declare class JobApi extends runtime.BaseAPI {
      */
     getJob(params: GetJobParams): Promise<JobSummary>;
     /**
-     * Lists the most recently issued background jobs.  Requires a `secret_*` API key.
+     * Lists the 10 most recently created jobs for the specified job type(s).  Requires a `secret_*` API key.
      */
     listRecentJobs(params: ListRecentJobsParams): Promise<ListRecentJobsResponse>;
 }

package/dist/types/public/shared/generated/apis/UploadApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from "../runtime";
-import type { BasicUploadResponse, BeginMultipartUploadRequest, BeginMultipartUploadResponse, CompleteUploadPartRequest, UploadFromUrlRequest, UploadPart, UploadPartList } from "../models";
+import type { BasicUploadResponse, BeginMultipartUploadRequest, BeginMultipartUploadResponse, CompleteMultipartUploadResponse, CompleteUploadPartRequest, UploadFromUrlRequest, UploadPart, UploadPartList } from "../models";
 export interface BeginMultipartUploadOperationParams {
     accountId: string;
     /**
@@ -48,7 +48,7 @@ export declare class UploadApi extends runtime.BaseAPI {
     /**
      * 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(params: CompleteUploadPartOperationParams): Promise<void>;
+    completeUploadPart(params: CompleteUploadPartOperationParams): Promise<CompleteMultipartUploadResponse>;
     /**
      * Gets a remaining upload part for a multipart file upload.
      */

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

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