feat: add asset metadata schema (#323) (#552)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 88
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/mux%2Fmux-2eec862e75143314aec7ca531a90eecc404ce10a5038c2140810caaeb22cae43.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/mux%2Fmux-18b648ff0f5b764df4ec2b2e313996cbc27a08a1516316a0368f3ca9786a7944.yml

src/resources/video/assets.ts

@@ -304,6 +304,8 @@ export interface Asset {
    */
   max_stored_resolution?: 'Audio only' | 'SD' | 'HD' | 'FHD' | 'UHD';
 
+  meta?: Asset.Meta;
+
   /**
    * @deprecated
    */
@@ -325,7 +327,10 @@ export interface Asset {
   normalize_audio?: boolean;
 
   /**
-   * Arbitrary user-supplied metadata set for the asset. Max 255 characters.
+   * You can set this field to anything you want. It will be included in the asset
+   * details and related webhooks. If you're looking for more structured metadata,
+   * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
+   * 255 characters**.
    */
   passthrough?: string;
 
@@ -430,6 +435,25 @@ export namespace Asset {
     url?: string;
   }
 
+  export interface Meta {
+    /**
+     * This is an identifier you provide to keep track of the creator of the video. Max
+     * 128 code points.
+     */
+    creator_id?: string;
+
+    /**
+     * This is an identifier you provide to link the video to your own data. Max 128
+     * code points.
+     */
+    external_id?: string;
+
+    /**
+     * The video title. Max 512 code points.
+     */
+    title?: string;
+  }
+
   /**
    * An object containing one or more reasons the input file is non-standard. See
    * [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time)
@@ -687,6 +711,8 @@ export interface AssetOptions {
    */
   max_resolution_tier?: '1080p' | '1440p' | '2160p';
 
+  meta?: AssetOptions.Meta;
+
   /**
    * @deprecated Deprecated. See the
    * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
@@ -728,9 +754,10 @@ export interface AssetOptions {
   normalize_audio?: boolean;
 
   /**
-   * Arbitrary user-supplied metadata that will be included in the asset details and
-   * related webhooks. Can be used to store your own ID for a video along with the
-   * asset. **Max: 255 characters**.
+   * You can set this field to anything you want. It will be included in the asset
+   * details and related webhooks. If you're looking for more structured metadata,
+   * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
+   * 255 characters**.
    */
   passthrough?: string;
 
@@ -1011,6 +1038,25 @@ export namespace AssetOptions {
     }
   }
 
+  export interface Meta {
+    /**
+     * This is an identifier you provide to keep track of the creator of the video. Max
+     * 128 code points.
+     */
+    creator_id?: string;
+
+    /**
+     * This is an identifier you provide to link the video to your own data. Max 128
+     * code points.
+     */
+    external_id?: string;
+
+    /**
+     * The video title. Max 512 code points.
+     */
+    title?: string;
+  }
+
   export interface StaticRendition {
     resolution:
       | 'highest'
@@ -1450,6 +1496,8 @@ export interface AssetCreateParams {
    */
   max_resolution_tier?: '1080p' | '1440p' | '2160p';
 
+  meta?: AssetCreateParams.Meta;
+
   /**
    * Deprecated. See the
    * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions)
@@ -1491,9 +1539,10 @@ export interface AssetCreateParams {
   normalize_audio?: boolean;
 
   /**
-   * Arbitrary user-supplied metadata that will be included in the asset details and
-   * related webhooks. Can be used to store your own ID for a video along with the
-   * asset. **Max: 255 characters**.
+   * You can set this field to anything you want. It will be included in the asset
+   * details and related webhooks. If you're looking for more structured metadata,
+   * such as `title` or `external_id`, you can use the `meta` object instead. **Max:
+   * 255 characters**.
    */
   passthrough?: string;
 
@@ -1771,6 +1820,25 @@ export namespace AssetCreateParams {
     policy?: Shared.PlaybackPolicy;
   }
 
+  export interface Meta {
+    /**
+     * This is an identifier you provide to keep track of the creator of the video. Max
+     * 128 code points.
+     */
+    creator_id?: string;
+
+    /**
+     * This is an identifier you provide to link the video to your own data. Max 128
+     * code points.
+     */
+    external_id?: string;
+
+    /**
+     * The video title. Max 512 code points.
+     */
+    title?: string;
+  }
+
   export interface StaticRendition {
     resolution:
       | 'highest'
@@ -1793,13 +1861,39 @@ export namespace AssetCreateParams {
 }
 
 export interface AssetUpdateParams {
+  meta?: AssetUpdateParams.Meta;
+
   /**
-   * Arbitrary metadata set for the Asset. Max 255 characters. In order to clear this
-   * value, the field should be included with an empty string value.
+   * You can set this field to anything you want. It will be included in the asset
+   * details and related webhooks. If you're looking for more structured metadata,
+   * such as `title` or `external_id` , you can use the `meta` object instead. **Max:
+   * 255 characters**. In order to clear this value, the field should be included
+   * with an empty string value.
    */
   passthrough?: string;
 }
 
+export namespace AssetUpdateParams {
+  export interface Meta {
+    /**
+     * This is an identifier you provide to keep track of the creator of the video. Max
+     * 128 code points.
+     */
+    creator_id?: string;
+
+    /**
+     * This is an identifier you provide to link the video to your own data. Max 128
+     * code points.
+     */
+    external_id?: string;
+
+    /**
+     * The video title. Max 512 code points.
+     */
+    title?: string;
+  }
+}
+
 export interface AssetListParams extends BasePageParams {
   /**
    * Filter response to return all the assets for this live stream only

src/resources/video/live-streams.ts

@@ -864,6 +864,8 @@ export namespace LiveStreamUpdateParams {
      */
     master_access?: 'temporary' | 'none';
 
+    meta?: NewAssetSettings.Meta;
+
     /**
      * @deprecated Deprecated. See the
      * [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#during-live-stream-creation)
@@ -895,6 +897,27 @@ export namespace LiveStreamUpdateParams {
      */
     video_quality?: 'plus' | 'premium';
   }
+
+  export namespace NewAssetSettings {
+    export interface Meta {
+      /**
+       * This is an identifier you provide to keep track of the creator of the video. Max
+       * 128 code points.
+       */
+      creator_id?: string;
+
+      /**
+       * This is an identifier you provide to link the video to your own data. Max 128
+       * code points.
+       */
+      external_id?: string;
+
+      /**
+       * The video title. Max 512 code points.
+       */
+      title?: string;
+    }
+  }
 }
 
 export interface LiveStreamListParams extends BasePageParams {

tests/api-resources/video/assets.test.ts

@@ -50,6 +50,7 @@ describe('resource assets', () => {
       encoding_tier: 'smart',
       master_access: 'none',
       max_resolution_tier: '1080p',
+      meta: { creator_id: 'creator_id', external_id: 'external_id', title: 'title' },
       mp4_support: 'none',
       normalize_audio: true,
       passthrough: 'passthrough',

tests/api-resources/video/uploads.test.ts

@@ -52,6 +52,7 @@ describe('resource uploads', () => {
         ],
         master_access: 'none',
         max_resolution_tier: '1080p',
+        meta: { creator_id: 'creator_id', external_id: 'external_id', title: 'title' },
         mp4_support: 'none',
         normalize_audio: true,
         passthrough: 'passthrough',