@datocms/cma-client 3.3.0 → 3.3.1

package/dist/types/generated/SimpleSchemaTypes.d.ts

@@ -1066,6 +1066,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
  *
@@ -1653,6 +1673,7 @@ export type DatoApi = {
     item_version?: ItemVersion;
     upload?: Upload;
     upload_request?: UploadRequest;
+    upload_track?: UploadTrack;
     scheduled_publication?: ScheduledPublication;
     scheduled_unpublishing?: ScheduledUnpublishing;
     search_result?: SearchResult;
@@ -4502,6 +4523,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.
  *
@@ -4537,6 +4567,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;
 /**
@@ -7504,6 +7537,138 @@ 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/dist/types/generated/resources/UploadTrack.d.ts

@@ -0,0 +1,82 @@
+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";
+    /**
+     * 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): Promise<SimpleSchemaTypes.UploadTrack>;
+    /**
+     * 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>;
+    /**
+     * 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): Promise<SimpleSchemaTypes.UploadTrackInstancesTargetSchema>;
+    /**
+     * 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>;
+    /**
+     * 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): Promise<SimpleSchemaTypes.UploadTrack>;
+    /**
+     * 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>;
+    /**
+     * 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): Promise<SimpleSchemaTypes.UploadTrack>;
+    /**
+     * 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>;
+}

package/dist/types/generated/resources/index.d.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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": ["datocms", "client"],
   "author": "Stefano Verna <s.verna@datocms.com>",
@@ -30,12 +30,12 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^3.3.0",
+    "@datocms/rest-client-utils": "^3.3.1",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^3.3.0",
+    "@datocms/dashboard-client": "^3.3.1",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "1797aa66113ed33fd845d1433317f45c4ca6a47a"
+  "gitHead": "72d7577fe8451175d705bfec742f271351b7de30"
 }