@datocms/cma-client 6.4.0 → 6.8.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.
Files changed (37) hide show
  1. package/dist/cjs/generated/Client.js +1 -1
  2. package/dist/cjs/generated/resources/Field.js +16 -12
  3. package/dist/cjs/generated/resources/Field.js.map +1 -1
  4. package/dist/cjs/generated/resources/Fieldset.js +8 -6
  5. package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
  6. package/dist/cjs/generated/resources/Item.js +4 -4
  7. package/dist/cjs/generated/resources/ItemType.js +12 -9
  8. package/dist/cjs/generated/resources/ItemType.js.map +1 -1
  9. package/dist/esm/generated/ApiTypes.d.ts +205 -3
  10. package/dist/esm/generated/Client.js +1 -1
  11. package/dist/esm/generated/RawApiTypes.d.ts +208 -2
  12. package/dist/esm/generated/resources/Field.d.ts +8 -8
  13. package/dist/esm/generated/resources/Field.js +16 -12
  14. package/dist/esm/generated/resources/Field.js.map +1 -1
  15. package/dist/esm/generated/resources/Fieldset.d.ts +4 -4
  16. package/dist/esm/generated/resources/Fieldset.js +8 -6
  17. package/dist/esm/generated/resources/Fieldset.js.map +1 -1
  18. package/dist/esm/generated/resources/Item.d.ts +4 -4
  19. package/dist/esm/generated/resources/Item.js +4 -4
  20. package/dist/esm/generated/resources/ItemType.d.ts +6 -6
  21. package/dist/esm/generated/resources/ItemType.js +12 -9
  22. package/dist/esm/generated/resources/ItemType.js.map +1 -1
  23. package/dist/types/generated/ApiTypes.d.ts +205 -3
  24. package/dist/types/generated/RawApiTypes.d.ts +208 -2
  25. package/dist/types/generated/resources/Field.d.ts +8 -8
  26. package/dist/types/generated/resources/Fieldset.d.ts +4 -4
  27. package/dist/types/generated/resources/Item.d.ts +4 -4
  28. package/dist/types/generated/resources/ItemType.d.ts +6 -6
  29. package/package.json +1 -1
  30. package/resources.json +11 -2
  31. package/src/generated/ApiTypes.ts +205 -3
  32. package/src/generated/Client.ts +1 -1
  33. package/src/generated/RawApiTypes.ts +208 -2
  34. package/src/generated/resources/Field.ts +38 -13
  35. package/src/generated/resources/Fieldset.ts +17 -5
  36. package/src/generated/resources/Item.ts +4 -4
  37. 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(itemTypeId: string | ApiTypes.ItemTypeData) {
131
- return this.rawList(Utils.toId(itemTypeId)).then((body) =>
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(itemTypeId: string): Promise<RawApiTypes.FieldInstancesTargetSchema> {
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(itemTypeId: string | ApiTypes.ItemTypeData) {
160
- return this.rawReferencing(Utils.toId(itemTypeId)).then((body) =>
161
- Utils.deserializeResponseBody<ApiTypes.FieldReferencingTargetSchema>(
162
- body,
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(itemTypeId: string | ApiTypes.ItemTypeData) {
195
- return this.rawRelated(Utils.toId(itemTypeId)).then((body) =>
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(fieldId: string | ApiTypes.FieldData) {
228
- return this.rawFind(Utils.toId(fieldId)).then((body) =>
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(fieldId: string): Promise<RawApiTypes.FieldSelfTargetSchema> {
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(itemTypeId: string | ApiTypes.ItemTypeData) {
117
- return this.rawList(Utils.toId(itemTypeId)).then((body) =>
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(fieldsetId: string | ApiTypes.FieldsetData) {
150
- return this.rawFind(Utils.toId(fieldsetId)).then((body) =>
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(fieldsetId: string): Promise<RawApiTypes.FieldsetSelfTargetSchema> {
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
- * Validates an existing record field
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
- * Validates an existing record field
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
- * Validates a record field
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
- * Validates a record field
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(): Promise<RawApiTypes.ItemTypeInstancesTargetSchema> {
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(itemTypeId: string | ApiTypes.ItemTypeData) {
186
- return this.rawFind(Utils.toId(itemTypeId)).then((body) =>
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(itemTypeId: string): Promise<RawApiTypes.ItemTypeSelfTargetSchema> {
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(itemTypeId: string | ApiTypes.ItemTypeData) {
284
- return this.rawReferencing(Utils.toId(itemTypeId)).then((body) =>
285
- Utils.deserializeResponseBody<ApiTypes.ItemTypeReferencingTargetSchema>(
286
- body,
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