@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
177 lines • 5.64 kB
JavaScript
import * as Utils from '@datocms/rest-client-utils';
import BaseResource from '../../BaseResource';
export default class UploadCollection extends BaseResource {
/**
* Create a new upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/create
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
create(body) {
return this.rawCreate(Utils.serializeRequestBody(body, {
type: 'upload_collection',
attributes: ['label', 'position'],
relationships: ['parent'],
})).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Create a new upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/create
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawCreate(body) {
return this.client.request({
method: 'POST',
url: '/upload-collections',
body,
});
}
/**
* Update a upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/update
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
update(uploadCollectionId, body) {
return this.rawUpdate(Utils.toId(uploadCollectionId), Utils.serializeRequestBody(body, {
id: Utils.toId(uploadCollectionId),
type: 'upload_collection',
attributes: ['label', 'position'],
relationships: ['parent', 'children'],
})).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Update a upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/update
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawUpdate(uploadCollectionId, body) {
return this.client.request({
method: 'PUT',
url: `/upload-collections/${uploadCollectionId}`,
body,
});
}
/**
* List all upload collections
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
list(queryParams) {
return this.rawList(queryParams).then((body) => Utils.deserializeResponseBody(body));
}
/**
* List all upload collections
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawList(queryParams) {
return this.client.request({
method: 'GET',
url: '/upload-collections',
queryParams,
});
}
/**
* Retrieve a upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
find(uploadCollectionId) {
return this.rawFind(Utils.toId(uploadCollectionId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Retrieve a upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawFind(uploadCollectionId) {
return this.client.request({
method: 'GET',
url: `/upload-collections/${uploadCollectionId}`,
});
}
/**
* Delete a upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
destroy(uploadCollectionId) {
return this.rawDestroy(Utils.toId(uploadCollectionId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Delete a upload collection
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawDestroy(uploadCollectionId) {
return this.client.request({
method: 'DELETE',
url: `/upload-collections/${uploadCollectionId}`,
});
}
/**
* Reorders a set of upload collections
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/reorder
*
* @throws {ApiError}
* @throws {TimeoutError}
*
* @deprecated This API call is to be considered private and might change without notice
*/
reorder(body) {
return this.rawReorder(Utils.serializeRequestBody(body, {
type: 'upload_collection',
attributes: ['position'],
relationships: ['parent'],
})).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Reorders a set of upload collections
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/reorder
*
* @throws {ApiError}
* @throws {TimeoutError}
*
* @deprecated This API call is to be considered private and might change without notice
*/
rawReorder(body) {
return this.client.request({
method: 'POST',
url: '/upload-collections/reorder',
body,
});
}
}
UploadCollection.TYPE = 'upload_collection';
//# sourceMappingURL=UploadCollection.js.map