@contentchef/contentchef-types 10.1.0-alpha.6 → 10.1.0-alpha.8

package/dist/api/ContentExportImport.d.ts

@@ -0,0 +1,481 @@
+import { AuthorResponse } from './Author';
+import { PagedListResponse } from './common';
+import { ContentId, ListContentsFilters } from './Content';
+/**
+ * The content export request unique id
+ */
+export type ContentExportRequestId = number;
+/**
+ * The content import request unique id
+ */
+export type ContentImportRequestId = number;
+/**
+ * The content import request item unique id
+ */
+export type ContentImportRequestItemId = number;
+/**
+ * This enum represent the file format of a content export, and the format an import file is read with
+ */
+export declare enum ContentExportFormat {
+    JSON = "json",
+    CSV = "csv"
+}
+/**
+ * This enum represent the lifecycle of a content export request. Exports are processed
+ * asynchronously, so a freshly created request is always `queued`
+ */
+export declare enum ContentExportStatus {
+    QUEUED = "queued",
+    PROCESSING = "processing",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}
+/**
+ * This enum represent the lifecycle of a content import request. A freshly created request is
+ * `awaiting_upload` until the import file is uploaded to
+ * [[CreateContentImportRequestResponse.uploadUrl]], which is what starts the import
+ */
+export declare enum ContentImportStatus {
+    AWAITING_UPLOAD = "awaiting_upload",
+    PROCESSING = "processing",
+    COMPLETED = "completed",
+    COMPLETED_WITH_ERRORS = "completed_with_errors",
+    FAILED = "failed"
+}
+/**
+ * This enum represent what an imported row describes: the content itself or one of its translations
+ */
+export declare enum ContentImportRowType {
+    CONTENT = "content",
+    TRANSLATION = "translation"
+}
+/**
+ * This enum represent the outcome of a single imported row
+ */
+export declare enum ContentImportItemStatus {
+    SUCCESS = "success",
+    FAILED = "failed"
+}
+/**
+ * This enum represent what the import did to the content of a successfully imported row
+ */
+export declare enum ContentImportItemAction {
+    UPDATED = "updated"
+}
+/**
+ * This type represent the error attached to a failed content export or import request
+ */
+export type ContentExportImportError = {
+    /**
+     * The error type discriminator
+     */
+    type: string;
+    /**
+     * The human readable error message
+     */
+    message: string;
+};
+/**
+ * This type represent one of the files produced by a content export, one per exported content
+ * definition. Files are appended as soon as they are uploaded, so a still `processing` export
+ * already lists the files that can be downloaded
+ */
+export type ContentExportFile = {
+    /**
+     * The mnemonic id of the content definition the file contains the contents of
+     */
+    definitionMnemonicId: string;
+    /**
+     * The internal storage key of the file. Not fetchable as is, pass
+     * [[definitionMnemonicId]] to [[ContentExportImportFacade.downloadExport]] to get a
+     * downloadable url
+     */
+    s3Key: string;
+    /**
+     * The number of contents written in the file
+     */
+    itemCount: number;
+};
+/**
+ * This type represent the model of a content export request
+ */
+export type ContentExportRequestResponse = {
+    /**
+     * The content export request unique id
+     */
+    id: ContentExportRequestId;
+    /**
+     * The space the exported contents belong to
+     */
+    spaceId: string;
+    /**
+     * The current status of the export
+     */
+    status: ContentExportStatus;
+    /**
+     * The filters the exported contents have been selected with
+     */
+    filters: ListContentsFilters;
+    /**
+     * The format the export files are written in
+     */
+    format: ContentExportFormat;
+    /**
+     * The separator used by the exported csv files. Meaningless when [[format]] is `json`
+     */
+    csvSeparator: string;
+    /**
+     * The files produced so far, one per exported content definition.
+     * Null until the export starts producing them
+     */
+    files: ContentExportFile[] | null;
+    /**
+     * The error describing why the export failed, null unless [[status]] is `failed`
+     */
+    error: ContentExportImportError | null;
+    /**
+     * The author that requested the export
+     */
+    author: AuthorResponse;
+    /**
+     * The last author that modified the export request. Only returned by
+     * [[ContentExportImportFacade.createExport]], the listing does not resolve it
+     */
+    latestContributor?: AuthorResponse;
+    /**
+     * The export request creation date
+     */
+    createdDate: Date;
+    /**
+     * The export request last modified date
+     */
+    lastModifiedDate: Date;
+};
+/**
+ * This type represent the data needed to make a create content export request API request
+ */
+export type CreateContentExportRequestRequest = {
+    /**
+     * The filters selecting the contents to export, the same ones accepted by
+     * [[ContentFacade.list]]. When omitted every unarchived content of the space is exported.
+     * Archived contents cannot be imported back, so [[ListContentsFilters.contentsStatus]]
+     * defaults to `unarchived`
+     */
+    filters?: Partial<ListContentsFilters>;
+    /**
+     * The format to write the export files in, defaults to `json`
+     */
+    format?: ContentExportFormat;
+    /**
+     * The single character separator to write the exported csv files with, defaults to `,`.
+     * Ignored when [[format]] is `json`
+     */
+    csvSeparator?: string;
+};
+/**
+ * This type represent the response of a create content export request API request.
+ * The returned export is always `queued`: it is processed asynchronously
+ */
+export type CreateContentExportRequestResponse = ContentExportRequestResponse;
+/**
+ * This type represent the data needed to make a list content export requests API request
+ */
+export type ListContentExportRequestsRequest = {
+    /**
+     * The export requests to skip (used to paginate the result), defaults to 0
+     */
+    skip?: number;
+    /**
+     * The export requests to take (used to paginate the result), defaults to 20.
+     * Cannot exceed [[MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE]]
+     */
+    take?: number;
+};
+/**
+ * This type represent the response of a list content export requests API request,
+ * sorted by [[ContentExportRequestResponse.createdDate]] descending
+ */
+export type ListContentExportRequestsResponse = PagedListResponse<ContentExportRequestResponse>;
+/**
+ * This type represent the data needed to make a download content export API request
+ */
+export type DownloadContentExportRequest = {
+    /**
+     * The unique id of the completed export request to download a file of
+     */
+    exportRequestId: ContentExportRequestId;
+    /**
+     * The mnemonic id of the content definition whose exported file is wanted.
+     * It must be one of the [[ContentExportRequestResponse.files]] entries
+     */
+    definitionMnemonicId: string;
+};
+/**
+ * This type represent the response of a download content export API request
+ */
+export type DownloadContentExportResponse = {
+    /**
+     * The mnemonic id of the content definition the file contains the contents of
+     */
+    definitionMnemonicId: string;
+    /**
+     * The temporary url to download the exported file from. The client does not download the
+     * file, fetch this url yourself
+     */
+    downloadUrl: string;
+    /**
+     * The number of seconds [[downloadUrl]] stays valid for
+     */
+    expiresInSeconds: number;
+    /**
+     * The number of contents written in the file
+     */
+    itemCount: number;
+};
+/**
+ * This type represent the options a content import file is read with
+ */
+export type ContentImportOptions = {
+    /**
+     * The format the import file is read as
+     */
+    format: ContentExportFormat;
+    /**
+     * The separator the imported csv file is read with. Meaningless when [[format]] is `json`
+     */
+    csvSeparator?: string;
+};
+/**
+ * This type represent the model of a content import request
+ */
+export type ContentImportRequestResponse = {
+    /**
+     * The content import request unique id
+     */
+    id: ContentImportRequestId;
+    /**
+     * The space the contents are imported in
+     */
+    spaceId: string;
+    /**
+     * The current status of the import
+     */
+    status: ContentImportStatus;
+    /**
+     * The name of the uploaded file, as declared when the import was created. Null when not declared
+     */
+    fileName: string | null;
+    /**
+     * The storage key the import file is expected at
+     */
+    s3Key: string;
+    /**
+     * The options the import file is read with
+     */
+    options: ContentImportOptions;
+    /**
+     * The arn of the workflow execution processing the import.
+     * Null while the import is still `awaiting_upload`
+     */
+    executionArn: string | null;
+    /**
+     * The number of rows found in the import file, null until the file has been read
+     */
+    totalItems: number | null;
+    /**
+     * The number of successfully imported rows, null until the import completes
+     */
+    succeededItems: number | null;
+    /**
+     * The number of rows that failed to import, null until the import completes.
+     * When greater than 0 the [[status]] is `completed_with_errors`
+     */
+    failedItems: number | null;
+    /**
+     * The error describing why the whole import failed, null unless [[status]] is `failed`.
+     * Single row failures are reported by [[ContentImportRequestItemResponse.error]] instead
+     */
+    error: ContentExportImportError | null;
+    /**
+     * The author that requested the import
+     */
+    author: AuthorResponse;
+    /**
+     * The import request creation date
+     */
+    createdDate: Date;
+    /**
+     * The import request last modified date
+     */
+    lastModifiedDate: Date;
+};
+/**
+ * This type represent the data needed to make a create content import request API request
+ */
+export type CreateContentImportRequestRequest = {
+    /**
+     * The name of the file about to be uploaded, kept for display purposes only
+     */
+    fileName?: string;
+    /**
+     * The options to read the uploaded file with
+     */
+    options?: {
+        /**
+         * The format the uploaded file is read as, defaults to `json`
+         */
+        format?: ContentExportFormat;
+        /**
+         * The single character separator the uploaded csv file is read with, defaults to `,`.
+         * Ignored when [[format]] is `json`
+         */
+        csvSeparator?: string;
+    };
+};
+/**
+ * This type represent the response of a create content import request API request
+ */
+export type CreateContentImportRequestResponse = {
+    /**
+     * The created content import request unique id
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The storage key the file is uploaded to
+     */
+    s3Key: string;
+    /**
+     * The temporary url to upload the import file to, with a `PUT` and a `Content-Type` of
+     * `text/csv` or `application/json` matching the requested format. The client does not upload
+     * the file, upload it yourself: the upload is what starts the import
+     */
+    uploadUrl: string;
+    /**
+     * The number of seconds [[uploadUrl]] stays valid for
+     */
+    expiresInSeconds: number;
+};
+/**
+ * This type represent the data needed to make a list content import requests API request
+ */
+export type ListContentImportRequestsRequest = {
+    /**
+     * The import requests to skip (used to paginate the result), defaults to 0
+     */
+    skip?: number;
+    /**
+     * The import requests to take (used to paginate the result), defaults to 20.
+     * Cannot exceed [[MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE]]
+     */
+    take?: number;
+};
+/**
+ * This type represent the response of a list content import requests API request,
+ * sorted by [[ContentImportRequestResponse.createdDate]] descending
+ */
+export type ListContentImportRequestsResponse = PagedListResponse<ContentImportRequestResponse>;
+/**
+ * This type represent the error attached to a single failed imported row
+ */
+export type ContentImportItemError = {
+    /**
+     * The error code discriminator
+     */
+    code: string;
+    /**
+     * The human readable error message
+     */
+    message?: string;
+    /**
+     * The error additional details, their shape depends on [[code]]
+     */
+    details?: any;
+};
+/**
+ * This type represent the outcome of a single row of a content import. One item is written per
+ * content row plus one per translation row, so a content with 3 translated locales produces 4 items
+ */
+export type ContentImportRequestItemResponse = {
+    /**
+     * The content import request item unique id
+     */
+    id: ContentImportRequestItemId;
+    /**
+     * The space the contents are imported in
+     */
+    spaceId: string;
+    /**
+     * The unique id of the import request the item belongs to
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The zero based position of the row in the import file
+     */
+    itemIndex: number;
+    /**
+     * The public id of the imported content, null when the row did not carry a readable one
+     */
+    publicId: string | null;
+    /**
+     * The mnemonic id of the imported content definition, null when the row did not carry a
+     * readable one
+     */
+    definitionMnemonicId: string | null;
+    /**
+     * Whether the row describes the content itself or one of its translations
+     */
+    rowType: ContentImportRowType;
+    /**
+     * The locale the row has been imported in. Always null when [[rowType]] is `content`:
+     * only translation rows are locale specific
+     */
+    locale: string | null;
+    /**
+     * What the import did to the content, null when the row failed
+     */
+    action: ContentImportItemAction | null;
+    /**
+     * The outcome of the row
+     */
+    status: ContentImportItemStatus;
+    /**
+     * The unique id of the imported content, null when the row failed before the content
+     * could be resolved
+     */
+    contentId: ContentId | null;
+    /**
+     * The error describing why the row failed, null unless [[status]] is `failed`
+     */
+    error: ContentImportItemError | null;
+};
+/**
+ * This type represent the data needed to make a list content import request items API request
+ */
+export type ListContentImportRequestItemsRequest = {
+    /**
+     * The unique id of the import request to list the items of
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The items to skip (used to paginate the result), defaults to 0
+     */
+    skip?: number;
+    /**
+     * The items to take (used to paginate the result), defaults to 50.
+     * Cannot exceed [[MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE]]
+     */
+    take?: number;
+    /**
+     * This filter is used to list only the items with the given outcome, typically `failed` to
+     * review what an import could not apply. When omitted every item is returned
+     */
+    status?: ContentImportItemStatus;
+};
+/**
+ * This type represent the response of a list content import request items API request
+ */
+export type ListContentImportRequestItemsResponse = PagedListResponse<ContentImportRequestItemResponse>;
+/**
+ * The maximum number of items a content export or import list API request can take in a single page
+ */
+export declare const MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE = 100;

package/dist/api/ContentExportImport.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE = exports.ContentImportItemAction = exports.ContentImportItemStatus = exports.ContentImportRowType = exports.ContentImportStatus = exports.ContentExportStatus = exports.ContentExportFormat = void 0;
+/**
+ * This enum represent the file format of a content export, and the format an import file is read with
+ */
+var ContentExportFormat;
+(function (ContentExportFormat) {
+    ContentExportFormat["JSON"] = "json";
+    ContentExportFormat["CSV"] = "csv";
+})(ContentExportFormat || (exports.ContentExportFormat = ContentExportFormat = {}));
+/**
+ * This enum represent the lifecycle of a content export request. Exports are processed
+ * asynchronously, so a freshly created request is always `queued`
+ */
+var ContentExportStatus;
+(function (ContentExportStatus) {
+    ContentExportStatus["QUEUED"] = "queued";
+    ContentExportStatus["PROCESSING"] = "processing";
+    ContentExportStatus["COMPLETED"] = "completed";
+    ContentExportStatus["FAILED"] = "failed";
+})(ContentExportStatus || (exports.ContentExportStatus = ContentExportStatus = {}));
+/**
+ * This enum represent the lifecycle of a content import request. A freshly created request is
+ * `awaiting_upload` until the import file is uploaded to
+ * [[CreateContentImportRequestResponse.uploadUrl]], which is what starts the import
+ */
+var ContentImportStatus;
+(function (ContentImportStatus) {
+    ContentImportStatus["AWAITING_UPLOAD"] = "awaiting_upload";
+    ContentImportStatus["PROCESSING"] = "processing";
+    ContentImportStatus["COMPLETED"] = "completed";
+    ContentImportStatus["COMPLETED_WITH_ERRORS"] = "completed_with_errors";
+    ContentImportStatus["FAILED"] = "failed";
+})(ContentImportStatus || (exports.ContentImportStatus = ContentImportStatus = {}));
+/**
+ * This enum represent what an imported row describes: the content itself or one of its translations
+ */
+var ContentImportRowType;
+(function (ContentImportRowType) {
+    ContentImportRowType["CONTENT"] = "content";
+    ContentImportRowType["TRANSLATION"] = "translation";
+})(ContentImportRowType || (exports.ContentImportRowType = ContentImportRowType = {}));
+/**
+ * This enum represent the outcome of a single imported row
+ */
+var ContentImportItemStatus;
+(function (ContentImportItemStatus) {
+    ContentImportItemStatus["SUCCESS"] = "success";
+    ContentImportItemStatus["FAILED"] = "failed";
+})(ContentImportItemStatus || (exports.ContentImportItemStatus = ContentImportItemStatus = {}));
+/**
+ * This enum represent what the import did to the content of a successfully imported row
+ */
+var ContentImportItemAction;
+(function (ContentImportItemAction) {
+    ContentImportItemAction["UPDATED"] = "updated";
+})(ContentImportItemAction || (exports.ContentImportItemAction = ContentImportItemAction = {}));
+/**
+ * The maximum number of items a content export or import list API request can take in a single page
+ */
+exports.MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE = 100;

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/index.d.ts

@@ -5,6 +5,7 @@ export * from './Channel';
 export * from './Content';
 export * from './ContentDefinition';
 export * from './ContentDefinitionSchema';
+export * from './ContentExportImport';
 export * from './ContentRepository';
 export * from './ContentTag';
 export * from './Invites';

package/dist/api/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./Channel"), exports);
 __exportStar(require("./Content"), exports);
 __exportStar(require("./ContentDefinition"), exports);
 __exportStar(require("./ContentDefinitionSchema"), exports);
+__exportStar(require("./ContentExportImport"), exports);
 __exportStar(require("./ContentRepository"), exports);
 __exportStar(require("./ContentTag"), exports);
 __exportStar(require("./Invites"), exports);

package/lib/api/ContentExportImport.ts

@@ -0,0 +1,510 @@
+import { AuthorResponse } from './Author';
+import { PagedListResponse } from './common';
+import { ContentId, ListContentsFilters } from './Content';
+
+/**
+ * The content export request unique id
+ */
+export type ContentExportRequestId = number;
+
+/**
+ * The content import request unique id
+ */
+export type ContentImportRequestId = number;
+
+/**
+ * The content import request item unique id
+ */
+export type ContentImportRequestItemId = number;
+
+/**
+ * This enum represent the file format of a content export, and the format an import file is read with
+ */
+export enum ContentExportFormat {
+    JSON = 'json',
+    CSV = 'csv'
+}
+
+/**
+ * This enum represent the lifecycle of a content export request. Exports are processed
+ * asynchronously, so a freshly created request is always `queued`
+ */
+export enum ContentExportStatus {
+    QUEUED = 'queued',
+    PROCESSING = 'processing',
+    COMPLETED = 'completed',
+    FAILED = 'failed'
+}
+
+/**
+ * This enum represent the lifecycle of a content import request. A freshly created request is
+ * `awaiting_upload` until the import file is uploaded to
+ * [[CreateContentImportRequestResponse.uploadUrl]], which is what starts the import
+ */
+export enum ContentImportStatus {
+    AWAITING_UPLOAD = 'awaiting_upload',
+    PROCESSING = 'processing',
+    COMPLETED = 'completed',
+    COMPLETED_WITH_ERRORS = 'completed_with_errors',
+    FAILED = 'failed'
+}
+
+/**
+ * This enum represent what an imported row describes: the content itself or one of its translations
+ */
+export enum ContentImportRowType {
+    CONTENT = 'content',
+    TRANSLATION = 'translation'
+}
+
+/**
+ * This enum represent the outcome of a single imported row
+ */
+export enum ContentImportItemStatus {
+    SUCCESS = 'success',
+    FAILED = 'failed'
+}
+
+/**
+ * This enum represent what the import did to the content of a successfully imported row
+ */
+export enum ContentImportItemAction {
+    UPDATED = 'updated'
+}
+
+/**
+ * This type represent the error attached to a failed content export or import request
+ */
+export type ContentExportImportError = {
+    /**
+     * The error type discriminator
+     */
+    type: string;
+    /**
+     * The human readable error message
+     */
+    message: string;
+};
+
+/**
+ * This type represent one of the files produced by a content export, one per exported content
+ * definition. Files are appended as soon as they are uploaded, so a still `processing` export
+ * already lists the files that can be downloaded
+ */
+export type ContentExportFile = {
+    /**
+     * The mnemonic id of the content definition the file contains the contents of
+     */
+    definitionMnemonicId: string;
+    /**
+     * The internal storage key of the file. Not fetchable as is, pass
+     * [[definitionMnemonicId]] to [[ContentExportImportFacade.downloadExport]] to get a
+     * downloadable url
+     */
+    s3Key: string;
+    /**
+     * The number of contents written in the file
+     */
+    itemCount: number;
+};
+
+/**
+ * This type represent the model of a content export request
+ */
+export type ContentExportRequestResponse = {
+    /**
+     * The content export request unique id
+     */
+    id: ContentExportRequestId;
+    /**
+     * The space the exported contents belong to
+     */
+    spaceId: string;
+    /**
+     * The current status of the export
+     */
+    status: ContentExportStatus;
+    /**
+     * The filters the exported contents have been selected with
+     */
+    filters: ListContentsFilters;
+    /**
+     * The format the export files are written in
+     */
+    format: ContentExportFormat;
+    /**
+     * The separator used by the exported csv files. Meaningless when [[format]] is `json`
+     */
+    csvSeparator: string;
+    /**
+     * The files produced so far, one per exported content definition.
+     * Null until the export starts producing them
+     */
+    files: ContentExportFile[] | null;
+    /**
+     * The error describing why the export failed, null unless [[status]] is `failed`
+     */
+    error: ContentExportImportError | null;
+    /**
+     * The author that requested the export
+     */
+    author: AuthorResponse;
+    /**
+     * The last author that modified the export request. Only returned by
+     * [[ContentExportImportFacade.createExport]], the listing does not resolve it
+     */
+    latestContributor?: AuthorResponse;
+    /**
+     * The export request creation date
+     */
+    createdDate: Date;
+    /**
+     * The export request last modified date
+     */
+    lastModifiedDate: Date;
+};
+
+/**
+ * This type represent the data needed to make a create content export request API request
+ */
+export type CreateContentExportRequestRequest = {
+    /**
+     * The filters selecting the contents to export, the same ones accepted by
+     * [[ContentFacade.list]]. When omitted every unarchived content of the space is exported.
+     * Archived contents cannot be imported back, so [[ListContentsFilters.contentsStatus]]
+     * defaults to `unarchived`
+     */
+    filters?: Partial<ListContentsFilters>;
+    /**
+     * The format to write the export files in, defaults to `json`
+     */
+    format?: ContentExportFormat;
+    /**
+     * The single character separator to write the exported csv files with, defaults to `,`.
+     * Ignored when [[format]] is `json`
+     */
+    csvSeparator?: string;
+};
+
+/**
+ * This type represent the response of a create content export request API request.
+ * The returned export is always `queued`: it is processed asynchronously
+ */
+export type CreateContentExportRequestResponse = ContentExportRequestResponse;
+
+/**
+ * This type represent the data needed to make a list content export requests API request
+ */
+export type ListContentExportRequestsRequest = {
+    /**
+     * The export requests to skip (used to paginate the result), defaults to 0
+     */
+    skip?: number;
+    /**
+     * The export requests to take (used to paginate the result), defaults to 20.
+     * Cannot exceed [[MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE]]
+     */
+    take?: number;
+};
+
+/**
+ * This type represent the response of a list content export requests API request,
+ * sorted by [[ContentExportRequestResponse.createdDate]] descending
+ */
+export type ListContentExportRequestsResponse = PagedListResponse<ContentExportRequestResponse>;
+
+/**
+ * This type represent the data needed to make a download content export API request
+ */
+export type DownloadContentExportRequest = {
+    /**
+     * The unique id of the completed export request to download a file of
+     */
+    exportRequestId: ContentExportRequestId;
+    /**
+     * The mnemonic id of the content definition whose exported file is wanted.
+     * It must be one of the [[ContentExportRequestResponse.files]] entries
+     */
+    definitionMnemonicId: string;
+};
+
+/**
+ * This type represent the response of a download content export API request
+ */
+export type DownloadContentExportResponse = {
+    /**
+     * The mnemonic id of the content definition the file contains the contents of
+     */
+    definitionMnemonicId: string;
+    /**
+     * The temporary url to download the exported file from. The client does not download the
+     * file, fetch this url yourself
+     */
+    downloadUrl: string;
+    /**
+     * The number of seconds [[downloadUrl]] stays valid for
+     */
+    expiresInSeconds: number;
+    /**
+     * The number of contents written in the file
+     */
+    itemCount: number;
+};
+
+/**
+ * This type represent the options a content import file is read with
+ */
+export type ContentImportOptions = {
+    /**
+     * The format the import file is read as
+     */
+    format: ContentExportFormat;
+    /**
+     * The separator the imported csv file is read with. Meaningless when [[format]] is `json`
+     */
+    csvSeparator?: string;
+};
+
+/**
+ * This type represent the model of a content import request
+ */
+export type ContentImportRequestResponse = {
+    /**
+     * The content import request unique id
+     */
+    id: ContentImportRequestId;
+    /**
+     * The space the contents are imported in
+     */
+    spaceId: string;
+    /**
+     * The current status of the import
+     */
+    status: ContentImportStatus;
+    /**
+     * The name of the uploaded file, as declared when the import was created. Null when not declared
+     */
+    fileName: string | null;
+    /**
+     * The storage key the import file is expected at
+     */
+    s3Key: string;
+    /**
+     * The options the import file is read with
+     */
+    options: ContentImportOptions;
+    /**
+     * The arn of the workflow execution processing the import.
+     * Null while the import is still `awaiting_upload`
+     */
+    executionArn: string | null;
+    /**
+     * The number of rows found in the import file, null until the file has been read
+     */
+    totalItems: number | null;
+    /**
+     * The number of successfully imported rows, null until the import completes
+     */
+    succeededItems: number | null;
+    /**
+     * The number of rows that failed to import, null until the import completes.
+     * When greater than 0 the [[status]] is `completed_with_errors`
+     */
+    failedItems: number | null;
+    /**
+     * The error describing why the whole import failed, null unless [[status]] is `failed`.
+     * Single row failures are reported by [[ContentImportRequestItemResponse.error]] instead
+     */
+    error: ContentExportImportError | null;
+    /**
+     * The author that requested the import
+     */
+    author: AuthorResponse;
+    /**
+     * The import request creation date
+     */
+    createdDate: Date;
+    /**
+     * The import request last modified date
+     */
+    lastModifiedDate: Date;
+};
+
+/**
+ * This type represent the data needed to make a create content import request API request
+ */
+export type CreateContentImportRequestRequest = {
+    /**
+     * The name of the file about to be uploaded, kept for display purposes only
+     */
+    fileName?: string;
+    /**
+     * The options to read the uploaded file with
+     */
+    options?: {
+        /**
+         * The format the uploaded file is read as, defaults to `json`
+         */
+        format?: ContentExportFormat;
+        /**
+         * The single character separator the uploaded csv file is read with, defaults to `,`.
+         * Ignored when [[format]] is `json`
+         */
+        csvSeparator?: string;
+    };
+};
+
+/**
+ * This type represent the response of a create content import request API request
+ */
+export type CreateContentImportRequestResponse = {
+    /**
+     * The created content import request unique id
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The storage key the file is uploaded to
+     */
+    s3Key: string;
+    /**
+     * The temporary url to upload the import file to, with a `PUT` and a `Content-Type` of
+     * `text/csv` or `application/json` matching the requested format. The client does not upload
+     * the file, upload it yourself: the upload is what starts the import
+     */
+    uploadUrl: string;
+    /**
+     * The number of seconds [[uploadUrl]] stays valid for
+     */
+    expiresInSeconds: number;
+};
+
+/**
+ * This type represent the data needed to make a list content import requests API request
+ */
+export type ListContentImportRequestsRequest = {
+    /**
+     * The import requests to skip (used to paginate the result), defaults to 0
+     */
+    skip?: number;
+    /**
+     * The import requests to take (used to paginate the result), defaults to 20.
+     * Cannot exceed [[MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE]]
+     */
+    take?: number;
+};
+
+/**
+ * This type represent the response of a list content import requests API request,
+ * sorted by [[ContentImportRequestResponse.createdDate]] descending
+ */
+export type ListContentImportRequestsResponse = PagedListResponse<ContentImportRequestResponse>;
+
+/**
+ * This type represent the error attached to a single failed imported row
+ */
+export type ContentImportItemError = {
+    /**
+     * The error code discriminator
+     */
+    code: string;
+    /**
+     * The human readable error message
+     */
+    message?: string;
+    /**
+     * The error additional details, their shape depends on [[code]]
+     */
+    details?: any;
+};
+
+/**
+ * This type represent the outcome of a single row of a content import. One item is written per
+ * content row plus one per translation row, so a content with 3 translated locales produces 4 items
+ */
+export type ContentImportRequestItemResponse = {
+    /**
+     * The content import request item unique id
+     */
+    id: ContentImportRequestItemId;
+    /**
+     * The space the contents are imported in
+     */
+    spaceId: string;
+    /**
+     * The unique id of the import request the item belongs to
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The zero based position of the row in the import file
+     */
+    itemIndex: number;
+    /**
+     * The public id of the imported content, null when the row did not carry a readable one
+     */
+    publicId: string | null;
+    /**
+     * The mnemonic id of the imported content definition, null when the row did not carry a
+     * readable one
+     */
+    definitionMnemonicId: string | null;
+    /**
+     * Whether the row describes the content itself or one of its translations
+     */
+    rowType: ContentImportRowType;
+    /**
+     * The locale the row has been imported in. Always null when [[rowType]] is `content`:
+     * only translation rows are locale specific
+     */
+    locale: string | null;
+    /**
+     * What the import did to the content, null when the row failed
+     */
+    action: ContentImportItemAction | null;
+    /**
+     * The outcome of the row
+     */
+    status: ContentImportItemStatus;
+    /**
+     * The unique id of the imported content, null when the row failed before the content
+     * could be resolved
+     */
+    contentId: ContentId | null;
+    /**
+     * The error describing why the row failed, null unless [[status]] is `failed`
+     */
+    error: ContentImportItemError | null;
+};
+
+/**
+ * This type represent the data needed to make a list content import request items API request
+ */
+export type ListContentImportRequestItemsRequest = {
+    /**
+     * The unique id of the import request to list the items of
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The items to skip (used to paginate the result), defaults to 0
+     */
+    skip?: number;
+    /**
+     * The items to take (used to paginate the result), defaults to 50.
+     * Cannot exceed [[MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE]]
+     */
+    take?: number;
+    /**
+     * This filter is used to list only the items with the given outcome, typically `failed` to
+     * review what an import could not apply. When omitted every item is returned
+     */
+    status?: ContentImportItemStatus;
+};
+
+/**
+ * This type represent the response of a list content import request items API request
+ */
+export type ListContentImportRequestItemsResponse = PagedListResponse<ContentImportRequestItemResponse>;
+
+/**
+ * The maximum number of items a content export or import list API request can take in a single page
+ */
+export const MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE = 100;

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/index.ts

@@ -5,6 +5,7 @@ export * from './Channel';
 export * from './Content';
 export * from './ContentDefinition';
 export * from './ContentDefinitionSchema';
+export * from './ContentExportImport';
 export * from './ContentRepository';
 export * from './ContentTag';
 export * from './Invites';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.1.0-alpha.6",
+  "version": "10.1.0-alpha.8",
   "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": "44d000ee30bfadef421bea413b472ee5290a1000"
+  "gitHead": "972240c74e54c066563cc1460d5331bbfc9c0d65"
 }