@datocms/cma-client 6.4.0 → 6.7.0
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.
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/resources/Field.js +16 -12
- package/dist/cjs/generated/resources/Field.js.map +1 -1
- package/dist/cjs/generated/resources/Fieldset.js +8 -6
- package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js +4 -4
- package/dist/cjs/generated/resources/ItemType.js +12 -9
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/ApiTypes.d.ts +181 -0
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +181 -0
- package/dist/esm/generated/resources/Field.d.ts +8 -8
- package/dist/esm/generated/resources/Field.js +16 -12
- package/dist/esm/generated/resources/Field.js.map +1 -1
- package/dist/esm/generated/resources/Fieldset.d.ts +4 -4
- package/dist/esm/generated/resources/Fieldset.js +8 -6
- package/dist/esm/generated/resources/Fieldset.js.map +1 -1
- package/dist/esm/generated/resources/Item.d.ts +4 -4
- package/dist/esm/generated/resources/Item.js +4 -4
- package/dist/esm/generated/resources/ItemType.d.ts +6 -6
- package/dist/esm/generated/resources/ItemType.js +12 -9
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/types/generated/ApiTypes.d.ts +181 -0
- package/dist/types/generated/RawApiTypes.d.ts +181 -0
- package/dist/types/generated/resources/Field.d.ts +8 -8
- package/dist/types/generated/resources/Fieldset.d.ts +4 -4
- package/dist/types/generated/resources/Item.d.ts +4 -4
- package/dist/types/generated/resources/ItemType.d.ts +6 -6
- package/package.json +1 -1
- package/resources.json +11 -2
- package/src/generated/ApiTypes.ts +181 -0
- package/src/generated/Client.ts +1 -1
- package/src/generated/RawApiTypes.ts +181 -0
- package/src/generated/resources/Field.ts +38 -13
- package/src/generated/resources/Fieldset.ts +17 -5
- package/src/generated/resources/Item.ts +4 -4
- package/src/generated/resources/ItemType.ts +27 -11
|
@@ -127,8 +127,11 @@ export default class Field extends BaseResource {
|
|
|
127
127
|
* @throws {ApiError}
|
|
128
128
|
* @throws {TimeoutError}
|
|
129
129
|
*/
|
|
130
|
-
list(
|
|
131
|
-
|
|
130
|
+
list(
|
|
131
|
+
itemTypeId: string | ApiTypes.ItemTypeData,
|
|
132
|
+
queryParams?: ApiTypes.FieldInstancesHrefSchema,
|
|
133
|
+
) {
|
|
134
|
+
return this.rawList(Utils.toId(itemTypeId), queryParams).then((body) =>
|
|
132
135
|
Utils.deserializeResponseBody<ApiTypes.FieldInstancesTargetSchema>(body),
|
|
133
136
|
);
|
|
134
137
|
}
|
|
@@ -141,10 +144,14 @@ export default class Field extends BaseResource {
|
|
|
141
144
|
* @throws {ApiError}
|
|
142
145
|
* @throws {TimeoutError}
|
|
143
146
|
*/
|
|
144
|
-
rawList(
|
|
147
|
+
rawList(
|
|
148
|
+
itemTypeId: string,
|
|
149
|
+
queryParams?: RawApiTypes.FieldInstancesHrefSchema,
|
|
150
|
+
): Promise<RawApiTypes.FieldInstancesTargetSchema> {
|
|
145
151
|
return this.client.request<RawApiTypes.FieldInstancesTargetSchema>({
|
|
146
152
|
method: 'GET',
|
|
147
153
|
url: `/item-types/${itemTypeId}/fields`,
|
|
154
|
+
queryParams,
|
|
148
155
|
});
|
|
149
156
|
}
|
|
150
157
|
|
|
@@ -156,11 +163,15 @@ export default class Field extends BaseResource {
|
|
|
156
163
|
* @throws {ApiError}
|
|
157
164
|
* @throws {TimeoutError}
|
|
158
165
|
*/
|
|
159
|
-
referencing(
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
166
|
+
referencing(
|
|
167
|
+
itemTypeId: string | ApiTypes.ItemTypeData,
|
|
168
|
+
queryParams?: ApiTypes.FieldReferencingHrefSchema,
|
|
169
|
+
) {
|
|
170
|
+
return this.rawReferencing(Utils.toId(itemTypeId), queryParams).then(
|
|
171
|
+
(body) =>
|
|
172
|
+
Utils.deserializeResponseBody<ApiTypes.FieldReferencingTargetSchema>(
|
|
173
|
+
body,
|
|
174
|
+
),
|
|
164
175
|
);
|
|
165
176
|
}
|
|
166
177
|
|
|
@@ -174,10 +185,12 @@ export default class Field extends BaseResource {
|
|
|
174
185
|
*/
|
|
175
186
|
rawReferencing(
|
|
176
187
|
itemTypeId: string,
|
|
188
|
+
queryParams?: RawApiTypes.FieldReferencingHrefSchema,
|
|
177
189
|
): Promise<RawApiTypes.FieldReferencingTargetSchema> {
|
|
178
190
|
return this.client.request<RawApiTypes.FieldReferencingTargetSchema>({
|
|
179
191
|
method: 'GET',
|
|
180
192
|
url: `/item-types/${itemTypeId}/fields/referencing`,
|
|
193
|
+
queryParams,
|
|
181
194
|
});
|
|
182
195
|
}
|
|
183
196
|
|
|
@@ -191,8 +204,11 @@ export default class Field extends BaseResource {
|
|
|
191
204
|
*
|
|
192
205
|
* @deprecated This API call is to be considered private and might change without notice
|
|
193
206
|
*/
|
|
194
|
-
related(
|
|
195
|
-
|
|
207
|
+
related(
|
|
208
|
+
itemTypeId: string | ApiTypes.ItemTypeData,
|
|
209
|
+
queryParams?: ApiTypes.FieldRelatedHrefSchema,
|
|
210
|
+
) {
|
|
211
|
+
return this.rawRelated(Utils.toId(itemTypeId), queryParams).then((body) =>
|
|
196
212
|
Utils.deserializeResponseBody<ApiTypes.FieldRelatedTargetSchema>(body),
|
|
197
213
|
);
|
|
198
214
|
}
|
|
@@ -209,10 +225,12 @@ export default class Field extends BaseResource {
|
|
|
209
225
|
*/
|
|
210
226
|
rawRelated(
|
|
211
227
|
itemTypeId: string,
|
|
228
|
+
queryParams?: RawApiTypes.FieldRelatedHrefSchema,
|
|
212
229
|
): Promise<RawApiTypes.FieldRelatedTargetSchema> {
|
|
213
230
|
return this.client.request<RawApiTypes.FieldRelatedTargetSchema>({
|
|
214
231
|
method: 'GET',
|
|
215
232
|
url: `/item-types/${itemTypeId}/fields/related`,
|
|
233
|
+
queryParams,
|
|
216
234
|
});
|
|
217
235
|
}
|
|
218
236
|
|
|
@@ -224,8 +242,11 @@ export default class Field extends BaseResource {
|
|
|
224
242
|
* @throws {ApiError}
|
|
225
243
|
* @throws {TimeoutError}
|
|
226
244
|
*/
|
|
227
|
-
find(
|
|
228
|
-
|
|
245
|
+
find(
|
|
246
|
+
fieldId: string | ApiTypes.FieldData,
|
|
247
|
+
queryParams?: ApiTypes.FieldSelfHrefSchema,
|
|
248
|
+
) {
|
|
249
|
+
return this.rawFind(Utils.toId(fieldId), queryParams).then((body) =>
|
|
229
250
|
Utils.deserializeResponseBody<ApiTypes.FieldSelfTargetSchema>(body),
|
|
230
251
|
);
|
|
231
252
|
}
|
|
@@ -238,10 +259,14 @@ export default class Field extends BaseResource {
|
|
|
238
259
|
* @throws {ApiError}
|
|
239
260
|
* @throws {TimeoutError}
|
|
240
261
|
*/
|
|
241
|
-
rawFind(
|
|
262
|
+
rawFind(
|
|
263
|
+
fieldId: string,
|
|
264
|
+
queryParams?: RawApiTypes.FieldSelfHrefSchema,
|
|
265
|
+
): Promise<RawApiTypes.FieldSelfTargetSchema> {
|
|
242
266
|
return this.client.request<RawApiTypes.FieldSelfTargetSchema>({
|
|
243
267
|
method: 'GET',
|
|
244
268
|
url: `/fields/${fieldId}`,
|
|
269
|
+
queryParams,
|
|
245
270
|
});
|
|
246
271
|
}
|
|
247
272
|
|
|
@@ -113,8 +113,11 @@ export default class Fieldset extends BaseResource {
|
|
|
113
113
|
* @throws {ApiError}
|
|
114
114
|
* @throws {TimeoutError}
|
|
115
115
|
*/
|
|
116
|
-
list(
|
|
117
|
-
|
|
116
|
+
list(
|
|
117
|
+
itemTypeId: string | ApiTypes.ItemTypeData,
|
|
118
|
+
queryParams?: ApiTypes.FieldsetInstancesHrefSchema,
|
|
119
|
+
) {
|
|
120
|
+
return this.rawList(Utils.toId(itemTypeId), queryParams).then((body) =>
|
|
118
121
|
Utils.deserializeResponseBody<ApiTypes.FieldsetInstancesTargetSchema>(
|
|
119
122
|
body,
|
|
120
123
|
),
|
|
@@ -131,10 +134,12 @@ export default class Fieldset extends BaseResource {
|
|
|
131
134
|
*/
|
|
132
135
|
rawList(
|
|
133
136
|
itemTypeId: string,
|
|
137
|
+
queryParams?: RawApiTypes.FieldsetInstancesHrefSchema,
|
|
134
138
|
): Promise<RawApiTypes.FieldsetInstancesTargetSchema> {
|
|
135
139
|
return this.client.request<RawApiTypes.FieldsetInstancesTargetSchema>({
|
|
136
140
|
method: 'GET',
|
|
137
141
|
url: `/item-types/${itemTypeId}/fieldsets`,
|
|
142
|
+
queryParams,
|
|
138
143
|
});
|
|
139
144
|
}
|
|
140
145
|
|
|
@@ -146,8 +151,11 @@ export default class Fieldset extends BaseResource {
|
|
|
146
151
|
* @throws {ApiError}
|
|
147
152
|
* @throws {TimeoutError}
|
|
148
153
|
*/
|
|
149
|
-
find(
|
|
150
|
-
|
|
154
|
+
find(
|
|
155
|
+
fieldsetId: string | ApiTypes.FieldsetData,
|
|
156
|
+
queryParams?: ApiTypes.FieldsetSelfHrefSchema,
|
|
157
|
+
) {
|
|
158
|
+
return this.rawFind(Utils.toId(fieldsetId), queryParams).then((body) =>
|
|
151
159
|
Utils.deserializeResponseBody<ApiTypes.FieldsetSelfTargetSchema>(body),
|
|
152
160
|
);
|
|
153
161
|
}
|
|
@@ -160,10 +168,14 @@ export default class Fieldset extends BaseResource {
|
|
|
160
168
|
* @throws {ApiError}
|
|
161
169
|
* @throws {TimeoutError}
|
|
162
170
|
*/
|
|
163
|
-
rawFind(
|
|
171
|
+
rawFind(
|
|
172
|
+
fieldsetId: string,
|
|
173
|
+
queryParams?: RawApiTypes.FieldsetSelfHrefSchema,
|
|
174
|
+
): Promise<RawApiTypes.FieldsetSelfTargetSchema> {
|
|
164
175
|
return this.client.request<RawApiTypes.FieldsetSelfTargetSchema>({
|
|
165
176
|
method: 'GET',
|
|
166
177
|
url: `/fieldsets/${fieldsetId}`,
|
|
178
|
+
queryParams,
|
|
167
179
|
});
|
|
168
180
|
}
|
|
169
181
|
|
|
@@ -180,7 +180,7 @@ export default class Item extends BaseResource {
|
|
|
180
180
|
}
|
|
181
181
|
|
|
182
182
|
/**
|
|
183
|
-
*
|
|
183
|
+
* Validate an existing record
|
|
184
184
|
*
|
|
185
185
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_existing
|
|
186
186
|
*
|
|
@@ -207,7 +207,7 @@ export default class Item extends BaseResource {
|
|
|
207
207
|
}
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
|
-
*
|
|
210
|
+
* Validate an existing record
|
|
211
211
|
*
|
|
212
212
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_existing
|
|
213
213
|
*
|
|
@@ -228,7 +228,7 @@ export default class Item extends BaseResource {
|
|
|
228
228
|
}
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
|
-
*
|
|
231
|
+
* Validate a new record
|
|
232
232
|
*
|
|
233
233
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_new
|
|
234
234
|
*
|
|
@@ -253,7 +253,7 @@ export default class Item extends BaseResource {
|
|
|
253
253
|
}
|
|
254
254
|
|
|
255
255
|
/**
|
|
256
|
-
*
|
|
256
|
+
* Validate a new record
|
|
257
257
|
*
|
|
258
258
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_new
|
|
259
259
|
*
|
|
@@ -151,8 +151,8 @@ export default class ItemType extends BaseResource {
|
|
|
151
151
|
* @throws {ApiError}
|
|
152
152
|
* @throws {TimeoutError}
|
|
153
153
|
*/
|
|
154
|
-
list() {
|
|
155
|
-
return this.rawList().then((body) =>
|
|
154
|
+
list(queryParams?: ApiTypes.ItemTypeInstancesHrefSchema) {
|
|
155
|
+
return this.rawList(queryParams).then((body) =>
|
|
156
156
|
Utils.deserializeResponseBody<ApiTypes.ItemTypeInstancesTargetSchema>(
|
|
157
157
|
body,
|
|
158
158
|
),
|
|
@@ -167,10 +167,13 @@ export default class ItemType extends BaseResource {
|
|
|
167
167
|
* @throws {ApiError}
|
|
168
168
|
* @throws {TimeoutError}
|
|
169
169
|
*/
|
|
170
|
-
rawList(
|
|
170
|
+
rawList(
|
|
171
|
+
queryParams?: RawApiTypes.ItemTypeInstancesHrefSchema,
|
|
172
|
+
): Promise<RawApiTypes.ItemTypeInstancesTargetSchema> {
|
|
171
173
|
return this.client.request<RawApiTypes.ItemTypeInstancesTargetSchema>({
|
|
172
174
|
method: 'GET',
|
|
173
175
|
url: '/item-types',
|
|
176
|
+
queryParams,
|
|
174
177
|
});
|
|
175
178
|
}
|
|
176
179
|
|
|
@@ -182,8 +185,11 @@ export default class ItemType extends BaseResource {
|
|
|
182
185
|
* @throws {ApiError}
|
|
183
186
|
* @throws {TimeoutError}
|
|
184
187
|
*/
|
|
185
|
-
find(
|
|
186
|
-
|
|
188
|
+
find(
|
|
189
|
+
itemTypeId: string | ApiTypes.ItemTypeData,
|
|
190
|
+
queryParams?: ApiTypes.ItemTypeSelfHrefSchema,
|
|
191
|
+
) {
|
|
192
|
+
return this.rawFind(Utils.toId(itemTypeId), queryParams).then((body) =>
|
|
187
193
|
Utils.deserializeResponseBody<ApiTypes.ItemTypeSelfTargetSchema>(body),
|
|
188
194
|
);
|
|
189
195
|
}
|
|
@@ -196,10 +202,14 @@ export default class ItemType extends BaseResource {
|
|
|
196
202
|
* @throws {ApiError}
|
|
197
203
|
* @throws {TimeoutError}
|
|
198
204
|
*/
|
|
199
|
-
rawFind(
|
|
205
|
+
rawFind(
|
|
206
|
+
itemTypeId: string,
|
|
207
|
+
queryParams?: RawApiTypes.ItemTypeSelfHrefSchema,
|
|
208
|
+
): Promise<RawApiTypes.ItemTypeSelfTargetSchema> {
|
|
200
209
|
return this.client.request<RawApiTypes.ItemTypeSelfTargetSchema>({
|
|
201
210
|
method: 'GET',
|
|
202
211
|
url: `/item-types/${itemTypeId}`,
|
|
212
|
+
queryParams,
|
|
203
213
|
});
|
|
204
214
|
}
|
|
205
215
|
|
|
@@ -280,11 +290,15 @@ export default class ItemType extends BaseResource {
|
|
|
280
290
|
* @throws {ApiError}
|
|
281
291
|
* @throws {TimeoutError}
|
|
282
292
|
*/
|
|
283
|
-
referencing(
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
293
|
+
referencing(
|
|
294
|
+
itemTypeId: string | ApiTypes.ItemTypeData,
|
|
295
|
+
queryParams?: ApiTypes.ItemTypeReferencingHrefSchema,
|
|
296
|
+
) {
|
|
297
|
+
return this.rawReferencing(Utils.toId(itemTypeId), queryParams).then(
|
|
298
|
+
(body) =>
|
|
299
|
+
Utils.deserializeResponseBody<ApiTypes.ItemTypeReferencingTargetSchema>(
|
|
300
|
+
body,
|
|
301
|
+
),
|
|
288
302
|
);
|
|
289
303
|
}
|
|
290
304
|
|
|
@@ -298,10 +312,12 @@ export default class ItemType extends BaseResource {
|
|
|
298
312
|
*/
|
|
299
313
|
rawReferencing(
|
|
300
314
|
itemTypeId: string,
|
|
315
|
+
queryParams?: RawApiTypes.ItemTypeReferencingHrefSchema,
|
|
301
316
|
): Promise<RawApiTypes.ItemTypeReferencingTargetSchema> {
|
|
302
317
|
return this.client.request<RawApiTypes.ItemTypeReferencingTargetSchema>({
|
|
303
318
|
method: 'GET',
|
|
304
319
|
url: `/item-types/${itemTypeId}/referencing`,
|
|
320
|
+
queryParams,
|
|
305
321
|
});
|
|
306
322
|
}
|
|
307
323
|
|