@contentchef/contentchef-types 2.6.0 → 3.0.0-alpha.0

package/dist/api/PublishedContent.d.ts

@@ -1,7 +1,8 @@
-import { ContentId } from './Content';
-import { AuthorResponse } from './Author';
-import { ContentRepositoryId } from './ContentRepository';
-import { ContentTranslationStatus } from './ContentTranslation';
+import { ContentId } from "./Content";
+import { AuthorResponse } from "./Author";
+import { ContentRepositoryId } from "./ContentRepository";
+import { ContentTranslationStatus } from "./ContentTranslation";
+import { PagedListResponse } from "./common";
 /**
  * The published content unique id
  */
@@ -166,8 +167,8 @@ export type PublishedContentResponse = {
      */
     createdDate: Date;
     /**
-    * The update date of the related content
-    */
+     * The update date of the related content
+     */
     lastModifiedDate: Date;
     /**
      * The creator of the content
@@ -194,7 +195,16 @@ export type CreateReleaseRequest = {};
 /**
  * This type represent the response of a create release API request
  */
-export type CreateReleaseResponse = Release;
+export type CreateReleaseResponse = {
+    /**
+     * The release unique id
+     */
+    releaseId: ReleaseId;
+    /**
+     * The number of items in the release
+     */
+    releaseItemsCount: number;
+};
 /**
  * This type represent the data needed to make an update release API request
  */
@@ -220,3 +230,24 @@ export type UpdateReleaseResponse = Release;
  * This type represent the response of a get published content API request
  */
 export type GetPublishedContentResponse = PublishedContentResponse | undefined;
+/**
+ * This type represent the data needed to make a list release items API request
+ */
+export type ListReleaseItemsRequest = {
+    /**
+     * The release id to retrieve items from
+     */
+    releaseId: number;
+    /**
+     * The contents to skip (used to paginate the result)
+     */
+    skip: number;
+    /**
+     * The contents to take (used to paginate the result)
+     */
+    take: number;
+};
+/**
+ * This type represent the response of the list release items API request
+ */
+export type ListReleaseItemsResponse = PagedListResponse<ReleaseItem>;

package/lib/api/PublishedContent.ts

@@ -1,7 +1,8 @@
-import { ContentId } from './Content';
-import { AuthorResponse } from './Author';
-import { ContentRepositoryId } from './ContentRepository';
-import { ContentTranslationStatus } from './ContentTranslation';
+import { ContentId } from "./Content";
+import { AuthorResponse } from "./Author";
+import { ContentRepositoryId } from "./ContentRepository";
+import { ContentTranslationStatus } from "./ContentTranslation";
+import { PagedListResponse } from "./common";
 
 /**
  * The published content unique id
@@ -20,175 +21,175 @@ export type ReleaseItemId = number;
  * This type represent the model of a release item
  */
 export type ReleaseItem = {
-    /**
-     * The release item unique id
-     */
-    id: ReleaseItemId;
-    /**
-     * The release item related space id
-     */
-    spaceId: string;
-    /**
-     * The release item related content name
-     */
-    contentName: string;
-    /**
-     * The release item related content id
-     */
-    contentId: ContentId;
-    /**
-     * The release item related content tags
-     */
-    contentTags: string[];
-    /**
-     * The release item related content definition mnemonic id
-     */
-    contentDefinitionMnemonicId: string;
-    /**
-     * The release item related content repository unique id
-     */
-    contentRepositoryId: ContentRepositoryId;
-    /**
-     * The release item related content published id
-     */
-    publishedContentId: PublishedContentId;
-    /**
-     * The release item related content public id
-     */
-    publicId: string;
-    /**
-     * The release item related content online date
-     */
-    onlineDate?: Date;
-    /**
-     * The release item related content offline date
-     */
-    offlineDate?: Date;
-    /**
-     * Mark if the release item have to be publish
-     */
-    toPublish: boolean;
+  /**
+   * The release item unique id
+   */
+  id: ReleaseItemId;
+  /**
+   * The release item related space id
+   */
+  spaceId: string;
+  /**
+   * The release item related content name
+   */
+  contentName: string;
+  /**
+   * The release item related content id
+   */
+  contentId: ContentId;
+  /**
+   * The release item related content tags
+   */
+  contentTags: string[];
+  /**
+   * The release item related content definition mnemonic id
+   */
+  contentDefinitionMnemonicId: string;
+  /**
+   * The release item related content repository unique id
+   */
+  contentRepositoryId: ContentRepositoryId;
+  /**
+   * The release item related content published id
+   */
+  publishedContentId: PublishedContentId;
+  /**
+   * The release item related content public id
+   */
+  publicId: string;
+  /**
+   * The release item related content online date
+   */
+  onlineDate?: Date;
+  /**
+   * The release item related content offline date
+   */
+  offlineDate?: Date;
+  /**
+   * Mark if the release item have to be publish
+   */
+  toPublish: boolean;
 
-    /**
-     * Content`s locale
-     */
-    contentLocale: string;
-    /**
-     * Status of the ContentTranslation (defined if content is derived from a translation)
-     */
-    translationStatus?: ContentTranslationStatus;
+  /**
+   * Content`s locale
+   */
+  contentLocale: string;
+  /**
+   * Status of the ContentTranslation (defined if content is derived from a translation)
+   */
+  translationStatus?: ContentTranslationStatus;
 };
 
 /**
  * This type represent the model of a release
  */
 export type Release = {
-    /**
-     * The Release unique id
-     */
-    id: ReleaseId;
-    /**
-     * The release related space id
-     */
-    spaceId: string;
-    /**
-     * The list of content item in the release
-     */
-    releaseItems: ReleaseItem[];
-    /**
-     * Mark if the release is archived
-     */
-    archived: boolean;
+  /**
+   * The Release unique id
+   */
+  id: ReleaseId;
+  /**
+   * The release related space id
+   */
+  spaceId: string;
+  /**
+   * The list of content item in the release
+   */
+  releaseItems: ReleaseItem[];
+  /**
+   * Mark if the release is archived
+   */
+  archived: boolean;
 };
 
 /**
  * This type represent the data needed to make a get published content API request
  */
 export type GetPublishedContentRequest = {
-    /**
-     * This published content public id
-     */
-    publicId: string;
-    /**
-     * The date where to find the published content
-     */
-    targetDate?: Date;
-    /**
-     * This publishing channel of the content
-     */
-    publishingChannel: string;
+  /**
+   * This published content public id
+   */
+  publicId: string;
+  /**
+   * The date where to find the published content
+   */
+  targetDate?: Date;
+  /**
+   * This publishing channel of the content
+   */
+  publishingChannel: string;
 };
 
 /**
  * This type represent the model of a published content
  */
 export type PublishedContentResponse = {
-    /**
-     * The published content unique id
-     */
-    id: PublishedContentId;
-    /**
-     * The related content unique id
-     */
-    contentId: ContentId
-    /**
-     * The published content current version
-     */
-    contentVersion: number;
-    /**
-     * The publishing channels where the content is published
-     */
-    contentChannels: string[];
-    /**
-     * The published content tags
-     */
-    contentTags: string[];
-    /**
-     * The published content related content definition mnemonic id
-     */
-    contentDefinitionMnemonicId: string;
-    /**
-     * The published content related content repository id
-     */
-    contentRepositoryId: ContentRepositoryId;
-    /**
-     * The published content public id
-     */
-    publicId: string;
-    /**
-     * The published content payload
-     */
-    payload: object;
-    /**
-     * The published content online date
-     */
-    onlineDate?: Date;
-    /**
-     * The published content offline date
-     */
-    offlineDate?: Date;
-    /**
-     * The creation date of the related content
-     */
-    createdDate: Date;
-    /**
-    * The update date of the related content
-    */
-    lastModifiedDate: Date;
-    /**
-     * The creator of the content
-     */
-    author: AuthorResponse;
+  /**
+   * The published content unique id
+   */
+  id: PublishedContentId;
+  /**
+   * The related content unique id
+   */
+  contentId: ContentId;
+  /**
+   * The published content current version
+   */
+  contentVersion: number;
+  /**
+   * The publishing channels where the content is published
+   */
+  contentChannels: string[];
+  /**
+   * The published content tags
+   */
+  contentTags: string[];
+  /**
+   * The published content related content definition mnemonic id
+   */
+  contentDefinitionMnemonicId: string;
+  /**
+   * The published content related content repository id
+   */
+  contentRepositoryId: ContentRepositoryId;
+  /**
+   * The published content public id
+   */
+  publicId: string;
+  /**
+   * The published content payload
+   */
+  payload: object;
+  /**
+   * The published content online date
+   */
+  onlineDate?: Date;
+  /**
+   * The published content offline date
+   */
+  offlineDate?: Date;
+  /**
+   * The creation date of the related content
+   */
+  createdDate: Date;
+  /**
+   * The update date of the related content
+   */
+  lastModifiedDate: Date;
+  /**
+   * The creator of the content
+   */
+  author: AuthorResponse;
 };
 
 /**
  * This type represent the data needed to make a set stage content to live API request
  */
 export type SetStageContentsToLiveRequest = {
-    /**
-     * The release id to publish to live
-     */
-    releaseId: ReleaseId;
+  /**
+   * The release id to publish to live
+   */
+  releaseId: ReleaseId;
 };
 
 /**
@@ -201,27 +202,36 @@ export type SetStageContentsToLiveResponse = {};
  */
 export type CreateReleaseRequest = {};
 
-/**
- * This type represent the response of a create release API request
- */
-export type CreateReleaseResponse = Release;
+/**
+ * This type represent the response of a create release API request
+ */
+export type CreateReleaseResponse = {
+  /**
+   * The release unique id
+   */
+  releaseId: ReleaseId;
+  /**
+   * The number of items in the release
+   */
+  releaseItemsCount: number;
+};
 
 /**
  * This type represent the data needed to make an update release API request
  */
 export type UpdateReleaseRequest = {
-    /**
-     * The release unique id to update
-     */
-    releaseId: ReleaseId;
-    /**
-     * The release item to publish
-     */
-    itemsToPromote: ReleaseItemId[];
-    /**
-     * Mark if all the puslished content in stage have to be publish to live
-     */
-    includeAll?: boolean;
+  /**
+   * The release unique id to update
+   */
+  releaseId: ReleaseId;
+  /**
+   * The release item to publish
+   */
+  itemsToPromote: ReleaseItemId[];
+  /**
+   * Mark if all the puslished content in stage have to be publish to live
+   */
+  includeAll?: boolean;
 };
 
 /**
@@ -233,3 +243,26 @@ export type UpdateReleaseResponse = Release;
  * This type represent the response of a get published content API request
  */
 export type GetPublishedContentResponse = PublishedContentResponse | undefined;
+
+/**
+ * This type represent the data needed to make a list release items API request
+ */
+export type ListReleaseItemsRequest = {
+  /**
+   * The release id to retrieve items from
+   */
+  releaseId: number;
+  /**
+   * The contents to skip (used to paginate the result)
+   */
+  skip: number;
+  /**
+   * The contents to take (used to paginate the result)
+   */
+  take: number;
+};
+
+/**
+ * This type represent the response of the list release items API request
+ */
+export type ListReleaseItemsResponse = PagedListResponse<ReleaseItem>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "2.6.0",
+  "version": "3.0.0-alpha.0",
   "description": "ContentChef types",
   "author": "PierpaoloIannone <piannone@byte-code.com>",
   "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",