@datocms/cma-client 1.3.5 → 1.3.6-alpha.0

package/src/generated/SimpleSchemaTypes.ts

@@ -717,6 +717,74 @@ export type ItemSelfHrefSchema = {
   version?: string;
   [k: string]: unknown;
 };
+/**
+ * ID of record
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type ItemCurrentVsPublishedStateIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ScheduledPublication`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type ScheduledPublicationType = 'scheduled_publication';
+/**
+ * ID of scheduled_publication
+ *
+ * This interface was referenced by `ScheduledPublication`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `ScheduledPublication`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type ScheduledPublicationIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type ScheduledUnpublishingType = 'scheduled_unpublishing';
+/**
+ * ID of scheduled_unpublishing
+ *
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type ScheduledUnpublishingIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type ItemVersionType = 'item_version';
+/**
+ * ID of record version
+ *
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type ItemVersionIdentity = string;
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `batch_destroy.jobSchema` link.
@@ -762,6 +830,24 @@ export type ItemBatchUnpublishHrefSchema = {
    */
   'filter[ids]': string;
 };
+/**
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `publish.schema` link.
+ */
+export type ItemPublishSchema = {
+  /**
+   * JSON API type field
+   */
+  type?: 'selective_publish_operation';
+  /**
+   * List of locales whose content will be published
+   */
+  content_in_locales: string[];
+  /**
+   * Whether non-localized content has to be published or not
+   */
+  non_localized_content: boolean;
+} | null;
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `publish.hrefSchema` link.
@@ -773,6 +859,20 @@ export type ItemPublishHrefSchema = {
   recursive?: boolean;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `unpublish.schema` link.
+ */
+export type ItemUnpublishSchema = {
+  /**
+   * JSON API type field
+   */
+  type?: 'selective_unpublish_operation';
+  /**
+   * List of locales whose content will be unpublished
+   */
+  content_in_locales: string[];
+} | null;
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `unpublish.hrefSchema` link.
@@ -804,23 +904,6 @@ export type ItemBulkDestroyJobSchema = unknown[];
  * via the `bulk_move_to_stage.jobSchema` link.
  */
 export type ItemBulkMoveToStageJobSchema = unknown[];
-/**
- * ID of record version
- *
- * This interface was referenced by `ItemVersion`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `ItemVersion`'s JSON-Schema
- * via the `definition` "id".
- */
-export type ItemVersionIdentity = string;
-/**
- * JSON API type field
- *
- * This interface was referenced by `ItemVersion`'s JSON-Schema
- * via the `definition` "type".
- */
-export type ItemVersionType = 'item_version';
 /**
  * This interface was referenced by `ItemVersion`'s JSON-Schema
  * via the `restore.jobSchema` link.
@@ -1006,40 +1089,6 @@ export type UploadRequestIdentity = string;
  * via the `definition` "type".
  */
 export type UploadRequestType = 'upload_request';
-/**
- * ID of scheduled_publication
- *
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema
- * via the `definition` "id".
- */
-export type ScheduledPublicationIdentity = string;
-/**
- * JSON API type field
- *
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema
- * via the `definition` "type".
- */
-export type ScheduledPublicationType = 'scheduled_publication';
-/**
- * ID of scheduled_unpublishing
- *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
- * via the `definition` "id".
- */
-export type ScheduledUnpublishingIdentity = string;
-/**
- * JSON API type field
- *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
- * via the `definition` "type".
- */
-export type ScheduledUnpublishingType = 'scheduled_unpublishing';
 /**
  * ID of result
  *
@@ -1660,6 +1709,7 @@ export type DatoApi = {
   subscription_feature?: SubscriptionFeature;
   build_event?: BuildEvent;
   item?: Item;
+  item_current_vs_published_state?: ItemCurrentVsPublishedState;
   item_version?: ItemVersion;
   upload?: Upload;
   upload_request?: UploadRequest;
@@ -7007,6 +7057,101 @@ export type ItemUpdateSchema = {
   [k: string]: unknown;
 };
 
+/**
+ * Information about the record
+ *
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `current_vs_published_state.targetSchema` link.
+ *
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "item_current_vs_published_state".
+ */
+export type ItemCurrentVsPublishedState = {
+  id: ItemCurrentVsPublishedStateIdentity;
+  type: ItemCurrentVsPublishedStateType;
+  current_version_locales: string[];
+  published_version_locales: string[];
+  changed_locales: string[];
+  added_locales: string[];
+  removed_locales: string[];
+  non_localized_fields_changed: boolean;
+  scheduled_publication: ScheduledPublicationData | null;
+  scheduled_unpublishing: ScheduledUnpublishingData | null;
+  published_version: ItemVersionData | null;
+};
+export type ItemCurrentVsPublishedStateTargetSchema =
+  ItemCurrentVsPublishedState;
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ScheduledPublication`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type ScheduledPublicationData = {
+  type: ScheduledPublicationType;
+  id: ScheduledPublicationIdentity;
+};
+
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type ScheduledUnpublishingData = {
+  type: ScheduledUnpublishingType;
+  id: ScheduledUnpublishingIdentity;
+};
+
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type ItemVersionData = {
+  type: ItemVersionType;
+  id: ItemVersionIdentity;
+};
+
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type ItemCurrentVsPublishedStateData = {
+  type: ItemCurrentVsPublishedStateType;
+  id: ItemCurrentVsPublishedStateIdentity;
+};
+
+/**
+ * The JSON data associated to the record
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "attributes".
+ */
+export type ItemCurrentVsPublishedStateAttributes = {
+  current_version_locales: string[];
+  published_version_locales: string[];
+  changed_locales: string[];
+  added_locales: string[];
+  removed_locales: string[];
+  non_localized_fields_changed: boolean;
+};
+
+/**
+ * JSON API links
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "relationships".
+ */
+export type ItemCurrentVsPublishedStateRelationships = {
+  scheduled_publication: ScheduledPublicationData | null;
+  scheduled_unpublishing: ScheduledUnpublishingData | null;
+  published_version: ItemVersionData | null;
+};
+
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `bulk_publish.schema` link.
@@ -7112,17 +7257,6 @@ export type ItemVersionMeta = {
   is_current: boolean;
 };
 
-/**
- * JSON API data
- *
- * This interface was referenced by `ItemVersion`'s JSON-Schema
- * via the `definition` "data".
- */
-export type ItemVersionData = {
-  type: ItemVersionType;
-  id: ItemVersionIdentity;
-};
-
 /**
  * The JSON data associated to the record version
  *
@@ -7765,20 +7899,22 @@ export type ScheduledPublication = {
    * The future date for the publication
    */
   publication_scheduled_at: string;
+  /**
+   * Specifies which content should be published. If null, the whole record will be published.
+   */
+  selective_publication: null | {
+    /**
+     * List of locales whose content will be published
+     */
+    content_in_locales: string[];
+    /**
+     * Whether the non-localized content has to be published or not
+     */
+    non_localized_content: boolean;
+  };
   item: ItemData;
 };
 export type ScheduledPublicationCreateTargetSchema = ScheduledPublication;
-/**
- * JSON API data
- *
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema
- * via the `definition` "data".
- */
-export type ScheduledPublicationData = {
-  type: ScheduledPublicationType;
-  id: ScheduledPublicationIdentity;
-};
-
 /**
  * JSON API attributes
  *
@@ -7790,6 +7926,19 @@ export type ScheduledPublicationAttributes = {
    * The future date for the publication
    */
   publication_scheduled_at: string;
+  /**
+   * Specifies which content should be published. If null, the whole record will be published.
+   */
+  selective_publication: null | {
+    /**
+     * List of locales whose content will be published
+     */
+    content_in_locales: string[];
+    /**
+     * Whether the non-localized content has to be published or not
+     */
+    non_localized_content: boolean;
+  };
 };
 
 /**
@@ -7808,7 +7957,23 @@ export type ScheduledPublicationRelationships = {
  */
 export type ScheduledPublicationCreateSchema = {
   type?: ScheduledPublicationType;
-  [k: string]: unknown;
+  /**
+   * The future date for the publication
+   */
+  publication_scheduled_at: string;
+  /**
+   * Specifies which content should be published. If null, the whole record will be published.
+   */
+  selective_publication?: null | {
+    /**
+     * List of locales whose content will be published
+     */
+    content_in_locales: string[];
+    /**
+     * Whether the non-localized content has to be published or not
+     */
+    non_localized_content: boolean;
+  };
 };
 
 /**
@@ -7824,20 +7989,13 @@ export type ScheduledUnpublishing = {
    * The future date for the unpublishing
    */
   unpublishing_scheduled_at: string;
+  /**
+   * List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
+   */
+  content_in_locales: null | string[];
   item: ItemData;
 };
 export type ScheduledUnpublishingCreateTargetSchema = ScheduledUnpublishing;
-/**
- * JSON API data
- *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
- * via the `definition` "data".
- */
-export type ScheduledUnpublishingData = {
-  type: ScheduledUnpublishingType;
-  id: ScheduledUnpublishingIdentity;
-};
-
 /**
  * JSON API attributes
  *
@@ -7849,6 +8007,10 @@ export type ScheduledUnpublishingAttributes = {
    * The future date for the unpublishing
    */
   unpublishing_scheduled_at: string;
+  /**
+   * List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
+   */
+  content_in_locales: null | string[];
 };
 
 /**
@@ -7867,7 +8029,14 @@ export type ScheduledUnpublishingRelationships = {
  */
 export type ScheduledUnpublishingCreateSchema = {
   type?: ScheduledUnpublishingType;
-  [k: string]: unknown;
+  /**
+   * The future date for the unpublishing
+   */
+  unpublishing_scheduled_at: string;
+  /**
+   * List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
+   */
+  content_in_locales?: null | string[];
 };
 
 /**

package/src/generated/resources/Item.ts

@@ -364,6 +364,45 @@ export default class Item extends BaseResource {
     });
   }
 
+  /**
+   * Retrieve information regarding changes between current and published versions of the record
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item/current_vs_published_state
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  currentVsPublishedState(itemId: string | SimpleSchemaTypes.ItemData) {
+    return this.rawCurrentVsPublishedState(Utils.toId(itemId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemCurrentVsPublishedStateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve information regarding changes between current and published versions of the record
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item/current_vs_published_state
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawCurrentVsPublishedState(
+    itemId: string,
+  ): Promise<SchemaTypes.ItemCurrentVsPublishedStateTargetSchema> {
+    return this.client.request<SchemaTypes.ItemCurrentVsPublishedStateTargetSchema>(
+      {
+        method: 'GET',
+        url: `/items/${itemId}/current-vs-published-state`,
+      },
+    );
+  }
+
   /**
    * Delete a record
    *
@@ -519,9 +558,21 @@ export default class Item extends BaseResource {
    */
   publish(
     itemId: string | SimpleSchemaTypes.ItemData,
+    body?: SimpleSchemaTypes.ItemPublishSchema,
     queryParams?: SimpleSchemaTypes.ItemPublishHrefSchema,
   ) {
-    return this.rawPublish(Utils.toId(itemId), queryParams).then((body) =>
+    return this.rawPublish(
+      Utils.toId(itemId),
+      body
+        ? Utils.serializeRequestBody<SchemaTypes.ItemPublishSchema>(body, {
+            id: Utils.toId(itemId),
+            type: 'selective_publish_operation',
+            attributes: ['content_in_locales', 'non_localized_content'],
+            relationships: [],
+          })
+        : null,
+      queryParams,
+    ).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemPublishTargetSchema>(
         body,
       ),
@@ -538,11 +589,13 @@ export default class Item extends BaseResource {
    */
   rawPublish(
     itemId: string,
+    body?: SchemaTypes.ItemPublishSchema,
     queryParams?: SchemaTypes.ItemPublishHrefSchema,
   ): Promise<SchemaTypes.ItemPublishTargetSchema> {
     return this.client.request<SchemaTypes.ItemPublishTargetSchema>({
       method: 'PUT',
       url: `/items/${itemId}/publish`,
+      body,
       queryParams,
     });
   }
@@ -557,9 +610,21 @@ export default class Item extends BaseResource {
    */
   unpublish(
     itemId: string | SimpleSchemaTypes.ItemData,
+    body?: SimpleSchemaTypes.ItemUnpublishSchema,
     queryParams?: SimpleSchemaTypes.ItemUnpublishHrefSchema,
   ) {
-    return this.rawUnpublish(Utils.toId(itemId), queryParams).then((body) =>
+    return this.rawUnpublish(
+      Utils.toId(itemId),
+      body
+        ? Utils.serializeRequestBody<SchemaTypes.ItemUnpublishSchema>(body, {
+            id: Utils.toId(itemId),
+            type: 'selective_unpublish_operation',
+            attributes: ['content_in_locales'],
+            relationships: [],
+          })
+        : null,
+      queryParams,
+    ).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemUnpublishTargetSchema>(
         body,
       ),
@@ -576,11 +641,13 @@ export default class Item extends BaseResource {
    */
   rawUnpublish(
     itemId: string,
+    body?: SchemaTypes.ItemUnpublishSchema,
     queryParams?: SchemaTypes.ItemUnpublishHrefSchema,
   ): Promise<SchemaTypes.ItemUnpublishTargetSchema> {
     return this.client.request<SchemaTypes.ItemUnpublishTargetSchema>({
       method: 'PUT',
       url: `/items/${itemId}/unpublish`,
+      body,
       queryParams,
     });
   }

package/src/generated/resources/Plugin.ts

@@ -141,7 +141,7 @@ export default class Plugin extends BaseResource {
   }
 
   /**
-   * Retrieve a plugins
+   * Retrieve a plugin
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
    *
@@ -157,7 +157,7 @@ export default class Plugin extends BaseResource {
   }
 
   /**
-   * Retrieve a plugins
+   * Retrieve a plugin
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
    *

package/src/generated/resources/ScheduledPublication.ts

@@ -24,7 +24,7 @@ export default class ScheduledPublication extends BaseResource {
         body,
         {
           type: 'scheduled_publication',
-          attributes: ['publication_scheduled_at'],
+          attributes: ['publication_scheduled_at', 'selective_publication'],
           relationships: [],
         },
       ),

package/src/generated/resources/ScheduledUnpublishing.ts

@@ -24,7 +24,7 @@ export default class ScheduledUnpublishing extends BaseResource {
         body,
         {
           type: 'scheduled_unpublishing',
-          attributes: ['unpublishing_scheduled_at'],
+          attributes: ['unpublishing_scheduled_at', 'content_in_locales'],
           relationships: [],
         },
       ),