@stack0/sdk 0.5.17 → 0.5.18

package/dist/cdn/index.d.mts

@@ -177,6 +177,16 @@ interface VideoVariant {
     quality: VideoQuality;
     codec?: VideoCodec;
     bitrate?: number;
+    /**
+     * Bytes actually written to storage for this rendition, measured after the job completes.
+     * For HLS this covers the variant playlist and its segments; for MP4, the single file.
+     *
+     * Response-only — ignored if you set it on a transcode request.
+     *
+     * Undefined means not measured (job still running, job predates measurement, or the
+     * measurement failed), never zero. `bitrate * duration` is an estimate; this is not.
+     */
+    sizeBytes?: number;
 }
 /**
  * Watermark burned into a video during transcode.
@@ -299,6 +309,13 @@ interface TranscodeJob {
     /** Provider or preprocessing failure details when status is `failed`. */
     errorMessage: string | null;
     mediaConvertJobId: string | null;
+    /**
+     * Every byte this job wrote: renditions, HLS segments, and manifests together, since
+     * storage is billed per object rather than for the media alone.
+     *
+     * Null until the job completes, and null if the measurement failed. Not zero.
+     */
+    totalOutputBytes: number | null;
     createdAt: Date;
     startedAt: Date | null;
     completedAt: Date | null;
@@ -587,6 +604,42 @@ interface CdnStorageBreakdownResponse {
         sizeFormatted: string;
     };
 }
+interface CdnStorageUsageRequest {
+    projectSlug?: string;
+    environment?: CdnEnvironment;
+    /**
+     * Virtual folder path to scope the total to, e.g. "/customers/acme". The folder itself and
+     * everything nested under it are counted. Omit to total the whole project or organization.
+     */
+    folder?: string;
+}
+interface CdnStorageUsageBucket {
+    bytes: number;
+    bytesFormatted: string;
+    objectCount: number;
+}
+interface CdnStorageUsageResponse {
+    /** Uploads plus every measured derived object stored under the scope. */
+    totalBytes: number;
+    totalFormatted: string;
+    /** Objects behind that total. Storage is billed per object, so segments and manifests count. */
+    objectCount: number;
+    /** Split by asset type; a video's renditions count as video. */
+    byType: Record<string, CdnStorageUsageBucket>;
+    breakdown: {
+        /** The uploaded files themselves. */
+        originals: CdnStorageUsageBucket;
+        /** Renditions, HLS segments and manifests, thumbnails, GIFs. */
+        derived: CdnStorageUsageBucket;
+    };
+    /**
+     * Assets known to have derivatives whose bytes have not been measured yet. Their storage is
+     * missing from `totalBytes`, so a nonzero count means the total is a floor, not the answer.
+     */
+    unmeasuredAssets: number;
+    /** The folder the total covers, or null when the whole project or org was counted. */
+    folder: string | null;
+}
 interface GetFolderRequest {
     id: string;
 }
@@ -1696,6 +1749,29 @@ declare class CDN {
      * ```
      */
     getStorageBreakdown(request?: CdnStorageBreakdownRequest): Promise<CdnStorageBreakdownResponse>;
+    /**
+     * Get total stored bytes for a project or folder, derived assets included.
+     *
+     * Totals uploads plus everything the pipelines derived from them — video renditions, HLS
+     * segments and manifests, thumbnails, GIFs — in one call. Use this to meter a plan limit:
+     * paging `list()` and summing `size` counts uploads only, and an HLS ladder typically runs
+     * well past the size of the source it came from.
+     *
+     * Check `unmeasuredAssets`. A nonzero value means some assets have derivatives whose bytes
+     * have not been measured, so `totalBytes` is a floor rather than the full number.
+     *
+     * @example
+     * ```typescript
+     * const usage = await cdn.getStorageUsage({
+     *   projectSlug: 'my-project',
+     *   folder: '/customers/acme',
+     * });
+     * console.log(`${usage.totalFormatted} across ${usage.objectCount} objects`);
+     * console.log(`  uploads:  ${usage.breakdown.originals.bytesFormatted}`);
+     * console.log(`  derived:  ${usage.breakdown.derived.bytesFormatted}`);
+     * ```
+     */
+    getStorageUsage(request?: CdnStorageUsageRequest): Promise<CdnStorageUsageResponse>;
     private convertUsageDates;
     private convertUsageDataPointDates;
     /**
@@ -1995,4 +2071,4 @@ declare class CDN {
     private convertImportFileDates;
 }
 
-export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelImportResponse, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type CompositeChromaKey, type CompositeConfig, type CompositePoint, type CompositeQuad, type CompositeRect, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateImportRequest, type CreateImportResponse, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GenerateGifRequest, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type GifStatus, type ImageVideoWatermarkOptions, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ImportAuthType, type ImportError, type ImportFile, type ImportFileStatus, type ImportJob, type ImportJobStatus, type ImportJobSummary, type ImportPathMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListImportFilesRequest, type ListImportFilesResponse, type ListImportsRequest, type ListImportsResponse, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeAspectRatio, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type RetryImportResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type TextVideoWatermarkOptions, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadFromUrlRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };
+export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelImportResponse, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnStorageUsageBucket, type CdnStorageUsageRequest, type CdnStorageUsageResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type CompositeChromaKey, type CompositeConfig, type CompositePoint, type CompositeQuad, type CompositeRect, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateImportRequest, type CreateImportResponse, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GenerateGifRequest, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type GifStatus, type ImageVideoWatermarkOptions, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ImportAuthType, type ImportError, type ImportFile, type ImportFileStatus, type ImportJob, type ImportJobStatus, type ImportJobSummary, type ImportPathMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListImportFilesRequest, type ListImportFilesResponse, type ListImportsRequest, type ListImportsResponse, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeAspectRatio, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type RetryImportResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type TextVideoWatermarkOptions, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadFromUrlRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };

package/dist/cdn/index.d.ts

@@ -177,6 +177,16 @@ interface VideoVariant {
     quality: VideoQuality;
     codec?: VideoCodec;
     bitrate?: number;
+    /**
+     * Bytes actually written to storage for this rendition, measured after the job completes.
+     * For HLS this covers the variant playlist and its segments; for MP4, the single file.
+     *
+     * Response-only — ignored if you set it on a transcode request.
+     *
+     * Undefined means not measured (job still running, job predates measurement, or the
+     * measurement failed), never zero. `bitrate * duration` is an estimate; this is not.
+     */
+    sizeBytes?: number;
 }
 /**
  * Watermark burned into a video during transcode.
@@ -299,6 +309,13 @@ interface TranscodeJob {
     /** Provider or preprocessing failure details when status is `failed`. */
     errorMessage: string | null;
     mediaConvertJobId: string | null;
+    /**
+     * Every byte this job wrote: renditions, HLS segments, and manifests together, since
+     * storage is billed per object rather than for the media alone.
+     *
+     * Null until the job completes, and null if the measurement failed. Not zero.
+     */
+    totalOutputBytes: number | null;
     createdAt: Date;
     startedAt: Date | null;
     completedAt: Date | null;
@@ -587,6 +604,42 @@ interface CdnStorageBreakdownResponse {
         sizeFormatted: string;
     };
 }
+interface CdnStorageUsageRequest {
+    projectSlug?: string;
+    environment?: CdnEnvironment;
+    /**
+     * Virtual folder path to scope the total to, e.g. "/customers/acme". The folder itself and
+     * everything nested under it are counted. Omit to total the whole project or organization.
+     */
+    folder?: string;
+}
+interface CdnStorageUsageBucket {
+    bytes: number;
+    bytesFormatted: string;
+    objectCount: number;
+}
+interface CdnStorageUsageResponse {
+    /** Uploads plus every measured derived object stored under the scope. */
+    totalBytes: number;
+    totalFormatted: string;
+    /** Objects behind that total. Storage is billed per object, so segments and manifests count. */
+    objectCount: number;
+    /** Split by asset type; a video's renditions count as video. */
+    byType: Record<string, CdnStorageUsageBucket>;
+    breakdown: {
+        /** The uploaded files themselves. */
+        originals: CdnStorageUsageBucket;
+        /** Renditions, HLS segments and manifests, thumbnails, GIFs. */
+        derived: CdnStorageUsageBucket;
+    };
+    /**
+     * Assets known to have derivatives whose bytes have not been measured yet. Their storage is
+     * missing from `totalBytes`, so a nonzero count means the total is a floor, not the answer.
+     */
+    unmeasuredAssets: number;
+    /** The folder the total covers, or null when the whole project or org was counted. */
+    folder: string | null;
+}
 interface GetFolderRequest {
     id: string;
 }
@@ -1696,6 +1749,29 @@ declare class CDN {
      * ```
      */
     getStorageBreakdown(request?: CdnStorageBreakdownRequest): Promise<CdnStorageBreakdownResponse>;
+    /**
+     * Get total stored bytes for a project or folder, derived assets included.
+     *
+     * Totals uploads plus everything the pipelines derived from them — video renditions, HLS
+     * segments and manifests, thumbnails, GIFs — in one call. Use this to meter a plan limit:
+     * paging `list()` and summing `size` counts uploads only, and an HLS ladder typically runs
+     * well past the size of the source it came from.
+     *
+     * Check `unmeasuredAssets`. A nonzero value means some assets have derivatives whose bytes
+     * have not been measured, so `totalBytes` is a floor rather than the full number.
+     *
+     * @example
+     * ```typescript
+     * const usage = await cdn.getStorageUsage({
+     *   projectSlug: 'my-project',
+     *   folder: '/customers/acme',
+     * });
+     * console.log(`${usage.totalFormatted} across ${usage.objectCount} objects`);
+     * console.log(`  uploads:  ${usage.breakdown.originals.bytesFormatted}`);
+     * console.log(`  derived:  ${usage.breakdown.derived.bytesFormatted}`);
+     * ```
+     */
+    getStorageUsage(request?: CdnStorageUsageRequest): Promise<CdnStorageUsageResponse>;
     private convertUsageDates;
     private convertUsageDataPointDates;
     /**
@@ -1995,4 +2071,4 @@ declare class CDN {
     private convertImportFileDates;
 }
 
-export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelImportResponse, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type CompositeChromaKey, type CompositeConfig, type CompositePoint, type CompositeQuad, type CompositeRect, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateImportRequest, type CreateImportResponse, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GenerateGifRequest, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type GifStatus, type ImageVideoWatermarkOptions, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ImportAuthType, type ImportError, type ImportFile, type ImportFileStatus, type ImportJob, type ImportJobStatus, type ImportJobSummary, type ImportPathMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListImportFilesRequest, type ListImportFilesResponse, type ListImportsRequest, type ListImportsResponse, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeAspectRatio, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type RetryImportResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type TextVideoWatermarkOptions, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadFromUrlRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };
+export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelImportResponse, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnStorageUsageBucket, type CdnStorageUsageRequest, type CdnStorageUsageResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type CompositeChromaKey, type CompositeConfig, type CompositePoint, type CompositeQuad, type CompositeRect, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateImportRequest, type CreateImportResponse, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GenerateGifRequest, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type GifStatus, type ImageVideoWatermarkOptions, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ImportAuthType, type ImportError, type ImportFile, type ImportFileStatus, type ImportJob, type ImportJobStatus, type ImportJobSummary, type ImportPathMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListImportFilesRequest, type ListImportFilesResponse, type ListImportsRequest, type ListImportsResponse, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeAspectRatio, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type RetryImportResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type TextVideoWatermarkOptions, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadFromUrlRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };

package/dist/cdn/index.js

@@ -1064,6 +1064,36 @@ var CDN = class {
     const query = params.toString();
     return this.http.get(`/cdn/usage/storage-breakdown${query ? `?${query}` : ""}`);
   }
+  /**
+   * Get total stored bytes for a project or folder, derived assets included.
+   *
+   * Totals uploads plus everything the pipelines derived from them — video renditions, HLS
+   * segments and manifests, thumbnails, GIFs — in one call. Use this to meter a plan limit:
+   * paging `list()` and summing `size` counts uploads only, and an HLS ladder typically runs
+   * well past the size of the source it came from.
+   *
+   * Check `unmeasuredAssets`. A nonzero value means some assets have derivatives whose bytes
+   * have not been measured, so `totalBytes` is a floor rather than the full number.
+   *
+   * @example
+   * ```typescript
+   * const usage = await cdn.getStorageUsage({
+   *   projectSlug: 'my-project',
+   *   folder: '/customers/acme',
+   * });
+   * console.log(`${usage.totalFormatted} across ${usage.objectCount} objects`);
+   * console.log(`  uploads:  ${usage.breakdown.originals.bytesFormatted}`);
+   * console.log(`  derived:  ${usage.breakdown.derived.bytesFormatted}`);
+   * ```
+   */
+  async getStorageUsage(request = {}) {
+    const params = new URLSearchParams();
+    if (request.projectSlug) params.set("projectSlug", request.projectSlug);
+    if (request.environment) params.set("environment", request.environment);
+    if (request.folder) params.set("folder", request.folder);
+    const query = params.toString();
+    return this.http.get(`/cdn/usage/storage${query ? `?${query}` : ""}`);
+  }
   convertUsageDates(usage) {
     if (typeof usage.periodStart === "string") {
       usage.periodStart = new Date(usage.periodStart);