@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
198 lines • 6.43 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const Utils = __importStar(require("@datocms/rest-client-utils"));
const BaseResource_1 = __importDefault(require("../../BaseResource"));
class Environment extends BaseResource_1.default {
/**
* Fork an existing environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
fork(environmentId, body, queryParams) {
return this.rawFork(Utils.toId(environmentId), Utils.serializeRequestBody(body, {
id: Utils.toId(environmentId),
type: 'environment',
attributes: [],
relationships: [],
}), queryParams).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Fork an existing environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawFork(environmentId, body, queryParams) {
return this.client.request({
method: 'POST',
url: `/environments/${environmentId}/fork`,
body,
queryParams,
});
}
/**
* Promote an environment to primary
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
promote(environmentId) {
return this.rawPromote(Utils.toId(environmentId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Promote an environment to primary
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawPromote(environmentId) {
return this.client.request({
method: 'PUT',
url: `/environments/${environmentId}/promote`,
});
}
/**
* Rename an environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/rename
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rename(environmentId, body) {
return this.rawRename(Utils.toId(environmentId), Utils.serializeRequestBody(body, {
id: Utils.toId(environmentId),
type: 'environment',
attributes: [],
relationships: [],
})).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Rename an environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/rename
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawRename(environmentId, body) {
return this.client.request({
method: 'PUT',
url: `/environments/${environmentId}/rename`,
body,
});
}
/**
* List all environments
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
list() {
return this.rawList().then((body) => Utils.deserializeResponseBody(body));
}
/**
* List all environments
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawList() {
return this.client.request({
method: 'GET',
url: '/environments',
});
}
/**
* Retrieve a environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
find(environmentId) {
return this.rawFind(Utils.toId(environmentId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Retrieve a environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawFind(environmentId) {
return this.client.request({
method: 'GET',
url: `/environments/${environmentId}`,
});
}
/**
* Delete a environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
destroy(environmentId) {
return this.rawDestroy(Utils.toId(environmentId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Delete a environment
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawDestroy(environmentId) {
return this.client.request({
method: 'DELETE',
url: `/environments/${environmentId}`,
});
}
}
exports.default = Environment;
Environment.TYPE = 'environment';
//# sourceMappingURL=Environment.js.map