@contentchef/contentchef-types 10.1.0-alpha.5 → 10.1.0-alpha.7

package/dist/api/PublishedContent.d.ts

@@ -222,7 +222,29 @@ export type UpdateReleaseRequest = {
  */
 export type UpdateReleaseResponse = Release;
 /**
- * This type represent the filters that can be applied to release items in the release V2 API requests
+ * This enum represent the comparison operators available to a release item date filter
+ */
+export declare enum DateFilterOperator {
+    lte = "lte",
+    gte = "gte"
+}
+/**
+ * This type represent a filter applied to one of the release item date fields
+ */
+export type ReleaseItemDateFilter = {
+    /**
+     * The date to compare the release item date field with, as an ISO 8601 string
+     */
+    value: string;
+    /**
+     * The comparison to apply to the release item date field.
+     * Defaults to [[DateFilterOperator.lte]], i.e. "at or before"
+     */
+    operator?: DateFilterOperator;
+};
+/**
+ * This type represent the filters that can be applied to release items in the release V2 API requests.
+ * When more than one filter is given they are combined with AND
  */
 export type ReleaseItemFilters = {
     /**
@@ -241,6 +263,16 @@ export type ReleaseItemFilters = {
      * Match only the release items that are (or are not) currently selected to be published
      */
     toPublish?: boolean;
+    /**
+     * Match only the release items whose related content online date satisfies the filter.
+     * Release items with no online date never match, whatever the operator
+     */
+    onlineDate?: ReleaseItemDateFilter;
+    /**
+     * Match only the release items whose related content offline date satisfies the filter.
+     * Release items with no offline date never match, whatever the operator
+     */
+    offlineDate?: ReleaseItemDateFilter;
 };
 /**
  * This type represent the data needed to make a create release V2 API request
@@ -272,7 +304,9 @@ export type UpdateReleaseV2Request = {
     includeAll?: boolean;
     /**
      * Select the release items matching the given filters. Empty filters select all the release items.
-     * A toPublish filter is evaluated against the selection before the update
+     * A toPublish filter is evaluated against the selection before the update.
+     * The filters are the same ones accepted by [[ListReleaseItemsV2Request]], so a selection can be
+     * previewed with `listReleaseItemsV2` and then applied by passing the very same filters here
      */
     filters?: ReleaseItemFilters;
     /**

package/dist/api/PublishedContent.js

@@ -1,2 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateFilterOperator = void 0;
+/**
+ * This enum represent the comparison operators available to a release item date filter
+ */
+var DateFilterOperator;
+(function (DateFilterOperator) {
+    DateFilterOperator["lte"] = "lte";
+    DateFilterOperator["gte"] = "gte";
+})(DateFilterOperator || (exports.DateFilterOperator = DateFilterOperator = {}));

package/dist/api/UnpublishRequest.d.ts

@@ -0,0 +1,97 @@
+import { ContentId } from './Content';
+import { AuthorResponse } from './Author';
+/**
+ * The unpublish request unique id
+ */
+export type UnpublishRequestId = number;
+/**
+ * This type represent the data needed to make an unpublish content API request
+ */
+export type UnpublishContentRequest = {
+    /**
+     * The content id to unpublish. Every staged locale of the content is unpublished
+     */
+    contentId: number;
+};
+/**
+ * This type represent the response of an unpublish content API request
+ */
+export type UnpublishContentResponse = {
+    /**
+     * The staged content version that has been removed.
+     * Undefined when nothing was staged, meaning the request was a no-op
+     */
+    contentVersion?: number;
+    /**
+     * The content locales whose staged content has actually been removed or reverted to its live version
+     */
+    locales: string[];
+    /**
+     * The number of release items dropped from the non archived releases containing the content
+     */
+    removedReleaseItems: number;
+};
+/**
+ * This type represent the data needed to make a list unpublish requests API request
+ */
+export type ListUnpublishRequestsRequest = {
+    /**
+     * The content id to list the unpublish requests of
+     */
+    contentId: number;
+    /**
+     * The content version to list the unpublish requests of.
+     * When omitted the whole unpublish history of the content is returned
+     */
+    contentVersion?: number;
+};
+/**
+ * This type represent the model of an unpublish request, the audit record of a content
+ * having been unpublished. It is written after the unpublish has been applied, so it always
+ * describes a completed unpublish
+ */
+export type UnpublishRequestResponse = {
+    /**
+     * The unpublish request unique id
+     */
+    id: UnpublishRequestId;
+    /**
+     * The author that unpublished the content
+     */
+    author: AuthorResponse;
+    /**
+     * The unique id of the unpublished content
+     */
+    contentId: ContentId;
+    /**
+     * The unpublished content version
+     */
+    contentVersion: number;
+    /**
+     * The content locales that have been unpublished
+     */
+    locales: string[];
+    /**
+     * The date the content has been unpublished, as opposed to [[createdDate]]
+     * which is the date this audit record has been written
+     */
+    unpublishedDate: Date;
+    /**
+     * The unpublish request creation date
+     */
+    createdDate: Date;
+    /**
+     * The unpublish request last modified date
+     */
+    lastModifiedDate: Date;
+};
+/**
+ * This type represent the response of a list unpublish requests API request, sorted by
+ * [[UnpublishRequestResponse.unpublishedDate]] descending.
+ * Only the [[MAX_LISTED_UNPUBLISH_REQUESTS]] most recent unpublish requests are returned
+ */
+export type ListUnpublishRequestsResponse = UnpublishRequestResponse[];
+/**
+ * The maximum number of unpublish requests returned by a list unpublish requests API request
+ */
+export declare const MAX_LISTED_UNPUBLISH_REQUESTS = 5;

package/dist/api/UnpublishRequest.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_LISTED_UNPUBLISH_REQUESTS = void 0;
+/**
+ * The maximum number of unpublish requests returned by a list unpublish requests API request
+ */
+exports.MAX_LISTED_UNPUBLISH_REQUESTS = 5;

package/dist/api/index.d.ts

@@ -13,6 +13,7 @@ export * from './PublishedContent';
 export * from './PublishingRequest';
 export * from './Space';
 export * from './Subscription';
+export * from './UnpublishRequest';
 export * from './User';
 export * from './UserConsents';
 export * from './UserPermission';

package/dist/api/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./PublishedContent"), exports);
 __exportStar(require("./PublishingRequest"), exports);
 __exportStar(require("./Space"), exports);
 __exportStar(require("./Subscription"), exports);
+__exportStar(require("./UnpublishRequest"), exports);
 __exportStar(require("./User"), exports);
 __exportStar(require("./UserConsents"), exports);
 __exportStar(require("./UserPermission"), exports);

package/lib/api/PublishedContent.ts

@@ -236,7 +236,31 @@ export type UpdateReleaseRequest = {
 export type UpdateReleaseResponse = Release;
 
 /**
- * This type represent the filters that can be applied to release items in the release V2 API requests
+ * This enum represent the comparison operators available to a release item date filter
+ */
+export enum DateFilterOperator {
+  lte = "lte",
+  gte = "gte",
+}
+
+/**
+ * This type represent a filter applied to one of the release item date fields
+ */
+export type ReleaseItemDateFilter = {
+  /**
+   * The date to compare the release item date field with, as an ISO 8601 string
+   */
+  value: string;
+  /**
+   * The comparison to apply to the release item date field.
+   * Defaults to [[DateFilterOperator.lte]], i.e. "at or before"
+   */
+  operator?: DateFilterOperator;
+};
+
+/**
+ * This type represent the filters that can be applied to release items in the release V2 API requests.
+ * When more than one filter is given they are combined with AND
  */
 export type ReleaseItemFilters = {
   /**
@@ -255,6 +279,16 @@ export type ReleaseItemFilters = {
    * Match only the release items that are (or are not) currently selected to be published
    */
   toPublish?: boolean;
+  /**
+   * Match only the release items whose related content online date satisfies the filter.
+   * Release items with no online date never match, whatever the operator
+   */
+  onlineDate?: ReleaseItemDateFilter;
+  /**
+   * Match only the release items whose related content offline date satisfies the filter.
+   * Release items with no offline date never match, whatever the operator
+   */
+  offlineDate?: ReleaseItemDateFilter;
 };
 
 /**
@@ -289,7 +323,9 @@ export type UpdateReleaseV2Request = {
   includeAll?: boolean;
   /**
    * Select the release items matching the given filters. Empty filters select all the release items.
-   * A toPublish filter is evaluated against the selection before the update
+   * A toPublish filter is evaluated against the selection before the update.
+   * The filters are the same ones accepted by [[ListReleaseItemsV2Request]], so a selection can be
+   * previewed with `listReleaseItemsV2` and then applied by passing the very same filters here
    */
   filters?: ReleaseItemFilters;
   /**

package/lib/api/UnpublishRequest.ts

@@ -0,0 +1,104 @@
+import { ContentId } from './Content';
+import { AuthorResponse } from './Author';
+
+/**
+ * The unpublish request unique id
+ */
+export type UnpublishRequestId = number;
+
+/**
+ * This type represent the data needed to make an unpublish content API request
+ */
+export type UnpublishContentRequest = {
+    /**
+     * The content id to unpublish. Every staged locale of the content is unpublished
+     */
+    contentId: number;
+};
+
+/**
+ * This type represent the response of an unpublish content API request
+ */
+export type UnpublishContentResponse = {
+    /**
+     * The staged content version that has been removed.
+     * Undefined when nothing was staged, meaning the request was a no-op
+     */
+    contentVersion?: number;
+    /**
+     * The content locales whose staged content has actually been removed or reverted to its live version
+     */
+    locales: string[];
+    /**
+     * The number of release items dropped from the non archived releases containing the content
+     */
+    removedReleaseItems: number;
+};
+
+/**
+ * This type represent the data needed to make a list unpublish requests API request
+ */
+export type ListUnpublishRequestsRequest = {
+    /**
+     * The content id to list the unpublish requests of
+     */
+    contentId: number;
+    /**
+     * The content version to list the unpublish requests of.
+     * When omitted the whole unpublish history of the content is returned
+     */
+    contentVersion?: number;
+};
+
+/**
+ * This type represent the model of an unpublish request, the audit record of a content
+ * having been unpublished. It is written after the unpublish has been applied, so it always
+ * describes a completed unpublish
+ */
+export type UnpublishRequestResponse = {
+    /**
+     * The unpublish request unique id
+     */
+    id: UnpublishRequestId;
+    /**
+     * The author that unpublished the content
+     */
+    author: AuthorResponse;
+    /**
+     * The unique id of the unpublished content
+     */
+    contentId: ContentId;
+    /**
+     * The unpublished content version
+     */
+    contentVersion: number;
+    /**
+     * The content locales that have been unpublished
+     */
+    locales: string[];
+    /**
+     * The date the content has been unpublished, as opposed to [[createdDate]]
+     * which is the date this audit record has been written
+     */
+    unpublishedDate: Date;
+    /**
+     * The unpublish request creation date
+     */
+    createdDate: Date;
+    /**
+     * The unpublish request last modified date
+     */
+    lastModifiedDate: Date;
+};
+
+/**
+ * This type represent the response of a list unpublish requests API request, sorted by
+ * [[UnpublishRequestResponse.unpublishedDate]] descending.
+ * Only the [[MAX_LISTED_UNPUBLISH_REQUESTS]] most recent unpublish requests are returned
+ */
+export type ListUnpublishRequestsResponse = UnpublishRequestResponse[];
+
+/**
+ * The maximum number of unpublish requests returned by a list unpublish requests API request
+ */
+export const MAX_LISTED_UNPUBLISH_REQUESTS = 5;

package/lib/api/index.ts

@@ -13,6 +13,7 @@ export * from './PublishedContent';
 export * from './PublishingRequest';
 export * from './Space';
 export * from './Subscription';
+export * from './UnpublishRequest';
 export * from './User';
 export * from './UserConsents';
 export * from './UserPermission';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.1.0-alpha.5",
+  "version": "10.1.0-alpha.7",
   "description": "ContentChef types",
   "author": "PierpaoloIannone <piannone@byte-code.com>",
   "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",
@@ -34,5 +34,5 @@
   "devDependencies": {
     "typescript": "^5.9.3"
   },
-  "gitHead": "395605c7649177141f6ee45bb5c178c946d25fc5"
+  "gitHead": "32486d3ee511a086801ccf537683912616e17884"
 }