@nightscoutfoundation/nocturne 0.1.0

package/src/apis/V4AlertInvitesApi.ts

@@ -0,0 +1,333 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nocturne SDK
+ * Nocturne V4 API SDK
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  AlertInviteResponse,
+  CreateAlertInviteRequest,
+  ProblemDetails,
+} from '../models/index';
+import {
+    AlertInviteResponseFromJSON,
+    AlertInviteResponseToJSON,
+    CreateAlertInviteRequestFromJSON,
+    CreateAlertInviteRequestToJSON,
+    ProblemDetailsFromJSON,
+    ProblemDetailsToJSON,
+} from '../models/index';
+
+export interface V4AlertInvitesApiAlertInvitesCreateInviteRequest {
+    createAlertInviteRequest: CreateAlertInviteRequest;
+}
+
+export interface V4AlertInvitesApiAlertInvitesRedeemInviteRequest {
+    token: string;
+}
+
+export interface V4AlertInvitesApiAlertInvitesRevokeInviteRequest {
+    id: string;
+}
+
+export interface V4AlertInvitesApiAlertInvitesValidateInviteRequest {
+    token: string;
+}
+
+/**
+ * V4AlertInvitesApi - interface
+ * 
+ * @export
+ * @interface V4AlertInvitesApiInterface
+ */
+export interface V4AlertInvitesApiInterface {
+    /**
+     * Creates request options for alertInvitesCreateInvite without sending the request
+     * @param {CreateAlertInviteRequest} createAlertInviteRequest 
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesCreateInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesCreateInviteRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Generate an invite link for a follower to join an escalation step.
+     * @param {CreateAlertInviteRequest} createAlertInviteRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesCreateInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesCreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertInviteResponse>>;
+
+    /**
+     * Generate an invite link for a follower to join an escalation step.
+     */
+    alertInvitesCreateInvite(createAlertInviteRequest: CreateAlertInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertInviteResponse>;
+
+    /**
+     * Creates request options for alertInvitesRedeemInvite without sending the request
+     * @param {string} token 
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesRedeemInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesRedeemInviteRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Redeem an invite token.
+     * @param {string} token 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesRedeemInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesRedeemInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Redeem an invite token.
+     */
+    alertInvitesRedeemInvite(token: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for alertInvitesRevokeInvite without sending the request
+     * @param {string} id 
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesRevokeInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesRevokeInviteRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Revoke an unredeemed invite.
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesRevokeInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesRevokeInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Revoke an unredeemed invite.
+     */
+    alertInvitesRevokeInvite(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for alertInvitesValidateInvite without sending the request
+     * @param {string} token 
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesValidateInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesValidateInviteRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Validate an invite token (public endpoint for redemption flow).
+     * @param {string} token 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V4AlertInvitesApiInterface
+     */
+    alertInvitesValidateInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesValidateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertInviteResponse>>;
+
+    /**
+     * Validate an invite token (public endpoint for redemption flow).
+     */
+    alertInvitesValidateInvite(token: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertInviteResponse>;
+
+}
+
+/**
+ * 
+ */
+export class V4AlertInvitesApi extends runtime.BaseAPI implements V4AlertInvitesApiInterface {
+
+    /**
+     * Creates request options for alertInvitesCreateInvite without sending the request
+     */
+    async alertInvitesCreateInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesCreateInviteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createAlertInviteRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createAlertInviteRequest',
+                'Required parameter "createAlertInviteRequest" was null or undefined when calling alertInvitesCreateInvite().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v4/alert-invites`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateAlertInviteRequestToJSON(requestParameters['createAlertInviteRequest']),
+        };
+    }
+
+    /**
+     * Generate an invite link for a follower to join an escalation step.
+     */
+    async alertInvitesCreateInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesCreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertInviteResponse>> {
+        const requestOptions = await this.alertInvitesCreateInviteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertInviteResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Generate an invite link for a follower to join an escalation step.
+     */
+    async alertInvitesCreateInvite(createAlertInviteRequest: CreateAlertInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertInviteResponse> {
+        const response = await this.alertInvitesCreateInviteRaw({ createAlertInviteRequest: createAlertInviteRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for alertInvitesRedeemInvite without sending the request
+     */
+    async alertInvitesRedeemInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesRedeemInviteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling alertInvitesRedeemInvite().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v4/alert-invites/{token}/redeem`;
+        urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Redeem an invite token.
+     */
+    async alertInvitesRedeemInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesRedeemInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.alertInvitesRedeemInviteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Redeem an invite token.
+     */
+    async alertInvitesRedeemInvite(token: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.alertInvitesRedeemInviteRaw({ token: token }, initOverrides);
+    }
+
+    /**
+     * Creates request options for alertInvitesRevokeInvite without sending the request
+     */
+    async alertInvitesRevokeInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesRevokeInviteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling alertInvitesRevokeInvite().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v4/alert-invites/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Revoke an unredeemed invite.
+     */
+    async alertInvitesRevokeInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesRevokeInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.alertInvitesRevokeInviteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Revoke an unredeemed invite.
+     */
+    async alertInvitesRevokeInvite(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.alertInvitesRevokeInviteRaw({ id: id }, initOverrides);
+    }
+
+    /**
+     * Creates request options for alertInvitesValidateInvite without sending the request
+     */
+    async alertInvitesValidateInviteRequestOpts(requestParameters: V4AlertInvitesApiAlertInvitesValidateInviteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling alertInvitesValidateInvite().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v4/alert-invites/{token}`;
+        urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Validate an invite token (public endpoint for redemption flow).
+     */
+    async alertInvitesValidateInviteRaw(requestParameters: V4AlertInvitesApiAlertInvitesValidateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertInviteResponse>> {
+        const requestOptions = await this.alertInvitesValidateInviteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertInviteResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Validate an invite token (public endpoint for redemption flow).
+     */
+    async alertInvitesValidateInvite(token: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertInviteResponse> {
+        const response = await this.alertInvitesValidateInviteRaw({ token: token }, initOverrides);
+        return await response.value();
+    }
+
+}