@datocms/cma-client 3.3.0 → 3.3.1

package/src/generated/Client.ts

@@ -58,6 +58,7 @@ export class Client {
   itemVersions: Resources.ItemVersion;
   uploads: Resources.Upload;
   uploadRequest: Resources.UploadRequest;
+  uploadTracks: Resources.UploadTrack;
   scheduledPublication: Resources.ScheduledPublication;
   scheduledUnpublishing: Resources.ScheduledUnpublishing;
   searchResults: Resources.SearchResult;
@@ -109,6 +110,7 @@ export class Client {
     this.itemVersions = new Resources.ItemVersion(this);
     this.uploads = new Resources.Upload(this);
     this.uploadRequest = new Resources.UploadRequest(this);
+    this.uploadTracks = new Resources.UploadTrack(this);
     this.scheduledPublication = new Resources.ScheduledPublication(this);
     this.scheduledUnpublishing = new Resources.ScheduledUnpublishing(this);
     this.searchResults = new Resources.SearchResult(this);
@@ -143,7 +145,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v3.3.0',
+      userAgent: '@datocms/cma-client v3.3.1',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {

package/src/generated/SchemaTypes.ts

@@ -896,6 +896,21 @@ export type UploadRequestType = 'upload_request';
  * via the `definition` "id".
  */
 export type UploadRequestIdentity = string;
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type UploadTrackType = 'upload_track';
+/**
+ * ID of the upload track
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type UploadTrackIdentity = string;
 /**
  * This interface was referenced by `SearchResult`'s JSON-Schema
  * via the `definition` "type".
@@ -1390,6 +1405,7 @@ export type DatoApi = {
   item_version?: ItemVersion;
   upload?: Upload;
   upload_request?: UploadRequest;
+  upload_track?: UploadTrack;
   scheduled_publication?: ScheduledPublication;
   scheduled_unpublishing?: ScheduledUnpublishing;
   search_result?: SearchResult;
@@ -8312,6 +8328,186 @@ export type UploadRequestCreateTargetSchema = {
   data: UploadRequest;
 };
 
+/**
+ * If the asset linked to an Upload entity is a video file, you have the option to include additional audio tracks and subtitle tracks to it.
+ *
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "upload_track".
+ */
+export type UploadTrack = {
+  type: UploadTrackType;
+  id: UploadTrackIdentity;
+  attributes: UploadTrackAttributes;
+  relationships: UploadTrackRelationships;
+};
+
+/**
+ * JSON API attributes
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "attributes".
+ */
+export type UploadTrackAttributes = {
+  /**
+   * The type of track (audio or subtitles)
+   */
+  type: 'subtitles' | 'audio';
+  /**
+   * The human-readable name of the track
+   */
+  name: string;
+  /**
+   * A valid BCP 47 specification compliant language code
+   */
+  language_code: string;
+  /**
+   * When status is `errored`, explains the reason for the error
+   */
+  error: null | string;
+  /**
+   * The status of the asset
+   */
+  status: 'preparing' | 'ready' | 'errored';
+  /**
+   * Indicates if the track provides subtitles for the Deaf or Hard-of-hearing (SDH)
+   */
+  closed_captions: null | boolean;
+};
+
+/**
+ * JSON API links
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "relationships".
+ */
+export type UploadTrackRelationships = {
+  /**
+   * The upload containing the track
+   */
+  upload: {
+    data: UploadData;
+  };
+};
+
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type UploadTrackData = {
+  type: UploadTrackType;
+  id: UploadTrackIdentity;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `create.schema` link.
+ */
+export type UploadTrackCreateSchema = {
+  data: {
+    type: UploadTrackType;
+    attributes: {
+      /**
+       * Either an URL to download, or the ID of an upload request
+       */
+      url_or_upload_request_id: string;
+      /**
+       * The type of track (audio or subtitles)
+       */
+      type: 'subtitles' | 'audio';
+      /**
+       * The human-readable name of the track
+       */
+      name?: string;
+      /**
+       * A valid BCP 47 specification compliant language code
+       */
+      language_code: string;
+      /**
+       * Indicates if the track provides subtitles for the Deaf or Hard-of-hearing (SDH)
+       */
+      closed_captions?: null | boolean;
+    };
+  };
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `create.targetSchema` link.
+ */
+export type UploadTrackCreateTargetSchema = {
+  data: Job;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `create.jobSchema` link.
+ */
+export type UploadTrackCreateJobSchema = {
+  data: UploadTrack;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `instances.targetSchema` link.
+ */
+export type UploadTrackInstancesTargetSchema = {
+  data: UploadTrack[];
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `destroy.targetSchema` link.
+ */
+export type UploadTrackDestroyTargetSchema = {
+  data: Job;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `destroy.jobSchema` link.
+ */
+export type UploadTrackDestroyJobSchema = {
+  data: UploadTrack;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `generate_subtitles.schema` link.
+ */
+export type UploadTrackGenerateSubtitlesSchema = {
+  data: {
+    type: UploadTrackType;
+    attributes: {
+      /**
+       * The human-readable name of the track
+       */
+      name?: string;
+      /**
+       * A valid BCP 47 specification compliant language code
+       */
+      language_code: string;
+    };
+  };
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `generate_subtitles.targetSchema` link.
+ */
+export type UploadTrackGenerateSubtitlesTargetSchema = {
+  data: Job;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `generate_subtitles.jobSchema` link.
+ */
+export type UploadTrackGenerateSubtitlesJobSchema = {
+  data: UploadTrack;
+};
+
 /**
  * DatoCMS Site Search is a way to deliver tailored search results to your site visitors. This is the endpoint you can use to query for results.
  *

package/src/generated/SimpleSchemaTypes.ts

@@ -1068,6 +1068,26 @@ export type UploadRequestIdentity = string;
  * via the `definition` "type".
  */
 export type UploadRequestType = 'upload_request';
+/**
+ * ID of the upload track
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type UploadTrackIdentity = string;
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type UploadTrackType = 'upload_track';
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `instances.targetSchema` link.
+ */
+export type UploadTrackInstancesTargetSchema = UploadTrack[];
 /**
  * ID of result
  *
@@ -1681,6 +1701,7 @@ export type DatoApi = {
   item_version?: ItemVersion;
   upload?: Upload;
   upload_request?: UploadRequest;
+  upload_track?: UploadTrack;
   scheduled_publication?: ScheduledPublication;
   scheduled_unpublishing?: ScheduledUnpublishing;
   search_result?: SearchResult;
@@ -4777,6 +4798,15 @@ export type ItemTypeUpdateSchema = {
  * This interface was referenced by `Upload`'s JSON-Schema
  * via the `bulk_destroy.targetSchema` link.
  *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `create.targetSchema` link.
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `destroy.targetSchema` link.
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `generate_subtitles.targetSchema` link.
+ *
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `update.targetSchema` link.
  *
@@ -4812,6 +4842,9 @@ export type UploadBatchAddTagsTargetSchema = Job;
 export type UploadBatchDestroyTargetSchema = Job;
 export type UploadBulkTagTargetSchema = Job;
 export type UploadBulkDestroyTargetSchema = Job;
+export type UploadTrackCreateTargetSchema = Job;
+export type UploadTrackDestroyTargetSchema = Job;
+export type UploadTrackGenerateSubtitlesTargetSchema = Job;
 export type SiteUpdateTargetSchema = Job;
 export type SiteActivateImprovedTimezoneManagementTargetSchema = Job;
 /**
@@ -8072,6 +8105,143 @@ export type UploadRequestCreateSchema = {
   filename?: string;
 };
 
+/**
+ * If the asset linked to an Upload entity is a video file, you have the option to include additional audio tracks and subtitle tracks to it.
+ *
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "upload_track".
+ */
+export type UploadTrack = {
+  id: UploadTrackIdentity;
+  /**
+   * The type of track (audio or subtitles)
+   */
+  type: 'subtitles' | 'audio';
+  /**
+   * The human-readable name of the track
+   */
+  name: string;
+  /**
+   * A valid BCP 47 specification compliant language code
+   */
+  language_code: string;
+  /**
+   * When status is `errored`, explains the reason for the error
+   */
+  error: null | string;
+  /**
+   * The status of the asset
+   */
+  status: 'preparing' | 'ready' | 'errored';
+  /**
+   * Indicates if the track provides subtitles for the Deaf or Hard-of-hearing (SDH)
+   */
+  closed_captions: null | boolean;
+  upload: UploadData;
+};
+export type UploadTrackCreateJobSchema = UploadTrack;
+export type UploadTrackDestroyJobSchema = UploadTrack;
+export type UploadTrackGenerateSubtitlesJobSchema = UploadTrack;
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type UploadTrackData = {
+  /**
+   * The type of track (audio or subtitles)
+   */
+  type: 'subtitles' | 'audio';
+  id: UploadTrackIdentity;
+};
+
+/**
+ * JSON API attributes
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "attributes".
+ */
+export type UploadTrackAttributes = {
+  /**
+   * The type of track (audio or subtitles)
+   */
+  type: 'subtitles' | 'audio';
+  /**
+   * The human-readable name of the track
+   */
+  name: string;
+  /**
+   * A valid BCP 47 specification compliant language code
+   */
+  language_code: string;
+  /**
+   * When status is `errored`, explains the reason for the error
+   */
+  error: null | string;
+  /**
+   * The status of the asset
+   */
+  status: 'preparing' | 'ready' | 'errored';
+  /**
+   * Indicates if the track provides subtitles for the Deaf or Hard-of-hearing (SDH)
+   */
+  closed_captions: null | boolean;
+};
+
+/**
+ * JSON API links
+ *
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `definition` "relationships".
+ */
+export type UploadTrackRelationships = {
+  upload: UploadData;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `create.schema` link.
+ */
+export type UploadTrackCreateSchema = {
+  /**
+   * The type of track (audio or subtitles)
+   */
+  type: 'subtitles' | 'audio';
+  /**
+   * Either an URL to download, or the ID of an upload request
+   */
+  url_or_upload_request_id: string;
+  /**
+   * The human-readable name of the track
+   */
+  name?: string;
+  /**
+   * A valid BCP 47 specification compliant language code
+   */
+  language_code: string;
+  /**
+   * Indicates if the track provides subtitles for the Deaf or Hard-of-hearing (SDH)
+   */
+  closed_captions?: null | boolean;
+};
+
+/**
+ * This interface was referenced by `UploadTrack`'s JSON-Schema
+ * via the `generate_subtitles.schema` link.
+ */
+export type UploadTrackGenerateSubtitlesSchema = {
+  type?: UploadTrackType;
+  /**
+   * The human-readable name of the track
+   */
+  name?: string;
+  /**
+   * A valid BCP 47 specification compliant language code
+   */
+  language_code: string;
+};
+
 /**
  * You can create scheduled publication to publish records in the future
  *

package/src/generated/resources/UploadTrack.ts

@@ -0,0 +1,186 @@
+import * as Utils from '@datocms/rest-client-utils';
+import BaseResource from '../../BaseResource';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+
+export default class UploadTrack extends BaseResource {
+  static readonly TYPE = 'upload_track' as const;
+
+  /**
+   * Create a new upload track
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  create(
+    uploadId: string | SimpleSchemaTypes.UploadData,
+    body: SimpleSchemaTypes.UploadTrackCreateSchema,
+  ) {
+    return this.rawCreate(
+      Utils.toId(uploadId),
+      Utils.serializeRequestBody<SchemaTypes.UploadTrackCreateSchema>(body, {
+        type: 'upload_track',
+        attributes: [
+          'url_or_upload_request_id',
+          'type',
+          'name',
+          'language_code',
+          'closed_captions',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadTrackCreateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new upload track
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawCreate(
+    uploadId: string,
+    body: SchemaTypes.UploadTrackCreateSchema,
+  ): Promise<SchemaTypes.UploadTrackCreateJobSchema> {
+    return this.client.request<SchemaTypes.UploadTrackCreateJobSchema>({
+      method: 'POST',
+      url: `/uploads/${uploadId}/tracks`,
+      body,
+    });
+  }
+
+  /**
+   * List upload tracks
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  list(uploadId: string | SimpleSchemaTypes.UploadData) {
+    return this.rawList(Utils.toId(uploadId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadTrackInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List upload tracks
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawList(
+    uploadId: string,
+  ): Promise<SchemaTypes.UploadTrackInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.UploadTrackInstancesTargetSchema>({
+      method: 'GET',
+      url: `/uploads/${uploadId}/tracks`,
+    });
+  }
+
+  /**
+   * Delete an upload track
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  destroy(
+    uploadId: string | SimpleSchemaTypes.UploadData,
+    uploadTrackId: string | SimpleSchemaTypes.UploadTrackData,
+  ) {
+    return this.rawDestroy(
+      Utils.toId(uploadId),
+      Utils.toId(uploadTrackId),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadTrackDestroyJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete an upload track
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawDestroy(
+    uploadId: string,
+    uploadTrackId: string,
+  ): Promise<SchemaTypes.UploadTrackDestroyJobSchema> {
+    return this.client.request<SchemaTypes.UploadTrackDestroyJobSchema>({
+      method: 'DELETE',
+      url: `/uploads/${uploadId}/tracks/${uploadTrackId}`,
+    });
+  }
+
+  /**
+   * Automatically generate a subtitles track
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/generate_subtitles
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  generateSubtitles(
+    uploadId: string | SimpleSchemaTypes.UploadData,
+    body: SimpleSchemaTypes.UploadTrackGenerateSubtitlesSchema,
+  ) {
+    return this.rawGenerateSubtitles(
+      Utils.toId(uploadId),
+      Utils.serializeRequestBody<SchemaTypes.UploadTrackGenerateSubtitlesSchema>(
+        body,
+        {
+          type: 'upload_track',
+          attributes: ['name', 'language_code'],
+          relationships: [],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadTrackGenerateSubtitlesJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Automatically generate a subtitles track
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/generate_subtitles
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawGenerateSubtitles(
+    uploadId: string,
+    body: SchemaTypes.UploadTrackGenerateSubtitlesSchema,
+  ): Promise<SchemaTypes.UploadTrackGenerateSubtitlesJobSchema> {
+    return this.client.request<SchemaTypes.UploadTrackGenerateSubtitlesJobSchema>(
+      {
+        method: 'POST',
+        url: `/uploads/${uploadId}/tracks/generate-subtitles`,
+        body,
+      },
+    );
+  }
+}

package/src/generated/resources/index.ts

@@ -18,6 +18,7 @@ export { default as Item } from './Item';
 export { default as ItemVersion } from './ItemVersion';
 export { default as Upload } from './Upload';
 export { default as UploadRequest } from './UploadRequest';
+export { default as UploadTrack } from './UploadTrack';
 export { default as ScheduledPublication } from './ScheduledPublication';
 export { default as ScheduledUnpublishing } from './ScheduledUnpublishing';
 export { default as SearchResult } from './SearchResult';