@contentchef/contentchef-types 10.0.0-alpha.5 → 10.1.0-alpha.0

package/dist/api/PublishingRequest.d.ts

@@ -119,3 +119,71 @@ export type ListPublishingRequestsResponse = PublishingRequestResponse[];
  * This type represent the response of a create publishing request API request
  */
 export type CreatePublishingRequestResponse = PublishingRequestResponse;
+/**
+ * The maximum number of items that can be sent in a single bulk publishing request
+ */
+export declare const MAX_BULK_PUBLISHING_REQUESTS = 50;
+/**
+ * This type represent a single item of a bulk publishing request
+ */
+export type BulkPublishingRequestItem = PublishingRequestRequest;
+/**
+ * This type represent the data needed to make a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestRequest = {
+    /**
+     * The list of contents (and their version) to create a publishing request for.
+     * Must contain between 1 and [[MAX_BULK_PUBLISHING_REQUESTS]] items.
+     * Duplicate content id / version pairs are deduplicated server-side.
+     */
+    requests: BulkPublishingRequestItem[];
+};
+/**
+ * This enum represent the outcome of a single item within a bulk publishing request
+ */
+export declare enum BulkPublishingRequestStatus {
+    ACCEPTED = "accepted",
+    FAILED = "failed"
+}
+/**
+ * This type represent the error attached to a failed bulk publishing request item
+ */
+export type BulkPublishingRequestError = {
+    /**
+     * The error type discriminator
+     */
+    type: string;
+    /**
+     * The human readable error message
+     */
+    message: string;
+};
+/**
+ * This type represent the outcome of a single item within a bulk publishing request
+ */
+export type BulkPublishingRequestResult = {
+    /**
+     * The content id the result refers to
+     */
+    contentId: number;
+    /**
+     * The content version the result refers to
+     */
+    contentVersion: number;
+    /**
+     * Whether the publishing request for this item was accepted or failed
+     */
+    status: BulkPublishingRequestStatus;
+    /**
+     * The created publishing request unique id, present only when [[status]] is `accepted`
+     */
+    publishingRequestId?: PublishingRequestId;
+    /**
+     * The error describing why the item failed, present only when [[status]] is `failed`
+     */
+    error?: BulkPublishingRequestError;
+};
+/**
+ * This type represent the response of a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestResponse = BulkPublishingRequestResult[];

package/dist/api/PublishingRequest.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PublishingStatus = void 0;
+exports.BulkPublishingRequestStatus = exports.MAX_BULK_PUBLISHING_REQUESTS = exports.PublishingStatus = void 0;
 /**
  * This enum represent the available publishing request status
  */
@@ -11,3 +11,15 @@ var PublishingStatus;
     PublishingStatus["PUBLISHED"] = "published";
     PublishingStatus["FAILED"] = "failed";
 })(PublishingStatus || (exports.PublishingStatus = PublishingStatus = {}));
+/**
+ * The maximum number of items that can be sent in a single bulk publishing request
+ */
+exports.MAX_BULK_PUBLISHING_REQUESTS = 50;
+/**
+ * This enum represent the outcome of a single item within a bulk publishing request
+ */
+var BulkPublishingRequestStatus;
+(function (BulkPublishingRequestStatus) {
+    BulkPublishingRequestStatus["ACCEPTED"] = "accepted";
+    BulkPublishingRequestStatus["FAILED"] = "failed";
+})(BulkPublishingRequestStatus || (exports.BulkPublishingRequestStatus = BulkPublishingRequestStatus = {}));

package/lib/api/PublishingRequest.ts

@@ -126,3 +126,78 @@ export type ListPublishingRequestsResponse = PublishingRequestResponse[];
  * This type represent the response of a create publishing request API request
  */
 export type CreatePublishingRequestResponse = PublishingRequestResponse;
+
+/**
+ * The maximum number of items that can be sent in a single bulk publishing request
+ */
+export const MAX_BULK_PUBLISHING_REQUESTS = 50;
+
+/**
+ * This type represent a single item of a bulk publishing request
+ */
+export type BulkPublishingRequestItem = PublishingRequestRequest;
+
+/**
+ * This type represent the data needed to make a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestRequest = {
+    /**
+     * The list of contents (and their version) to create a publishing request for.
+     * Must contain between 1 and [[MAX_BULK_PUBLISHING_REQUESTS]] items.
+     * Duplicate content id / version pairs are deduplicated server-side.
+     */
+    requests: BulkPublishingRequestItem[];
+};
+
+/**
+ * This enum represent the outcome of a single item within a bulk publishing request
+ */
+export enum BulkPublishingRequestStatus {
+    ACCEPTED = 'accepted',
+    FAILED = 'failed'
+}
+
+/**
+ * This type represent the error attached to a failed bulk publishing request item
+ */
+export type BulkPublishingRequestError = {
+    /**
+     * The error type discriminator
+     */
+    type: string;
+    /**
+     * The human readable error message
+     */
+    message: string;
+};
+
+/**
+ * This type represent the outcome of a single item within a bulk publishing request
+ */
+export type BulkPublishingRequestResult = {
+    /**
+     * The content id the result refers to
+     */
+    contentId: number;
+    /**
+     * The content version the result refers to
+     */
+    contentVersion: number;
+    /**
+     * Whether the publishing request for this item was accepted or failed
+     */
+    status: BulkPublishingRequestStatus;
+    /**
+     * The created publishing request unique id, present only when [[status]] is `accepted`
+     */
+    publishingRequestId?: PublishingRequestId;
+    /**
+     * The error describing why the item failed, present only when [[status]] is `failed`
+     */
+    error?: BulkPublishingRequestError;
+};
+
+/**
+ * This type represent the response of a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestResponse = BulkPublishingRequestResult[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.0.0-alpha.5",
+  "version": "10.1.0-alpha.0",
   "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": "baab29175bf34e3ecfb850bf9af1a6ba90c8a6ad"
+  "gitHead": "b8990446304be212c6953c04b2a148669d190cf9"
 }