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

package/dist/api/AccessToken.d.ts

@@ -1,7 +1,7 @@
 /**
  * This type represent the model of an access token
  */
-export declare type AccessTokenResponse = {
+export type AccessTokenResponse = {
     /**
      * The token reference name
      */
@@ -18,7 +18,7 @@ export declare type AccessTokenResponse = {
 /**
  * This type represent the data needed to make a create access token API request
  */
-export declare type CreateApiAccessTokenRequest = {
+export type CreateApiAccessTokenRequest = {
     /**
      * The token reference name
      */
@@ -27,11 +27,11 @@ export declare type CreateApiAccessTokenRequest = {
 /**
  * This type represent the data needed to make a list access token API request
  */
-export declare type ListApiAccessTokenRequest = {};
+export type ListApiAccessTokenRequest = {};
 /**
  * This type represent the data needed to make a revoke access token API request
  */
-export declare type RevokeApiAccessTokenRequest = {
+export type RevokeApiAccessTokenRequest = {
     /**
      * The unique token key
      */
@@ -40,7 +40,7 @@ export declare type RevokeApiAccessTokenRequest = {
 /**
  * This type represent the response of a create access token API request
  */
-export declare type CreateApiAccessTokenResponse = {
+export type CreateApiAccessTokenResponse = {
     /**
      * The signed token used valid to make api requests (store in a secure place)
      */
@@ -57,7 +57,7 @@ export declare type CreateApiAccessTokenResponse = {
 /**
  * This type represent the response of a list access token API request
  */
-export declare type ListApiAccessTokenResponse = {
+export type ListApiAccessTokenResponse = {
     /**
      * The list of tokens
      */
@@ -66,7 +66,7 @@ export declare type ListApiAccessTokenResponse = {
 /**
  * This type represent the response of a revoke access token API request
  */
-export declare type RevokeApiAccessTokenResponse = {
+export type RevokeApiAccessTokenResponse = {
     /**
      * The revoked token hash
      */

package/dist/api/AuditLog.d.ts

@@ -8,15 +8,15 @@ import { MediaGalleryId } from './MediaGallery';
 /**
  * This type represent the audit log unique id type
  */
-export declare type AuditLogId = number;
+export type AuditLogId = number;
 /**
  * This type represent the audit log item unique id types
  */
-export declare type SubjectId = ContentId | ContentRepositoryId | ContentDefinitionId | MediaGalleryId | PublishingChannelId;
+export type SubjectId = ContentId | ContentRepositoryId | ContentDefinitionId | MediaGalleryId | PublishingChannelId;
 /**
  * This type represent the audit log parent unique id types
  */
-export declare type ParentId = ContentId | ContentRepositoryId | ContentDefinitionId | MediaGalleryId | PublishingChannelId;
+export type ParentId = ContentId | ContentRepositoryId | ContentDefinitionId | MediaGalleryId | PublishingChannelId;
 /**
  * This enum represent the audit log allowed
  */
@@ -91,20 +91,20 @@ export declare enum SubjectActions {
 /**
  * This enum represent the audit log parent allowed types
  */
-export declare type ListAuditLogRequest = {
+export type ListAuditLogRequest = {
     skip: number;
     take: number;
     filters?: ListAuditLogFilters;
 };
-declare type LatestActivitesRequest<ToRemove extends keyof ListAuditLogFilters> = Omit<ListAuditLogRequest, 'filters'> & {
+type LatestActivitesRequest<ToRemove extends keyof ListAuditLogFilters> = Omit<ListAuditLogRequest, 'filters'> & {
     filters: Omit<ListAuditLogFilters, ToRemove>;
 };
-export declare type UserTeamLatestActivitiesRequest = LatestActivitesRequest<'userTeamLatestActivities'>;
-export declare type UserLatestActivitiesRequest = LatestActivitesRequest<'userLatestActivities'>;
+export type UserTeamLatestActivitiesRequest = LatestActivitesRequest<'userTeamLatestActivities'>;
+export type UserLatestActivitiesRequest = LatestActivitesRequest<'userLatestActivities'>;
 /**
  * This type represent all the filters used to filter a list of audit logs
  */
-export declare type ListAuditLogFilters = {
+export type ListAuditLogFilters = {
     /**
      * A string that a audit log must contain to be retrieved
      */
@@ -133,7 +133,7 @@ export declare type ListAuditLogFilters = {
 /**
  * The data needed to make a list of audit log filtered by repository
  */
-export declare type ListByRepositoryIdRequest = {
+export type ListByRepositoryIdRequest = {
     /**
      * The unique repository id
      */
@@ -142,7 +142,7 @@ export declare type ListByRepositoryIdRequest = {
 /**
  * The model the represent the audit log parent filter used in the list of audit logs
  */
-export declare type ListAuditLogParentFilter = {
+export type ListAuditLogParentFilter = {
     /**
      * The unique parent id
      */
@@ -155,7 +155,7 @@ export declare type ListAuditLogParentFilter = {
 /**
  * The model the represent the audit log item
  */
-export declare type ListAuditLogItem = {
+export type ListAuditLogItem = {
     /**
      * The unique audit log id
      */
@@ -200,5 +200,5 @@ export declare type ListAuditLogItem = {
 /**
  * This type represent the response of a list audit log API request
  */
-export declare type ListAuditLogResponse = PagedListResponse<ListAuditLogItem>;
+export type ListAuditLogResponse = PagedListResponse<ListAuditLogItem>;
 export {};

package/dist/api/AuditLog.js

@@ -26,7 +26,7 @@ var SubjectTypes;
      * When the subject is a publishing channel this value will be returned
      */
     SubjectTypes["publishingChannel"] = "publishing_channel";
-})(SubjectTypes = exports.SubjectTypes || (exports.SubjectTypes = {}));
+})(SubjectTypes || (exports.SubjectTypes = SubjectTypes = {}));
 /**
  * This enum represent the audit log parent allowed
  */
@@ -52,7 +52,7 @@ var ParentTypes;
      * When the parent is a publishing channel this value will be returned
      */
     ParentTypes["publishingChannel"] = "publishing_channel";
-})(ParentTypes = exports.ParentTypes || (exports.ParentTypes = {}));
+})(ParentTypes || (exports.ParentTypes = ParentTypes = {}));
 /**
  * This enum represent the audit log actions allowed
  */
@@ -74,4 +74,4 @@ var SubjectActions;
      * When the action is an unarchive this value will be returned
      */
     SubjectActions["unarchive"] = "unarchive";
-})(SubjectActions = exports.SubjectActions || (exports.SubjectActions = {}));
+})(SubjectActions || (exports.SubjectActions = SubjectActions = {}));

package/dist/api/Author.d.ts

@@ -1,7 +1,7 @@
 /**
  * This type represent the model of an author
  */
-export declare type AuthorResponse = {
+export type AuthorResponse = {
     /**
      * The unique author id
      */

package/dist/api/Channel.d.ts

@@ -2,11 +2,11 @@ import { AuthorResponse } from './Author';
 /**
  * This type represent the publishing channel unique id
  */
-export declare type PublishingChannelId = number;
+export type PublishingChannelId = number;
 /**
  * This type represent the data needed to make a create publishing channel API request
  */
-export declare type CreatePublishingChannelRequest = {
+export type CreatePublishingChannelRequest = {
     /**
      * The publishing channel name
      */
@@ -23,7 +23,7 @@ export declare type CreatePublishingChannelRequest = {
 /**
  * This type represent the model of a publishing channel
  */
-export declare type PublishingChannelResponse = {
+export type PublishingChannelResponse = {
     /**
      * The unique publishing channel id
      */
@@ -68,7 +68,7 @@ export declare type PublishingChannelResponse = {
 /**
  * This type represent the data needed to make a get publishing channel API request
  */
-export declare type GetPublishingChannelRequest = {
+export type GetPublishingChannelRequest = {
     /**
      * The publishing channel unique id
      */
@@ -77,7 +77,7 @@ export declare type GetPublishingChannelRequest = {
 /**
  * This type represent the data needed to make an update publishing channel API request
  */
-export declare type UpdatePublishingChannelRequest = {
+export type UpdatePublishingChannelRequest = {
     /**
      * The publishing channel unique id
      */
@@ -98,19 +98,19 @@ export declare type UpdatePublishingChannelRequest = {
 /**
  * This type represent the response of a create publishing channel API request
  */
-export declare type CreatePublishingChannelResponse = PublishingChannelResponse;
+export type CreatePublishingChannelResponse = PublishingChannelResponse;
 /**
  * This type represent the response of a get publishing channel API request
  */
-export declare type GetPublishingChannelResponse = PublishingChannelResponse;
+export type GetPublishingChannelResponse = PublishingChannelResponse;
 /**
  * This type represent the response of an update publishing channel API request
  */
-export declare type UpdatePublishingChannelResponse = PublishingChannelResponse;
+export type UpdatePublishingChannelResponse = PublishingChannelResponse;
 /**
  * Request for list in PublishingChannelFacade
  */
-export declare type ListPublishingChannelRequest = {
+export type ListPublishingChannelRequest = {
     /**
      * object whose property will be used to filter the list
      */
@@ -128,11 +128,11 @@ export declare type ListPublishingChannelRequest = {
 /**
  * This type represent the response of a list publishing channel API request
  */
-export declare type ListPublishingChannelsResponse = PublishingChannelResponse[];
+export type ListPublishingChannelsResponse = PublishingChannelResponse[];
 /**
  * Request for toggleArchived method on PublishingChannelFacade
  */
-export declare type ToggleArchivedPublishingChannelRequest = {
+export type ToggleArchivedPublishingChannelRequest = {
     /**
      * The unique publishing channel id
      */
@@ -145,4 +145,4 @@ export declare type ToggleArchivedPublishingChannelRequest = {
 /**
  * Response for toggleArchived method on PublishingChannelFacade
  */
-export declare type ToggleArchivedPublishingChannelResponse = PublishingChannelResponse;
+export type ToggleArchivedPublishingChannelResponse = PublishingChannelResponse;

package/dist/api/Content.d.ts

@@ -8,7 +8,7 @@ import { ContentTranslation, ContentTranslationStatus } from './ContentTranslati
 /**
  * This type represent the content unique id type
  */
-export declare type ContentId = number;
+export type ContentId = number;
 /**
  * This enum represent the possible content status
  */
@@ -20,7 +20,7 @@ export declare enum ContentsStatus {
 /**
  * This type represent the model of facet
  */
-export declare type Facet = {
+export type Facet = {
     /**
      * The key of the facet
      */
@@ -37,7 +37,7 @@ export declare type Facet = {
 /**
  * This type represent the model of an indexed content value
  */
-export declare type IndexedContent = {
+export type IndexedContent = {
     /**
      * THe list of facet field in a content
      */
@@ -64,11 +64,11 @@ export interface ArrayPathItem {
 /**
  * This type represent the linked content item field path inside the content
  */
-export declare type FieldPath = (ArrayPathItem | PathItem)[];
+export type FieldPath = (ArrayPathItem | PathItem)[];
 /**
  * This type represent the model of a linked content info inside a content
  */
-export declare type LinkedContentInfo = {
+export type LinkedContentInfo = {
     /**
      * The path to reach the linked content inside the content as an array of items
      */
@@ -85,7 +85,7 @@ export declare type LinkedContentInfo = {
 /**
  * This type represent the model of a linked contents inside the content retrieved
  */
-export declare type LinkedContentsInfo = {
+export type LinkedContentsInfo = {
     /**
      * The list of linked contents inside in the content retrieved
      */
@@ -94,7 +94,7 @@ export declare type LinkedContentsInfo = {
 /**
  * This type represent the model of a content publishing status
  */
-export declare type ContentStatus = {
+export type ContentStatus = {
     /**
      * The unique content id
      */
@@ -159,7 +159,7 @@ export declare type ContentStatus = {
 /**
  * This type represent the data needed to make a create content API request
  */
-export declare type CreateContentRequest = {
+export type CreateContentRequest = {
     /**
      * The content name
      */
@@ -204,11 +204,19 @@ export declare type CreateContentRequest = {
      * Controls if translations should be ignored when publishing
     */
     contentLocalizationSettings?: LocalizationSettings;
+    /**
+     * will bypass content definition mnemonicId validation for every linked-content field
+     */
+    bypassLinkedContentValidation?: boolean;
+    /**
+     * set an identifier coming from a third party application
+     */
+    externalIdentifier?: string;
 };
 /**
  * This type represent the data needed to make a update content API request
  */
-export declare type UpdateContentRequest = {
+export type UpdateContentRequest = {
     /**
      * The unique content id
      */
@@ -253,11 +261,19 @@ export declare type UpdateContentRequest = {
      * Controls if translations should be ignored when publishing
     */
     contentLocalizationSettings?: LocalizationSettings;
+    /**
+     * will bypass content definition mnemonicId validation for every linked-content field
+     */
+    bypassLinkedContentValidation?: boolean;
+    /**
+     * set an identifier coming from a third party application
+     */
+    externalIdentifier?: string;
 };
 /**
  * This type represent the data that can be used to filter a list of contents
  */
-export declare type ListContentsFilters = {
+export type ListContentsFilters = {
     /**
      * This filter is used to search contents that contain the value inserted
      */
@@ -294,7 +310,7 @@ export declare type ListContentsFilters = {
 /**
  * This type represent the data needed to make a list content API request
  */
-export declare type ListContentsRequest = {
+export type ListContentsRequest = {
     /**
      * The contents to skip (used to paginate the result)
      */
@@ -311,7 +327,7 @@ export declare type ListContentsRequest = {
 /**
  * This type represent the model of the single content returned from the list of content API request
  */
-export declare type ListContentsItem = {
+export type ListContentsItem = {
     /**
      * The unique content id
      */
@@ -422,11 +438,11 @@ export declare type ListContentsItem = {
 /**
  * This type represent the response of the list content API request
  */
-export declare type ListContentsResponse = PagedListResponse<ListContentsItem>;
+export type ListContentsResponse = PagedListResponse<ListContentsItem>;
 /**
  * This type represent the data needed to make a duplicate content API request
  */
-export declare type DuplicateContentRequest = {
+export type DuplicateContentRequest = {
     /**
      * The unique content id to duplicate
      */
@@ -435,7 +451,7 @@ export declare type DuplicateContentRequest = {
 /**
  * This type represent the response of the duplicate content API request
  */
-export declare type DuplicateContentResponse = {
+export type DuplicateContentResponse = {
     /**
      * The duplicated content unique id
      */
@@ -444,7 +460,7 @@ export declare type DuplicateContentResponse = {
 /**
  * This type represent the data needed to make a get content API request
  */
-export declare type GetContentRequest = {
+export type GetContentRequest = {
     /**
      * The unique content id to retrieve
      */
@@ -457,7 +473,7 @@ export declare type GetContentRequest = {
 /**
  * This type represent the model of a content
  */
-export declare type ContentResponse = {
+export type ContentResponse = {
     /**
      * The unique content id
      */
@@ -554,15 +570,19 @@ export declare type ContentResponse = {
      * Content's locale
      */
     locale: string;
+    /**
+     * Content's external identifier
+     */
+    externalIdentifier?: string;
 };
 /**
  * This type represent the model of a linked content
  */
-export declare type LinkingContents = ContentResponse;
+export type LinkingContents = ContentResponse;
 /**
  * This type represent the response of a get content API request
  */
-export declare type GetContentResponse = {
+export type GetContentResponse = {
     /**
      * The requested content
      */
@@ -575,15 +595,15 @@ export declare type GetContentResponse = {
 /**
  * This type represent the response of a create content API request
  */
-export declare type CreateContentResponse = ContentResponse;
+export type CreateContentResponse = ContentResponse;
 /**
  * This type represent the response of an update content API request
  */
-export declare type UpdateContentResponse = ContentResponse;
+export type UpdateContentResponse = ContentResponse;
 /**
  * This type represent the data needed to make a list public id API request
  */
-export declare type ListPublicIdsRequest = {
+export type ListPublicIdsRequest = {
     /**
      * The admitted filters in the request
      */
@@ -601,11 +621,11 @@ export declare type ListPublicIdsRequest = {
 /**
  * This type represent the response of a list public id API request
  */
-export declare type ListPublicIdsResponse = string[];
+export type ListPublicIdsResponse = string[];
 /**
  * This type represent the data needed to make a delete content API request
  */
-export declare type DeleteContentRequest = {
+export type DeleteContentRequest = {
     /**
      * The unique content id to delete
      */
@@ -614,11 +634,11 @@ export declare type DeleteContentRequest = {
 /**
  * This type represent the response of a delete content API request
  */
-export declare type DeleteContentResponse = ContentResponse;
+export type DeleteContentResponse = ContentResponse;
 /**
  * This type represent the data needed to make a toggle archive content API request
  */
-export declare type ToggleArchivedContentRequest = {
+export type ToggleArchivedContentRequest = {
     /**
      * The unique content id where to make the toggle archive request
      */
@@ -631,7 +651,7 @@ export declare type ToggleArchivedContentRequest = {
 /**
  * This type represent the response of a toggle archive content API request
  */
-export declare type ToggleArchivedContentResponse = ContentResponse;
+export type ToggleArchivedContentResponse = ContentResponse;
 /**
  * Thin enum represent all content fields violations error codes
  */
@@ -689,7 +709,7 @@ export declare enum ContentFieldViolationCodes {
 /**
  * Request type for getContentStatus
  */
-export declare type GetContentStatusRequest = {
+export type GetContentStatusRequest = {
     /**
      * Id of the content required to get its status
      */
@@ -698,11 +718,11 @@ export declare type GetContentStatusRequest = {
 /**
  * Response type for getContentStatus
  */
-export declare type GetContentStatusResponse = ContentStatus[];
+export type GetContentStatusResponse = ContentStatus[];
 /**
  * Request type for changeLocale
  */
-export declare type ChangeLocaleRequest = {
+export type ChangeLocaleRequest = {
     /**
      * Id of the content whose locale you'd like to change
      */
@@ -712,13 +732,13 @@ export declare type ChangeLocaleRequest = {
      */
     locale: string;
 };
-export declare type ChangeLocaleResponse = ContentResponse;
+export type ChangeLocaleResponse = ContentResponse;
 export declare enum LocalizationSettings {
     DEFAULT = "default",
     MAIN = "main"
 }
-export declare type ToggleContentTranslationsRequest = {
+export type ToggleContentTranslationsRequest = {
     contentId: ContentId;
     localizationSettings: LocalizationSettings;
 };
-export declare type ToggleContentTranslationsResponse = ContentResponse;
+export type ToggleContentTranslationsResponse = ContentResponse;

package/dist/api/Content.js

@@ -9,7 +9,7 @@ var ContentsStatus;
     ContentsStatus["archived"] = "archived";
     ContentsStatus["unarchived"] = "unarchived";
     ContentsStatus["all"] = "all";
-})(ContentsStatus = exports.ContentsStatus || (exports.ContentsStatus = {}));
+})(ContentsStatus || (exports.ContentsStatus = ContentsStatus = {}));
 /**
  * Thin enum represent all content fields violations error codes
  */
@@ -64,9 +64,9 @@ var ContentFieldViolationCodes;
     ContentFieldViolationCodes["textFieldValueMissingInListOfValue"] = "textField.valueMissingInListOfValue";
     ContentFieldViolationCodes["textFieldValueIsNotAString"] = "textField.valueIsNotAString";
     ContentFieldViolationCodes["textFieldBlankValueNotAllowed"] = "textField.blankValueNotAllowed";
-})(ContentFieldViolationCodes = exports.ContentFieldViolationCodes || (exports.ContentFieldViolationCodes = {}));
+})(ContentFieldViolationCodes || (exports.ContentFieldViolationCodes = ContentFieldViolationCodes = {}));
 var LocalizationSettings;
 (function (LocalizationSettings) {
     LocalizationSettings["DEFAULT"] = "default";
     LocalizationSettings["MAIN"] = "main";
-})(LocalizationSettings = exports.LocalizationSettings || (exports.LocalizationSettings = {}));
+})(LocalizationSettings || (exports.LocalizationSettings = LocalizationSettings = {}));