fetch-statuspage
Version:
422 lines (421 loc) • 23.8 kB
JavaScript
"use strict";
// 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 IncidentsApi extends runtime.BaseAPI {
/**
* Delete an incident
* Delete an incident
*/
deletePagesPageIdIncidentsIncidentIdRaw(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 deletePagesPageIdIncidentsIncidentId.');
}
if (requestParameters.incident_id === null || requestParameters.incident_id === undefined) {
throw new runtime.RequiredError('incident_id', 'Required parameter requestParameters.incident_id was null or undefined when calling deletePagesPageIdIncidentsIncidentId.');
}
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}/incidents/{incident_id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"incident_id"}}`, encodeURIComponent(String(requestParameters.incident_id))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.IncidentFromJSON(jsonValue));
});
}
/**
* Delete an incident
* Delete an incident
*/
deletePagesPageIdIncidentsIncidentId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.deletePagesPageIdIncidentsIncidentIdRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a list of incidents
* Get a list of incidents
*/
getPagesPageIdIncidentsRaw(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 getPagesPageIdIncidents.');
}
const queryParameters = {};
if (requestParameters.q !== undefined) {
queryParameters['q'] = requestParameters.q;
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit;
}
if (requestParameters.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
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}/incidents`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.IncidentFromJSON));
});
}
/**
* Get a list of incidents
* Get a list of incidents
*/
getPagesPageIdIncidents(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdIncidentsRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a list of active maintenances
* Get a list of active maintenances
*/
getPagesPageIdIncidentsActiveMaintenanceRaw(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 getPagesPageIdIncidentsActiveMaintenance.');
}
const queryParameters = {};
if (requestParameters.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.per_page !== undefined) {
queryParameters['per_page'] = requestParameters.per_page;
}
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}/incidents/active_maintenance`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.IncidentFromJSON));
});
}
/**
* Get a list of active maintenances
* Get a list of active maintenances
*/
getPagesPageIdIncidentsActiveMaintenance(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdIncidentsActiveMaintenanceRaw(requestParameters);
return yield response.value();
});
}
/**
* Get an incident
* Get an incident
*/
getPagesPageIdIncidentsIncidentIdRaw(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 getPagesPageIdIncidentsIncidentId.');
}
if (requestParameters.incident_id === null || requestParameters.incident_id === undefined) {
throw new runtime.RequiredError('incident_id', 'Required parameter requestParameters.incident_id was null or undefined when calling getPagesPageIdIncidentsIncidentId.');
}
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}/incidents/{incident_id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"incident_id"}}`, encodeURIComponent(String(requestParameters.incident_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.IncidentFromJSON(jsonValue));
});
}
/**
* Get an incident
* Get an incident
*/
getPagesPageIdIncidentsIncidentId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdIncidentsIncidentIdRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a list of scheduled incidents
* Get a list of scheduled incidents
*/
getPagesPageIdIncidentsScheduledRaw(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 getPagesPageIdIncidentsScheduled.');
}
const queryParameters = {};
if (requestParameters.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.per_page !== undefined) {
queryParameters['per_page'] = requestParameters.per_page;
}
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}/incidents/scheduled`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.IncidentFromJSON));
});
}
/**
* Get a list of scheduled incidents
* Get a list of scheduled incidents
*/
getPagesPageIdIncidentsScheduled(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdIncidentsScheduledRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a list of unresolved incidents
* Get a list of unresolved incidents
*/
getPagesPageIdIncidentsUnresolvedRaw(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 getPagesPageIdIncidentsUnresolved.');
}
const queryParameters = {};
if (requestParameters.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.per_page !== undefined) {
queryParameters['per_page'] = requestParameters.per_page;
}
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}/incidents/unresolved`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.IncidentFromJSON));
});
}
/**
* Get a list of unresolved incidents
* Get a list of unresolved incidents
*/
getPagesPageIdIncidentsUnresolved(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdIncidentsUnresolvedRaw(requestParameters);
return yield response.value();
});
}
/**
* Get a list of upcoming incidents
* Get a list of upcoming incidents
*/
getPagesPageIdIncidentsUpcomingRaw(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 getPagesPageIdIncidentsUpcoming.');
}
const queryParameters = {};
if (requestParameters.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.per_page !== undefined) {
queryParameters['per_page'] = requestParameters.per_page;
}
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}/incidents/upcoming`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
});
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.IncidentFromJSON));
});
}
/**
* Get a list of upcoming incidents
* Get a list of upcoming incidents
*/
getPagesPageIdIncidentsUpcoming(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getPagesPageIdIncidentsUpcomingRaw(requestParameters);
return yield response.value();
});
}
/**
* Update an incident
* Update an incident
*/
patchPagesPageIdIncidentsIncidentIdRaw(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 patchPagesPageIdIncidentsIncidentId.');
}
if (requestParameters.incident_id === null || requestParameters.incident_id === undefined) {
throw new runtime.RequiredError('incident_id', 'Required parameter requestParameters.incident_id was null or undefined when calling patchPagesPageIdIncidentsIncidentId.');
}
if (requestParameters.PatchPagesPageIdIncidents === null || requestParameters.PatchPagesPageIdIncidents === undefined) {
throw new runtime.RequiredError('PatchPagesPageIdIncidents', 'Required parameter requestParameters.PatchPagesPageIdIncidents was null or undefined when calling patchPagesPageIdIncidentsIncidentId.');
}
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}/incidents/{incident_id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"incident_id"}}`, encodeURIComponent(String(requestParameters.incident_id))),
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: models_1.PatchPagesPageIdIncidentsToJSON(requestParameters.PatchPagesPageIdIncidents),
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.IncidentFromJSON(jsonValue));
});
}
/**
* Update an incident
* Update an incident
*/
patchPagesPageIdIncidentsIncidentId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.patchPagesPageIdIncidentsIncidentIdRaw(requestParameters);
return yield response.value();
});
}
/**
* Create an incident
* Create an incident
*/
postPagesPageIdIncidentsRaw(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 postPagesPageIdIncidents.');
}
if (requestParameters.PostPagesPageIdIncidents === null || requestParameters.PostPagesPageIdIncidents === undefined) {
throw new runtime.RequiredError('PostPagesPageIdIncidents', 'Required parameter requestParameters.PostPagesPageIdIncidents was null or undefined when calling postPagesPageIdIncidents.');
}
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}/incidents`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: models_1.PostPagesPageIdIncidentsToJSON(requestParameters.PostPagesPageIdIncidents),
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.IncidentFromJSON(jsonValue));
});
}
/**
* Create an incident
* Create an incident
*/
postPagesPageIdIncidents(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.postPagesPageIdIncidentsRaw(requestParameters);
return yield response.value();
});
}
/**
* Update an incident
* Update an incident
*/
putPagesPageIdIncidentsIncidentIdRaw(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 putPagesPageIdIncidentsIncidentId.');
}
if (requestParameters.incident_id === null || requestParameters.incident_id === undefined) {
throw new runtime.RequiredError('incident_id', 'Required parameter requestParameters.incident_id was null or undefined when calling putPagesPageIdIncidentsIncidentId.');
}
if (requestParameters.PutPagesPageIdIncidents === null || requestParameters.PutPagesPageIdIncidents === undefined) {
throw new runtime.RequiredError('PutPagesPageIdIncidents', 'Required parameter requestParameters.PutPagesPageIdIncidents was null or undefined when calling putPagesPageIdIncidentsIncidentId.');
}
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}/incidents/{incident_id}`.replace(`{${"page_id"}}`, encodeURIComponent(String(requestParameters.page_id))).replace(`{${"incident_id"}}`, encodeURIComponent(String(requestParameters.incident_id))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: models_1.PutPagesPageIdIncidentsToJSON(requestParameters.PutPagesPageIdIncidents),
});
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.IncidentFromJSON(jsonValue));
});
}
/**
* Update an incident
* Update an incident
*/
putPagesPageIdIncidentsIncidentId(requestParameters) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.putPagesPageIdIncidentsIncidentIdRaw(requestParameters);
return yield response.value();
});
}
}
exports.IncidentsApi = IncidentsApi;