@contentchef/contentchef-types 2.6.0 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
- import { ContentId } from './Content';
2
- import { AuthorResponse } from './Author';
3
- import { ContentRepositoryId } from './ContentRepository';
4
- import { ContentTranslationStatus } from './ContentTranslation';
1
+ import { ContentId } from "./Content";
2
+ import { AuthorResponse } from "./Author";
3
+ import { ContentRepositoryId } from "./ContentRepository";
4
+ import { ContentTranslationStatus } from "./ContentTranslation";
5
5
  /**
6
6
  * The published content unique id
7
7
  */
@@ -166,8 +166,8 @@ export type PublishedContentResponse = {
166
166
  */
167
167
  createdDate: Date;
168
168
  /**
169
- * The update date of the related content
170
- */
169
+ * The update date of the related content
170
+ */
171
171
  lastModifiedDate: Date;
172
172
  /**
173
173
  * The creator of the content
@@ -182,6 +182,10 @@ export type SetStageContentsToLiveRequest = {
182
182
  * The release id to publish to live
183
183
  */
184
184
  releaseId: ReleaseId;
185
+ /**
186
+ * Skip validating linked contents resolution
187
+ */
188
+ skipLinkedContentValidation: boolean;
185
189
  };
186
190
  /**
187
191
  * This type represent the response of a set stage content to live API request
@@ -1,7 +1,7 @@
1
- import { ContentId } from './Content';
2
- import { AuthorResponse } from './Author';
3
- import { ContentRepositoryId } from './ContentRepository';
4
- import { ContentTranslationStatus } from './ContentTranslation';
1
+ import { ContentId } from "./Content";
2
+ import { AuthorResponse } from "./Author";
3
+ import { ContentRepositoryId } from "./ContentRepository";
4
+ import { ContentTranslationStatus } from "./ContentTranslation";
5
5
 
6
6
  /**
7
7
  * The published content unique id
@@ -20,175 +20,180 @@ export type ReleaseItemId = number;
20
20
  * This type represent the model of a release item
21
21
  */
22
22
  export type ReleaseItem = {
23
- /**
24
- * The release item unique id
25
- */
26
- id: ReleaseItemId;
27
- /**
28
- * The release item related space id
29
- */
30
- spaceId: string;
31
- /**
32
- * The release item related content name
33
- */
34
- contentName: string;
35
- /**
36
- * The release item related content id
37
- */
38
- contentId: ContentId;
39
- /**
40
- * The release item related content tags
41
- */
42
- contentTags: string[];
43
- /**
44
- * The release item related content definition mnemonic id
45
- */
46
- contentDefinitionMnemonicId: string;
47
- /**
48
- * The release item related content repository unique id
49
- */
50
- contentRepositoryId: ContentRepositoryId;
51
- /**
52
- * The release item related content published id
53
- */
54
- publishedContentId: PublishedContentId;
55
- /**
56
- * The release item related content public id
57
- */
58
- publicId: string;
59
- /**
60
- * The release item related content online date
61
- */
62
- onlineDate?: Date;
63
- /**
64
- * The release item related content offline date
65
- */
66
- offlineDate?: Date;
67
- /**
68
- * Mark if the release item have to be publish
69
- */
70
- toPublish: boolean;
23
+ /**
24
+ * The release item unique id
25
+ */
26
+ id: ReleaseItemId;
27
+ /**
28
+ * The release item related space id
29
+ */
30
+ spaceId: string;
31
+ /**
32
+ * The release item related content name
33
+ */
34
+ contentName: string;
35
+ /**
36
+ * The release item related content id
37
+ */
38
+ contentId: ContentId;
39
+ /**
40
+ * The release item related content tags
41
+ */
42
+ contentTags: string[];
43
+ /**
44
+ * The release item related content definition mnemonic id
45
+ */
46
+ contentDefinitionMnemonicId: string;
47
+ /**
48
+ * The release item related content repository unique id
49
+ */
50
+ contentRepositoryId: ContentRepositoryId;
51
+ /**
52
+ * The release item related content published id
53
+ */
54
+ publishedContentId: PublishedContentId;
55
+ /**
56
+ * The release item related content public id
57
+ */
58
+ publicId: string;
59
+ /**
60
+ * The release item related content online date
61
+ */
62
+ onlineDate?: Date;
63
+ /**
64
+ * The release item related content offline date
65
+ */
66
+ offlineDate?: Date;
67
+ /**
68
+ * Mark if the release item have to be publish
69
+ */
70
+ toPublish: boolean;
71
71
 
72
- /**
73
- * Content`s locale
74
- */
75
- contentLocale: string;
76
- /**
77
- * Status of the ContentTranslation (defined if content is derived from a translation)
78
- */
79
- translationStatus?: ContentTranslationStatus;
72
+ /**
73
+ * Content`s locale
74
+ */
75
+ contentLocale: string;
76
+ /**
77
+ * Status of the ContentTranslation (defined if content is derived from a translation)
78
+ */
79
+ translationStatus?: ContentTranslationStatus;
80
80
  };
81
81
 
82
82
  /**
83
83
  * This type represent the model of a release
84
84
  */
85
85
  export type Release = {
86
- /**
87
- * The Release unique id
88
- */
89
- id: ReleaseId;
90
- /**
91
- * The release related space id
92
- */
93
- spaceId: string;
94
- /**
95
- * The list of content item in the release
96
- */
97
- releaseItems: ReleaseItem[];
98
- /**
99
- * Mark if the release is archived
100
- */
101
- archived: boolean;
86
+ /**
87
+ * The Release unique id
88
+ */
89
+ id: ReleaseId;
90
+ /**
91
+ * The release related space id
92
+ */
93
+ spaceId: string;
94
+ /**
95
+ * The list of content item in the release
96
+ */
97
+ releaseItems: ReleaseItem[];
98
+ /**
99
+ * Mark if the release is archived
100
+ */
101
+ archived: boolean;
102
102
  };
103
103
 
104
104
  /**
105
105
  * This type represent the data needed to make a get published content API request
106
106
  */
107
107
  export type GetPublishedContentRequest = {
108
- /**
109
- * This published content public id
110
- */
111
- publicId: string;
112
- /**
113
- * The date where to find the published content
114
- */
115
- targetDate?: Date;
116
- /**
117
- * This publishing channel of the content
118
- */
119
- publishingChannel: string;
108
+ /**
109
+ * This published content public id
110
+ */
111
+ publicId: string;
112
+ /**
113
+ * The date where to find the published content
114
+ */
115
+ targetDate?: Date;
116
+ /**
117
+ * This publishing channel of the content
118
+ */
119
+ publishingChannel: string;
120
120
  };
121
121
 
122
122
  /**
123
123
  * This type represent the model of a published content
124
124
  */
125
125
  export type PublishedContentResponse = {
126
- /**
127
- * The published content unique id
128
- */
129
- id: PublishedContentId;
130
- /**
131
- * The related content unique id
132
- */
133
- contentId: ContentId
134
- /**
135
- * The published content current version
136
- */
137
- contentVersion: number;
138
- /**
139
- * The publishing channels where the content is published
140
- */
141
- contentChannels: string[];
142
- /**
143
- * The published content tags
144
- */
145
- contentTags: string[];
146
- /**
147
- * The published content related content definition mnemonic id
148
- */
149
- contentDefinitionMnemonicId: string;
150
- /**
151
- * The published content related content repository id
152
- */
153
- contentRepositoryId: ContentRepositoryId;
154
- /**
155
- * The published content public id
156
- */
157
- publicId: string;
158
- /**
159
- * The published content payload
160
- */
161
- payload: object;
162
- /**
163
- * The published content online date
164
- */
165
- onlineDate?: Date;
166
- /**
167
- * The published content offline date
168
- */
169
- offlineDate?: Date;
170
- /**
171
- * The creation date of the related content
172
- */
173
- createdDate: Date;
174
- /**
175
- * The update date of the related content
176
- */
177
- lastModifiedDate: Date;
178
- /**
179
- * The creator of the content
180
- */
181
- author: AuthorResponse;
126
+ /**
127
+ * The published content unique id
128
+ */
129
+ id: PublishedContentId;
130
+ /**
131
+ * The related content unique id
132
+ */
133
+ contentId: ContentId;
134
+ /**
135
+ * The published content current version
136
+ */
137
+ contentVersion: number;
138
+ /**
139
+ * The publishing channels where the content is published
140
+ */
141
+ contentChannels: string[];
142
+ /**
143
+ * The published content tags
144
+ */
145
+ contentTags: string[];
146
+ /**
147
+ * The published content related content definition mnemonic id
148
+ */
149
+ contentDefinitionMnemonicId: string;
150
+ /**
151
+ * The published content related content repository id
152
+ */
153
+ contentRepositoryId: ContentRepositoryId;
154
+ /**
155
+ * The published content public id
156
+ */
157
+ publicId: string;
158
+ /**
159
+ * The published content payload
160
+ */
161
+ payload: object;
162
+ /**
163
+ * The published content online date
164
+ */
165
+ onlineDate?: Date;
166
+ /**
167
+ * The published content offline date
168
+ */
169
+ offlineDate?: Date;
170
+ /**
171
+ * The creation date of the related content
172
+ */
173
+ createdDate: Date;
174
+ /**
175
+ * The update date of the related content
176
+ */
177
+ lastModifiedDate: Date;
178
+ /**
179
+ * The creator of the content
180
+ */
181
+ author: AuthorResponse;
182
182
  };
183
183
 
184
184
  /**
185
185
  * This type represent the data needed to make a set stage content to live API request
186
186
  */
187
187
  export type SetStageContentsToLiveRequest = {
188
- /**
189
- * The release id to publish to live
190
- */
191
- releaseId: ReleaseId;
188
+ /**
189
+ * The release id to publish to live
190
+ */
191
+ releaseId: ReleaseId;
192
+
193
+ /**
194
+ * Skip validating linked contents resolution
195
+ */
196
+ skipLinkedContentValidation: boolean;
192
197
  };
193
198
 
194
199
  /**
@@ -210,18 +215,18 @@ export type CreateReleaseResponse = Release;
210
215
  * This type represent the data needed to make an update release API request
211
216
  */
212
217
  export type UpdateReleaseRequest = {
213
- /**
214
- * The release unique id to update
215
- */
216
- releaseId: ReleaseId;
217
- /**
218
- * The release item to publish
219
- */
220
- itemsToPromote: ReleaseItemId[];
221
- /**
222
- * Mark if all the puslished content in stage have to be publish to live
223
- */
224
- includeAll?: boolean;
218
+ /**
219
+ * The release unique id to update
220
+ */
221
+ releaseId: ReleaseId;
222
+ /**
223
+ * The release item to publish
224
+ */
225
+ itemsToPromote: ReleaseItemId[];
226
+ /**
227
+ * Mark if all the puslished content in stage have to be publish to live
228
+ */
229
+ includeAll?: boolean;
225
230
  };
226
231
 
227
232
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentchef/contentchef-types",
3
- "version": "2.6.0",
3
+ "version": "2.6.1",
4
4
  "description": "ContentChef types",
5
5
  "author": "PierpaoloIannone <piannone@byte-code.com>",
6
6
  "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",