@zlayer/api-client 0.10.86

package/src/apis/TunnelsApi.ts

@@ -0,0 +1,394 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * 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 {
+  CreateNodeTunnelRequest,
+  CreateNodeTunnelResponse,
+  CreateTunnelRequest,
+  CreateTunnelResponse,
+  SuccessResponse,
+  TunnelStatus,
+  TunnelSummary,
+} from '../models/index';
+import {
+    CreateNodeTunnelRequestFromJSON,
+    CreateNodeTunnelRequestToJSON,
+    CreateNodeTunnelResponseFromJSON,
+    CreateNodeTunnelResponseToJSON,
+    CreateTunnelRequestFromJSON,
+    CreateTunnelRequestToJSON,
+    CreateTunnelResponseFromJSON,
+    CreateTunnelResponseToJSON,
+    SuccessResponseFromJSON,
+    SuccessResponseToJSON,
+    TunnelStatusFromJSON,
+    TunnelStatusToJSON,
+    TunnelSummaryFromJSON,
+    TunnelSummaryToJSON,
+} from '../models/index';
+
+export interface CreateNodeTunnelOperationRequest {
+    createNodeTunnelRequest: CreateNodeTunnelRequest;
+}
+
+export interface CreateTunnelOperationRequest {
+    createTunnelRequest: CreateTunnelRequest;
+}
+
+export interface GetTunnelStatusRequest {
+    id: string;
+}
+
+export interface RemoveNodeTunnelRequest {
+    name: string;
+}
+
+export interface RevokeTunnelRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class TunnelsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createNodeTunnel without sending the request
+     */
+    async createNodeTunnelRequestOpts(requestParameters: CreateNodeTunnelOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createNodeTunnelRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createNodeTunnelRequest',
+                'Required parameter "createNodeTunnelRequest" was null or undefined when calling createNodeTunnel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/tunnels/node`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateNodeTunnelRequestToJSON(requestParameters['createNodeTunnelRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if validation fails or the user lacks permission.
+     * Create a node-to-node tunnel.
+     */
+    async createNodeTunnelRaw(requestParameters: CreateNodeTunnelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateNodeTunnelResponse>> {
+        const requestOptions = await this.createNodeTunnelRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateNodeTunnelResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns an error if validation fails or the user lacks permission.
+     * Create a node-to-node tunnel.
+     */
+    async createNodeTunnel(requestParameters: CreateNodeTunnelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateNodeTunnelResponse> {
+        const response = await this.createNodeTunnelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createTunnel without sending the request
+     */
+    async createTunnelRequestOpts(requestParameters: CreateTunnelOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createTunnelRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createTunnelRequest',
+                'Required parameter "createTunnelRequest" was null or undefined when calling createTunnel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/tunnels`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateTunnelRequestToJSON(requestParameters['createTunnelRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if validation fails or authentication is invalid.
+     * Create a new tunnel token.
+     */
+    async createTunnelRaw(requestParameters: CreateTunnelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTunnelResponse>> {
+        const requestOptions = await this.createTunnelRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateTunnelResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns an error if validation fails or authentication is invalid.
+     * Create a new tunnel token.
+     */
+    async createTunnel(requestParameters: CreateTunnelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTunnelResponse> {
+        const response = await this.createTunnelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getTunnelStatus without sending the request
+     */
+    async getTunnelStatusRequestOpts(requestParameters: GetTunnelStatusRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getTunnelStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/tunnels/{id}/status`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if the tunnel is not found.
+     * Get tunnel status.
+     */
+    async getTunnelStatusRaw(requestParameters: GetTunnelStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TunnelStatus>> {
+        const requestOptions = await this.getTunnelStatusRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TunnelStatusFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns an error if the tunnel is not found.
+     * Get tunnel status.
+     */
+    async getTunnelStatus(requestParameters: GetTunnelStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TunnelStatus> {
+        const response = await this.getTunnelStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listTunnels without sending the request
+     */
+    async listTunnelsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/tunnels`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if authentication fails.
+     * List all tunnels.
+     */
+    async listTunnelsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TunnelSummary>>> {
+        const requestOptions = await this.listTunnelsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TunnelSummaryFromJSON));
+    }
+
+    /**
+     * # Errors  Returns an error if authentication fails.
+     * List all tunnels.
+     */
+    async listTunnels(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TunnelSummary>> {
+        const response = await this.listTunnelsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for removeNodeTunnel without sending the request
+     */
+    async removeNodeTunnelRequestOpts(requestParameters: RemoveNodeTunnelRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['name'] == null) {
+            throw new runtime.RequiredError(
+                'name',
+                'Required parameter "name" was null or undefined when calling removeNodeTunnel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/tunnels/node/{name}`;
+        urlPath = urlPath.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if the tunnel is not found or the user lacks permission.
+     * Remove a node-to-node tunnel.
+     */
+    async removeNodeTunnelRaw(requestParameters: RemoveNodeTunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResponse>> {
+        const requestOptions = await this.removeNodeTunnelRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns an error if the tunnel is not found or the user lacks permission.
+     * Remove a node-to-node tunnel.
+     */
+    async removeNodeTunnel(requestParameters: RemoveNodeTunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse> {
+        const response = await this.removeNodeTunnelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for revokeTunnel without sending the request
+     */
+    async revokeTunnelRequestOpts(requestParameters: RevokeTunnelRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling revokeTunnel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer_auth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/tunnels/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns an error if the tunnel is not found.
+     * Revoke (delete) a tunnel.
+     */
+    async revokeTunnelRaw(requestParameters: RevokeTunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResponse>> {
+        const requestOptions = await this.revokeTunnelRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns an error if the tunnel is not found.
+     * Revoke (delete) a tunnel.
+     */
+    async revokeTunnel(requestParameters: RevokeTunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse> {
+        const response = await this.revokeTunnelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}