@incident-io/sdk 2.6.0 → 2.7.0

package/dist/cjs/apis/StatusPagesV2Api.d.ts

@@ -399,12 +399,12 @@ export declare class StatusPagesV2Api extends runtime.BaseAPI {
      */
     statusPagesV2ShowStatusPageStructureRequestOpts(requestParameters: StatusPagesV2ShowStatusPageStructureRequest): Promise<runtime.RequestOpts>;
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     statusPagesV2ShowStatusPageStructureRaw(requestParameters: StatusPagesV2ShowStatusPageStructureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StatusPagesShowStatusPageStructureResultV2>>;
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     statusPagesV2ShowStatusPageStructure(requestParameters: StatusPagesV2ShowStatusPageStructureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StatusPagesShowStatusPageStructureResultV2>;

package/dist/cjs/apis/StatusPagesV2Api.js

@@ -714,7 +714,7 @@ class StatusPagesV2Api extends runtime.BaseAPI {
         };
     }
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     async statusPagesV2ShowStatusPageStructureRaw(requestParameters, initOverrides) {
@@ -723,7 +723,7 @@ class StatusPagesV2Api extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, StatusPagesShowStatusPageStructureResultV2_js_1.StatusPagesShowStatusPageStructureResultV2FromJSON)(jsonValue));
     }
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     async statusPagesV2ShowStatusPageStructure(requestParameters, initOverrides) {

package/dist/cjs/models/StatusPageStructureComponentV2.d.ts

@@ -19,6 +19,14 @@ export interface StatusPageStructureComponentV2 {
      * The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.
      */
     component_id: string;
+    /**
+     * Whether the page shows this component's uptime
+     */
+    display_uptime: boolean;
+    /**
+     * Whether the component is hidden from the page
+     */
+    hidden: boolean;
     /**
      * The name of this component
      */

package/dist/cjs/models/StatusPageStructureComponentV2.js

@@ -24,6 +24,10 @@ exports.StatusPageStructureComponentV2ToJSONTyped = StatusPageStructureComponent
 function instanceOfStatusPageStructureComponentV2(value) {
     if (!('component_id' in value) || value['component_id'] === undefined)
         return false;
+    if (!('display_uptime' in value) || value['display_uptime'] === undefined)
+        return false;
+    if (!('hidden' in value) || value['hidden'] === undefined)
+        return false;
     if (!('name' in value) || value['name'] === undefined)
         return false;
     return true;
@@ -37,6 +41,8 @@ function StatusPageStructureComponentV2FromJSONTyped(json, ignoreDiscriminator)
     }
     return {
         'component_id': json['component_id'],
+        'display_uptime': json['display_uptime'],
+        'hidden': json['hidden'],
         'name': json['name'],
     };
 }
@@ -49,6 +55,8 @@ function StatusPageStructureComponentV2ToJSONTyped(value, ignoreDiscriminator =
     }
     return {
         'component_id': value['component_id'],
+        'display_uptime': value['display_uptime'],
+        'hidden': value['hidden'],
         'name': value['name'],
     };
 }

package/dist/cjs/models/StatusPageStructureGroupV2.d.ts

@@ -20,6 +20,18 @@ export interface StatusPageStructureGroupV2 {
      * Array of components belonging to this group
      */
     components: Array<StatusPageStructureComponentV2>;
+    /**
+     * A description shown under the group's name
+     */
+    description?: string;
+    /**
+     * Whether the page shows uptime aggregated across the group's components
+     */
+    display_aggregated_uptime: boolean;
+    /**
+     * Whether the group is hidden from the page
+     */
+    hidden: boolean;
     /**
      * Unique ID of this component group
      */

package/dist/cjs/models/StatusPageStructureGroupV2.js

@@ -25,6 +25,10 @@ const StatusPageStructureComponentV2_js_1 = require("./StatusPageStructureCompon
 function instanceOfStatusPageStructureGroupV2(value) {
     if (!('components' in value) || value['components'] === undefined)
         return false;
+    if (!('display_aggregated_uptime' in value) || value['display_aggregated_uptime'] === undefined)
+        return false;
+    if (!('hidden' in value) || value['hidden'] === undefined)
+        return false;
     if (!('id' in value) || value['id'] === undefined)
         return false;
     if (!('name' in value) || value['name'] === undefined)
@@ -40,6 +44,9 @@ function StatusPageStructureGroupV2FromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'components': (json['components'].map(StatusPageStructureComponentV2_js_1.StatusPageStructureComponentV2FromJSON)),
+        'description': json['description'] == null ? undefined : json['description'],
+        'display_aggregated_uptime': json['display_aggregated_uptime'],
+        'hidden': json['hidden'],
         'id': json['id'],
         'name': json['name'],
     };
@@ -53,6 +60,9 @@ function StatusPageStructureGroupV2ToJSONTyped(value, ignoreDiscriminator = fals
     }
     return {
         'components': (value['components'].map(StatusPageStructureComponentV2_js_1.StatusPageStructureComponentV2ToJSON)),
+        'description': value['description'],
+        'display_aggregated_uptime': value['display_aggregated_uptime'],
+        'hidden': value['hidden'],
         'id': value['id'],
         'name': value['name'],
     };

package/dist/cjs/models/StatusPagesShowStatusPageStructureResultV2.d.ts

@@ -20,7 +20,20 @@ export interface StatusPagesShowStatusPageStructureResultV2 {
      *
      */
     current_structure: StatusPageStructureV2;
+    /**
+     * How the page shows uptime against its components
+     */
+    display_uptime_mode: StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum;
 }
+/**
+ * @export
+ */
+export declare const StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum: {
+    readonly ChartAndPercentage: "chart_and_percentage";
+    readonly ChartOnly: "chart_only";
+    readonly Nothing: "nothing";
+};
+export type StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum = typeof StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum[keyof typeof StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum];
 /**
  * Check if a given object implements the StatusPagesShowStatusPageStructureResultV2 interface.
  */

package/dist/cjs/models/StatusPagesShowStatusPageStructureResultV2.js

@@ -13,18 +13,29 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum = void 0;
 exports.instanceOfStatusPagesShowStatusPageStructureResultV2 = instanceOfStatusPagesShowStatusPageStructureResultV2;
 exports.StatusPagesShowStatusPageStructureResultV2FromJSON = StatusPagesShowStatusPageStructureResultV2FromJSON;
 exports.StatusPagesShowStatusPageStructureResultV2FromJSONTyped = StatusPagesShowStatusPageStructureResultV2FromJSONTyped;
 exports.StatusPagesShowStatusPageStructureResultV2ToJSON = StatusPagesShowStatusPageStructureResultV2ToJSON;
 exports.StatusPagesShowStatusPageStructureResultV2ToJSONTyped = StatusPagesShowStatusPageStructureResultV2ToJSONTyped;
 const StatusPageStructureV2_js_1 = require("./StatusPageStructureV2.js");
+/**
+ * @export
+ */
+exports.StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum = {
+    ChartAndPercentage: 'chart_and_percentage',
+    ChartOnly: 'chart_only',
+    Nothing: 'nothing',
+};
 /**
  * Check if a given object implements the StatusPagesShowStatusPageStructureResultV2 interface.
  */
 function instanceOfStatusPagesShowStatusPageStructureResultV2(value) {
     if (!('current_structure' in value) || value['current_structure'] === undefined)
         return false;
+    if (!('display_uptime_mode' in value) || value['display_uptime_mode'] === undefined)
+        return false;
     return true;
 }
 function StatusPagesShowStatusPageStructureResultV2FromJSON(json) {
@@ -36,6 +47,7 @@ function StatusPagesShowStatusPageStructureResultV2FromJSONTyped(json, ignoreDis
     }
     return {
         'current_structure': (0, StatusPageStructureV2_js_1.StatusPageStructureV2FromJSON)(json['current_structure']),
+        'display_uptime_mode': json['display_uptime_mode'],
     };
 }
 function StatusPagesShowStatusPageStructureResultV2ToJSON(json) {
@@ -47,5 +59,6 @@ function StatusPagesShowStatusPageStructureResultV2ToJSONTyped(value, ignoreDisc
     }
     return {
         'current_structure': (0, StatusPageStructureV2_js_1.StatusPageStructureV2ToJSON)(value['current_structure']),
+        'display_uptime_mode': value['display_uptime_mode'],
     };
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.6.0";
+export declare const VERSION = "2.7.0";

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // Written by `make build` from package.json. Do not edit.
-exports.VERSION = "2.6.0";
+exports.VERSION = "2.7.0";

package/dist/esm/apis/StatusPagesV2Api.d.ts

@@ -399,12 +399,12 @@ export declare class StatusPagesV2Api extends runtime.BaseAPI {
      */
     statusPagesV2ShowStatusPageStructureRequestOpts(requestParameters: StatusPagesV2ShowStatusPageStructureRequest): Promise<runtime.RequestOpts>;
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     statusPagesV2ShowStatusPageStructureRaw(requestParameters: StatusPagesV2ShowStatusPageStructureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StatusPagesShowStatusPageStructureResultV2>>;
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     statusPagesV2ShowStatusPageStructure(requestParameters: StatusPagesV2ShowStatusPageStructureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StatusPagesShowStatusPageStructureResultV2>;

package/dist/esm/apis/StatusPagesV2Api.js

@@ -678,7 +678,7 @@ export class StatusPagesV2Api extends runtime.BaseAPI {
         };
     }
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     async statusPagesV2ShowStatusPageStructureRaw(requestParameters, initOverrides) {
@@ -687,7 +687,7 @@ export class StatusPagesV2Api extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => StatusPagesShowStatusPageStructureResultV2FromJSON(jsonValue));
     }
     /**
-     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
+     * Show the structure of a status page.  This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
      * ShowStatusPageStructure Status Pages V2
      */
     async statusPagesV2ShowStatusPageStructure(requestParameters, initOverrides) {

package/dist/esm/models/StatusPageStructureComponentV2.d.ts

@@ -19,6 +19,14 @@ export interface StatusPageStructureComponentV2 {
      * The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.
      */
     component_id: string;
+    /**
+     * Whether the page shows this component's uptime
+     */
+    display_uptime: boolean;
+    /**
+     * Whether the component is hidden from the page
+     */
+    hidden: boolean;
     /**
      * The name of this component
      */

package/dist/esm/models/StatusPageStructureComponentV2.js

@@ -17,6 +17,10 @@
 export function instanceOfStatusPageStructureComponentV2(value) {
     if (!('component_id' in value) || value['component_id'] === undefined)
         return false;
+    if (!('display_uptime' in value) || value['display_uptime'] === undefined)
+        return false;
+    if (!('hidden' in value) || value['hidden'] === undefined)
+        return false;
     if (!('name' in value) || value['name'] === undefined)
         return false;
     return true;
@@ -30,6 +34,8 @@ export function StatusPageStructureComponentV2FromJSONTyped(json, ignoreDiscrimi
     }
     return {
         'component_id': json['component_id'],
+        'display_uptime': json['display_uptime'],
+        'hidden': json['hidden'],
         'name': json['name'],
     };
 }
@@ -42,6 +48,8 @@ export function StatusPageStructureComponentV2ToJSONTyped(value, ignoreDiscrimin
     }
     return {
         'component_id': value['component_id'],
+        'display_uptime': value['display_uptime'],
+        'hidden': value['hidden'],
         'name': value['name'],
     };
 }

package/dist/esm/models/StatusPageStructureGroupV2.d.ts

@@ -20,6 +20,18 @@ export interface StatusPageStructureGroupV2 {
      * Array of components belonging to this group
      */
     components: Array<StatusPageStructureComponentV2>;
+    /**
+     * A description shown under the group's name
+     */
+    description?: string;
+    /**
+     * Whether the page shows uptime aggregated across the group's components
+     */
+    display_aggregated_uptime: boolean;
+    /**
+     * Whether the group is hidden from the page
+     */
+    hidden: boolean;
     /**
      * Unique ID of this component group
      */

package/dist/esm/models/StatusPageStructureGroupV2.js

@@ -18,6 +18,10 @@ import { StatusPageStructureComponentV2FromJSON, StatusPageStructureComponentV2T
 export function instanceOfStatusPageStructureGroupV2(value) {
     if (!('components' in value) || value['components'] === undefined)
         return false;
+    if (!('display_aggregated_uptime' in value) || value['display_aggregated_uptime'] === undefined)
+        return false;
+    if (!('hidden' in value) || value['hidden'] === undefined)
+        return false;
     if (!('id' in value) || value['id'] === undefined)
         return false;
     if (!('name' in value) || value['name'] === undefined)
@@ -33,6 +37,9 @@ export function StatusPageStructureGroupV2FromJSONTyped(json, ignoreDiscriminato
     }
     return {
         'components': (json['components'].map(StatusPageStructureComponentV2FromJSON)),
+        'description': json['description'] == null ? undefined : json['description'],
+        'display_aggregated_uptime': json['display_aggregated_uptime'],
+        'hidden': json['hidden'],
         'id': json['id'],
         'name': json['name'],
     };
@@ -46,6 +53,9 @@ export function StatusPageStructureGroupV2ToJSONTyped(value, ignoreDiscriminator
     }
     return {
         'components': (value['components'].map(StatusPageStructureComponentV2ToJSON)),
+        'description': value['description'],
+        'display_aggregated_uptime': value['display_aggregated_uptime'],
+        'hidden': value['hidden'],
         'id': value['id'],
         'name': value['name'],
     };

package/dist/esm/models/StatusPagesShowStatusPageStructureResultV2.d.ts

@@ -20,7 +20,20 @@ export interface StatusPagesShowStatusPageStructureResultV2 {
      *
      */
     current_structure: StatusPageStructureV2;
+    /**
+     * How the page shows uptime against its components
+     */
+    display_uptime_mode: StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum;
 }
+/**
+ * @export
+ */
+export declare const StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum: {
+    readonly ChartAndPercentage: "chart_and_percentage";
+    readonly ChartOnly: "chart_only";
+    readonly Nothing: "nothing";
+};
+export type StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum = typeof StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum[keyof typeof StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum];
 /**
  * Check if a given object implements the StatusPagesShowStatusPageStructureResultV2 interface.
  */

package/dist/esm/models/StatusPagesShowStatusPageStructureResultV2.js

@@ -12,12 +12,22 @@
  * Do not edit the class manually.
  */
 import { StatusPageStructureV2FromJSON, StatusPageStructureV2ToJSON, } from './StatusPageStructureV2.js';
+/**
+ * @export
+ */
+export const StatusPagesShowStatusPageStructureResultV2DisplayUptimeModeEnum = {
+    ChartAndPercentage: 'chart_and_percentage',
+    ChartOnly: 'chart_only',
+    Nothing: 'nothing',
+};
 /**
  * Check if a given object implements the StatusPagesShowStatusPageStructureResultV2 interface.
  */
 export function instanceOfStatusPagesShowStatusPageStructureResultV2(value) {
     if (!('current_structure' in value) || value['current_structure'] === undefined)
         return false;
+    if (!('display_uptime_mode' in value) || value['display_uptime_mode'] === undefined)
+        return false;
     return true;
 }
 export function StatusPagesShowStatusPageStructureResultV2FromJSON(json) {
@@ -29,6 +39,7 @@ export function StatusPagesShowStatusPageStructureResultV2FromJSONTyped(json, ig
     }
     return {
         'current_structure': StatusPageStructureV2FromJSON(json['current_structure']),
+        'display_uptime_mode': json['display_uptime_mode'],
     };
 }
 export function StatusPagesShowStatusPageStructureResultV2ToJSON(json) {
@@ -40,5 +51,6 @@ export function StatusPagesShowStatusPageStructureResultV2ToJSONTyped(value, ign
     }
     return {
         'current_structure': StatusPageStructureV2ToJSON(value['current_structure']),
+        'display_uptime_mode': value['display_uptime_mode'],
     };
 }

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.6.0";
+export declare const VERSION = "2.7.0";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
 // Written by `make build` from package.json. Do not edit.
-export const VERSION = "2.6.0";
+export const VERSION = "2.7.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@incident-io/sdk",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "TypeScript SDK for the incident.io API",
   "license": "MIT",
   "author": "incident.io <support@incident.io>",