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

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

@@ -715,6 +715,74 @@ export declare 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 declare type ItemCurrentVsPublishedStateIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export declare 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 declare 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 declare type ScheduledPublicationIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export declare 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 declare type ScheduledUnpublishingIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export declare 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 declare type ItemVersionIdentity = string;
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `batch_destroy.jobSchema` link.
@@ -760,6 +828,24 @@ export declare type ItemBatchUnpublishHrefSchema = {
      */
     'filter[ids]': string;
 };
+/**
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `publish.schema` link.
+ */
+export declare 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.
@@ -771,6 +857,20 @@ export declare type ItemPublishHrefSchema = {
     recursive?: boolean;
     [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `unpublish.schema` link.
+ */
+export declare 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.
@@ -802,23 +902,6 @@ export declare type ItemBulkDestroyJobSchema = unknown[];
  * via the `bulk_move_to_stage.jobSchema` link.
  */
 export declare 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 declare type ItemVersionIdentity = string;
-/**
- * JSON API type field
- *
- * This interface was referenced by `ItemVersion`'s JSON-Schema
- * via the `definition` "type".
- */
-export declare type ItemVersionType = 'item_version';
 /**
  * This interface was referenced by `ItemVersion`'s JSON-Schema
  * via the `restore.jobSchema` link.
@@ -1004,40 +1087,6 @@ export declare type UploadRequestIdentity = string;
  * via the `definition` "type".
  */
 export declare 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 declare type ScheduledPublicationIdentity = string;
-/**
- * JSON API type field
- *
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema
- * via the `definition` "type".
- */
-export declare 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 declare type ScheduledUnpublishingIdentity = string;
-/**
- * JSON API type field
- *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
- * via the `definition` "type".
- */
-export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
 /**
  * ID of result
  *
@@ -1632,6 +1681,7 @@ export declare type DatoApi = {
     subscription_feature?: SubscriptionFeature;
     build_event?: BuildEvent;
     item?: Item;
+    item_current_vs_published_state?: ItemCurrentVsPublishedState;
     item_version?: ItemVersion;
     upload?: Upload;
     upload_request?: UploadRequest;
@@ -6497,6 +6547,94 @@ export declare 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 declare 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 declare type ItemCurrentVsPublishedStateTargetSchema = ItemCurrentVsPublishedState;
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ScheduledPublication`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export declare type ScheduledPublicationData = {
+    type: ScheduledPublicationType;
+    id: ScheduledPublicationIdentity;
+};
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export declare type ScheduledUnpublishingData = {
+    type: ScheduledUnpublishingType;
+    id: ScheduledUnpublishingIdentity;
+};
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export declare type ItemVersionData = {
+    type: ItemVersionType;
+    id: ItemVersionIdentity;
+};
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export declare 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 declare 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 declare 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.
@@ -6592,16 +6730,6 @@ export declare type ItemVersionMeta = {
      */
     is_current: boolean;
 };
-/**
- * JSON API data
- *
- * This interface was referenced by `ItemVersion`'s JSON-Schema
- * via the `definition` "data".
- */
-export declare type ItemVersionData = {
-    type: ItemVersionType;
-    id: ItemVersionIdentity;
-};
 /**
  * The JSON data associated to the record version
  *
@@ -7212,19 +7340,22 @@ export declare 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 declare type ScheduledPublicationCreateTargetSchema = ScheduledPublication;
-/**
- * JSON API data
- *
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema
- * via the `definition` "data".
- */
-export declare type ScheduledPublicationData = {
-    type: ScheduledPublicationType;
-    id: ScheduledPublicationIdentity;
-};
 /**
  * JSON API attributes
  *
@@ -7236,6 +7367,19 @@ export declare 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;
+    };
 };
 /**
  * JSON API links
@@ -7252,7 +7396,23 @@ export declare type ScheduledPublicationRelationships = {
  */
 export declare 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;
+    };
 };
 /**
  * You can create a scheduled unpublishing to unpublish records in the future
@@ -7267,19 +7427,13 @@ export declare 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 declare type ScheduledUnpublishingCreateTargetSchema = ScheduledUnpublishing;
-/**
- * JSON API data
- *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
- * via the `definition` "data".
- */
-export declare type ScheduledUnpublishingData = {
-    type: ScheduledUnpublishingType;
-    id: ScheduledUnpublishingIdentity;
-};
 /**
  * JSON API attributes
  *
@@ -7291,6 +7445,10 @@ export declare 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[];
 };
 /**
  * JSON API links
@@ -7307,7 +7465,14 @@ export declare type ScheduledUnpublishingRelationships = {
  */
 export declare 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[];
 };
 /**
  * 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/dist/types/generated/resources/Item.d.ts

@@ -174,6 +174,28 @@ export default class Item extends BaseResource {
      * @throws {TimeoutError}
      */
     rawFind(itemId: string, queryParams?: SchemaTypes.ItemSelfHrefSchema): Promise<SchemaTypes.ItemSelfTargetSchema>;
+    /**
+     * 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): Promise<SimpleSchemaTypes.ItemCurrentVsPublishedState>;
+    /**
+     * 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>;
     /**
      * Delete a record
      *
@@ -266,7 +288,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    publish(itemId: string | SimpleSchemaTypes.ItemData, queryParams?: SimpleSchemaTypes.ItemPublishHrefSchema): Promise<SimpleSchemaTypes.Item>;
+    publish(itemId: string | SimpleSchemaTypes.ItemData, body?: SimpleSchemaTypes.ItemPublishSchema, queryParams?: SimpleSchemaTypes.ItemPublishHrefSchema): Promise<SimpleSchemaTypes.Item>;
     /**
      * Publish a record
      *
@@ -275,7 +297,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawPublish(itemId: string, queryParams?: SchemaTypes.ItemPublishHrefSchema): Promise<SchemaTypes.ItemPublishTargetSchema>;
+    rawPublish(itemId: string, body?: SchemaTypes.ItemPublishSchema, queryParams?: SchemaTypes.ItemPublishHrefSchema): Promise<SchemaTypes.ItemPublishTargetSchema>;
     /**
      * Unpublish a record
      *
@@ -284,7 +306,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    unpublish(itemId: string | SimpleSchemaTypes.ItemData, queryParams?: SimpleSchemaTypes.ItemUnpublishHrefSchema): Promise<SimpleSchemaTypes.Item>;
+    unpublish(itemId: string | SimpleSchemaTypes.ItemData, body?: SimpleSchemaTypes.ItemUnpublishSchema, queryParams?: SimpleSchemaTypes.ItemUnpublishHrefSchema): Promise<SimpleSchemaTypes.Item>;
     /**
      * Unpublish a record
      *
@@ -293,7 +315,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawUnpublish(itemId: string, queryParams?: SchemaTypes.ItemUnpublishHrefSchema): Promise<SchemaTypes.ItemUnpublishTargetSchema>;
+    rawUnpublish(itemId: string, body?: SchemaTypes.ItemUnpublishSchema, queryParams?: SchemaTypes.ItemUnpublishHrefSchema): Promise<SchemaTypes.ItemUnpublishTargetSchema>;
     /**
      * Publish items in bulk
      *

package/dist/types/generated/resources/Plugin.d.ts

@@ -58,7 +58,7 @@ export default class Plugin extends BaseResource {
      */
     rawList(): Promise<SchemaTypes.PluginInstancesTargetSchema>;
     /**
-     * Retrieve a plugins
+     * Retrieve a plugin
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
      *
@@ -67,7 +67,7 @@ export default class Plugin extends BaseResource {
      */
     find(pluginId: string | SimpleSchemaTypes.PluginData): Promise<SimpleSchemaTypes.Plugin>;
     /**
-     * Retrieve a plugins
+     * Retrieve a plugin
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "1.3.4",
+  "version": "1.3.6-alpha.0",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -40,7 +40,7 @@
     "@datocms/rest-client-utils": "^1.3.3"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^1.3.4"
+    "@datocms/dashboard-client": "^1.3.6-alpha.0"
   },
-  "gitHead": "2acca5bc90e7662af306ab2b50413b6ece7e18fd"
+  "gitHead": "6d4e65c250eef462e5bd7cf995d66d5fb377570b"
 }