fetch-statuspage
Version:
257 lines (256 loc) • 15.9 kB
JavaScript
;
// tslint:disable
/**
* Statuspage API
* # Code of Conduct Please don\'t abuse the API, and please report all feature requests and issues to https://help.statuspage.io/help/contact-us-30 # Rate Limiting Each API token is limited to 1 request / second as measured on a 60 second rolling window. To get this limit increased or lifted, please contact us at https://help.statuspage.io/help/contact-us-30 # Basics ## HTTPS It\'s required ## URL Prefix In order to maintain version integrity into the future, the API is versioned. All calls currently begin with the following prefix: https://api.statuspage.io/v1/ ## RESTful Interface Wherever possible, the API seeks to implement repeatable patterns with logical, representative URLs and descriptive HTTP verbs. Below are some examples and conventions you will see throughout the documentation. * Collections are buckets: https://api.statuspage.io/v1/pages/asdf123/incidents.json * Elements have unique IDs: https://api.statuspage.io/v1/pages/asdf123/incidents/jklm456.json * GET will retrieve information about a collection/element * POST will create an element in a collection * PATCH will update a single element * PUT will replace a single element in a collection (rarely used) * DELETE will destroy a single element ## Sending Data Information can be sent in the body as form urlencoded or JSON, but make sure the Content-Type header matches the body structure or the server gremlins will be angry. All examples are provided in JSON format, however they can easily be converted to form encoding if required. Some examples of how to convert things are below: // JSON { \"incident\": { \"name\": \"test incident\", \"components\": [\"8kbf7d35c070\", \"vtnh60py4yd7\"] } } // Form Encoded (using curl as an example): curl -X POST https://api.statuspage.io/v1/example \\ -d \"incident[name]=test incident\" \\ -d \"incident[components][]=8kbf7d35c070\" \\ -d \"incident[components][]=vtnh60py4yd7\" # Authentication <!-- ReDoc-Inject: <security-definitions> -->
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const runtime = require("../runtime");
const models_1 = require("../models");
/**
* no description
*/
class ComponentGroupsApi extends runtime.BaseAPI {
/**
* Delete a component group
* Delete a component group
*/
deletePagesPageIdComponentGroupsIdRaw(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.page_id === null || requestParameters.page_id === undefined) {
throw new runtime.RequiredError('page_id', 'Required parameter requestParameters.page_id was null or undefined when calling deletePagesPageIdComponentGroupsId.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling deletePagesPageIdComponentGroupsId.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api_key authentication
}
const response = yield this.request({
path: `/pages/{page_id}/component-groups/{id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.GroupComponentFromJSON(jsonValue));
});
}
/**
* Delete a component group
* Delete a component group
*/
deletePagesPageIdComponentGroupsId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.deletePagesPageIdComponentGroupsIdRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a list of component groups
* Get a list of component groups
*/
getPagesPageIdComponentGroupsRaw(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.page_id === null || requestParameters.page_id === undefined) {
throw new runtime.RequiredError('page_id', 'Required parameter requestParameters.page_id was null or undefined when calling getPagesPageIdComponentGroups.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api_key authentication
}
const response = yield this.request({
path: `/pages/{page_id}/component-groups`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.GroupComponentFromJSON));
});
}
/**
* Get a list of component groups
* Get a list of component groups
*/
getPagesPageIdComponentGroups(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdComponentGroupsRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a component group
* Get a component group
*/
getPagesPageIdComponentGroupsIdRaw(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.page_id === null || requestParameters.page_id === undefined) {
throw new runtime.RequiredError('page_id', 'Required parameter requestParameters.page_id was null or undefined when calling getPagesPageIdComponentGroupsId.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling getPagesPageIdComponentGroupsId.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api_key authentication
}
const response = yield this.request({
path: `/pages/{page_id}/component-groups/{id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.GroupComponentFromJSON(jsonValue));
});
}
/**
* Get a component group
* Get a component group
*/
getPagesPageIdComponentGroupsId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdComponentGroupsIdRaw(requestParameters);
return yield response.value();
});
}
/**
* Update a component group
* Update a component group
*/
patchPagesPageIdComponentGroupsIdRaw(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.page_id === null || requestParameters.page_id === undefined) {
throw new runtime.RequiredError('page_id', 'Required parameter requestParameters.page_id was null or undefined when calling patchPagesPageIdComponentGroupsId.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling patchPagesPageIdComponentGroupsId.');
}
if (requestParameters.PatchPagesPageIdComponentGroups === null || requestParameters.PatchPagesPageIdComponentGroups === undefined) {
throw new runtime.RequiredError('PatchPagesPageIdComponentGroups', 'Required parameter requestParameters.PatchPagesPageIdComponentGroups was null or undefined when calling patchPagesPageIdComponentGroupsId.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api_key authentication
}
const response = yield this.request({
path: `/pages/{page_id}/component-groups/{id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: models_1.PatchPagesPageIdComponentGroupsToJSON(requestParameters.PatchPagesPageIdComponentGroups),
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.GroupComponentFromJSON(jsonValue));
});
}
/**
* Update a component group
* Update a component group
*/
patchPagesPageIdComponentGroupsId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.patchPagesPageIdComponentGroupsIdRaw(requestParameters);
return yield response.value();
});
}
/**
* Create a component group
* Create a component group
*/
postPagesPageIdComponentGroupsRaw(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.page_id === null || requestParameters.page_id === undefined) {
throw new runtime.RequiredError('page_id', 'Required parameter requestParameters.page_id was null or undefined when calling postPagesPageIdComponentGroups.');
}
if (requestParameters.PostPagesPageIdComponentGroups === null || requestParameters.PostPagesPageIdComponentGroups === undefined) {
throw new runtime.RequiredError('PostPagesPageIdComponentGroups', 'Required parameter requestParameters.PostPagesPageIdComponentGroups was null or undefined when calling postPagesPageIdComponentGroups.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api_key authentication
}
const response = yield this.request({
path: `/pages/{page_id}/component-groups`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: models_1.PostPagesPageIdComponentGroupsToJSON(requestParameters.PostPagesPageIdComponentGroups),
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.GroupComponentFromJSON(jsonValue));
});
}
/**
* Create a component group
* Create a component group
*/
postPagesPageIdComponentGroups(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.postPagesPageIdComponentGroupsRaw(requestParameters);
return yield response.value();
});
}
/**
* Update a component group
* Update a component group
*/
putPagesPageIdComponentGroupsIdRaw(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.page_id === null || requestParameters.page_id === undefined) {
throw new runtime.RequiredError('page_id', 'Required parameter requestParameters.page_id was null or undefined when calling putPagesPageIdComponentGroupsId.');
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling putPagesPageIdComponentGroupsId.');
}
if (requestParameters.PutPagesPageIdComponentGroups === null || requestParameters.PutPagesPageIdComponentGroups === undefined) {
throw new runtime.RequiredError('PutPagesPageIdComponentGroups', 'Required parameter requestParameters.PutPagesPageIdComponentGroups was null or undefined when calling putPagesPageIdComponentGroupsId.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api_key authentication
}
const response = yield this.request({
path: `/pages/{page_id}/component-groups/{id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: models_1.PutPagesPageIdComponentGroupsToJSON(requestParameters.PutPagesPageIdComponentGroups),
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.GroupComponentFromJSON(jsonValue));
});
}
/**
* Update a component group
* Update a component group
*/
putPagesPageIdComponentGroupsId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.putPagesPageIdComponentGroupsIdRaw(requestParameters);
return yield response.value();
});
}
}
exports.ComponentGroupsApi = ComponentGroupsApi;