cloudflare/src/resources/workers-for-platforms/dispatch/namespaces/scripts/asset-upload.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../../../core/resource';
import { APIPromise } from '../../../../../core/api-promise';
import { RequestOptions } from '../../../../../internal/request-options';
import { path } from '../../../../../internal/utils/path';

export class BaseAssetUpload extends APIResource {
  static override readonly _key: readonly [
    'workersForPlatforms',
    'dispatch',
    'namespaces',
    'scripts',
    'assetUpload',
  ] = Object.freeze(['workersForPlatforms', 'dispatch', 'namespaces', 'scripts', 'assetUpload'] as const);

  /**
   * Start uploading a collection of assets for use in a Workers for Platforms script
   * version. To learn more about the direct uploads of assets, see
   * https://developers.cloudflare.com/workers/static-assets/direct-upload/.
   *
   * @example
   * ```ts
   * const assetUpload =
   *   await client.workersForPlatforms.dispatch.namespaces.scripts.assetUpload.create(
   *     'this-is_my_script-01',
   *     {
   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *       dispatch_namespace: 'my-dispatch-namespace',
   *       manifest: { foo: { hash: 'hash', size: 0 } },
   *     },
   *   );
   * ```
   */
  create(
    scriptName: string,
    params: AssetUploadCreateParams,
    options?: RequestOptions,
  ): APIPromise<AssetUploadCreateResponse> {
    const { account_id, dispatch_namespace, ...body } = params;
    return (
      this._client.post(
        path`/accounts/${account_id}/workers/dispatch/namespaces/${dispatch_namespace}/scripts/${scriptName}/assets-upload-session`,
        { body, ...options },
      ) as APIPromise<{ result: AssetUploadCreateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class AssetUpload extends BaseAssetUpload {}

export interface AssetUploadCreateResponse {
  /**
   * The requests to make to upload assets.
   */
  buckets?: Array<Array<string>>;

  /**
   * A JWT to use as authentication for uploading assets.
   */
  jwt?: string;
}

export interface AssetUploadCreateParams {
  /**
   * Path param: Identifier.
   */
  account_id: string;

  /**
   * Path param: Name of the Workers for Platforms dispatch namespace.
   */
  dispatch_namespace: string;

  /**
   * Body param: A manifest ([path]: {hash, size}) map of files to upload. As an
   * example, `/blog/hello-world.html` would be a valid path key.
   */
  manifest: { [key: string]: AssetUploadCreateParams.Manifest };
}

export namespace AssetUploadCreateParams {
  export interface Manifest {
    /**
     * The hash of the file.
     */
    hash: string;

    /**
     * The size of the file in bytes.
     */
    size: number;
  }
}

export declare namespace AssetUpload {
  export {
    type AssetUploadCreateResponse as AssetUploadCreateResponse,
    type AssetUploadCreateParams as AssetUploadCreateParams,
  };
}