@zlayer/api-client 0.10.86

package/src/apis/OverlayApi.ts

@@ -0,0 +1,195 @@
+/* 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 {
+  DnsStatusResponse,
+  IpAllocationResponse,
+  OverlayStatusResponse,
+  PeerListResponse,
+} from '../models/index';
+import {
+    DnsStatusResponseFromJSON,
+    DnsStatusResponseToJSON,
+    IpAllocationResponseFromJSON,
+    IpAllocationResponseToJSON,
+    OverlayStatusResponseFromJSON,
+    OverlayStatusResponseToJSON,
+    PeerListResponseFromJSON,
+    PeerListResponseToJSON,
+} from '../models/index';
+
+/**
+ * 
+ */
+export class OverlayApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getDnsStatus without sending the request
+     */
+    async getDnsStatusRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/overlay/dns`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns DNS server configuration and registered service count. When DNS is not configured, returns a disabled status (not an error).
+     * Get DNS service status.
+     */
+    async getDnsStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DnsStatusResponse>> {
+        const requestOptions = await this.getDnsStatusRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DnsStatusResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns DNS server configuration and registered service count. When DNS is not configured, returns a disabled status (not an error).
+     * Get DNS service status.
+     */
+    async getDnsStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DnsStatusResponse> {
+        const response = await this.getDnsStatusRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getIpAllocation without sending the request
+     */
+    async getIpAllocationRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/overlay/ip-alloc`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the overlay network\'s IP allocation statistics including CIDR, total IPs, allocated count, and utilization. Available on any node that has an active overlay (not just leaders).  # Errors  Returns an error if the overlay is not initialized.
+     * Get IP allocation status.
+     */
+    async getIpAllocationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IpAllocationResponse>> {
+        const requestOptions = await this.getIpAllocationRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IpAllocationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the overlay network\'s IP allocation statistics including CIDR, total IPs, allocated count, and utilization. Available on any node that has an active overlay (not just leaders).  # Errors  Returns an error if the overlay is not initialized.
+     * Get IP allocation status.
+     */
+    async getIpAllocation(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IpAllocationResponse> {
+        const response = await this.getIpAllocationRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getOverlayPeers without sending the request
+     */
+    async getOverlayPeersRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/overlay/peers`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns peer information from the overlay transport\'s UAPI state. When the overlay is not initialized, returns 503.  # Errors  Returns an error if the overlay network is not initialized.
+     * Get list of overlay peers.
+     */
+    async getOverlayPeersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PeerListResponse>> {
+        const requestOptions = await this.getOverlayPeersRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PeerListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns peer information from the overlay transport\'s UAPI state. When the overlay is not initialized, returns 503.  # Errors  Returns an error if the overlay network is not initialized.
+     * Get list of overlay peers.
+     */
+    async getOverlayPeers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PeerListResponse> {
+        const response = await this.getOverlayPeersRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getOverlayStatus without sending the request
+     */
+    async getOverlayStatusRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/overlay/status`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the current overlay network status including interface name, node IP, CIDR, peer counts, and whether the transport is active. Returns 503 if the overlay network is not initialized (e.g. host networking mode).  # Errors  Returns an error if the overlay network is not initialized.
+     * Get overlay network status.
+     */
+    async getOverlayStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OverlayStatusResponse>> {
+        const requestOptions = await this.getOverlayStatusRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OverlayStatusResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the current overlay network status including interface name, node IP, CIDR, peer counts, and whether the transport is active. Returns 503 if the overlay network is not initialized (e.g. host networking mode).  # Errors  Returns an error if the overlay network is not initialized.
+     * Get overlay network status.
+     */
+    async getOverlayStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OverlayStatusResponse> {
+        const response = await this.getOverlayStatusRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/PermissionsApi.ts

@@ -0,0 +1,188 @@
+/* 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 {
+  GrantPermissionRequest,
+  StoredPermission,
+} from '../models/index';
+import {
+    GrantPermissionRequestFromJSON,
+    GrantPermissionRequestToJSON,
+    StoredPermissionFromJSON,
+    StoredPermissionToJSON,
+} from '../models/index';
+
+export interface GrantPermissionOperationRequest {
+    grantPermissionRequest: GrantPermissionRequest;
+}
+
+export interface ListPermissionsRequest {
+    user?: string | null;
+    group?: string | null;
+}
+
+export interface RevokePermissionRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class PermissionsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for grantPermission without sending the request
+     */
+    async grantPermissionRequestOpts(requestParameters: GrantPermissionOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['grantPermissionRequest'] == null) {
+            throw new runtime.RequiredError(
+                'grantPermissionRequest',
+                'Required parameter "grantPermissionRequest" was null or undefined when calling grantPermission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v1/permissions`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GrantPermissionRequestToJSON(requestParameters['grantPermissionRequest']),
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] when required fields are missing, or [`ApiError::Internal`] if the store fails.
+     * Grant a permission. Admin only.
+     */
+    async grantPermissionRaw(requestParameters: GrantPermissionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredPermission>> {
+        const requestOptions = await this.grantPermissionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StoredPermissionFromJSON(jsonValue));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] when required fields are missing, or [`ApiError::Internal`] if the store fails.
+     * Grant a permission. Admin only.
+     */
+    async grantPermission(requestParameters: GrantPermissionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredPermission> {
+        const response = await this.grantPermissionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listPermissions without sending the request
+     */
+    async listPermissionsRequestOpts(requestParameters: ListPermissionsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['user'] != null) {
+            queryParameters['user'] = requestParameters['user'];
+        }
+
+        if (requestParameters['group'] != null) {
+            queryParameters['group'] = requestParameters['group'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/permissions`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Exactly one of `user` or `group` must be provided.  # Errors  Returns [`ApiError::BadRequest`] when neither or both query parameters are provided, or [`ApiError::Internal`] if the store fails.
+     * List permissions for a subject (user or group).
+     */
+    async listPermissionsRaw(requestParameters: ListPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StoredPermission>>> {
+        const requestOptions = await this.listPermissionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StoredPermissionFromJSON));
+    }
+
+    /**
+     * Exactly one of `user` or `group` must be provided.  # Errors  Returns [`ApiError::BadRequest`] when neither or both query parameters are provided, or [`ApiError::Internal`] if the store fails.
+     * List permissions for a subject (user or group).
+     */
+    async listPermissions(requestParameters: ListPermissionsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredPermission>> {
+        const response = await this.listPermissionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for revokePermission without sending the request
+     */
+    async revokePermissionRequestOpts(requestParameters: RevokePermissionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling revokePermission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/permissions/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the permission does not exist, or [`ApiError::Internal`] if the store fails.
+     * Revoke a permission by id. Admin only.
+     */
+    async revokePermissionRaw(requestParameters: RevokePermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.revokePermissionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::NotFound`] when the permission does not exist, or [`ApiError::Internal`] if the store fails.
+     * Revoke a permission by id. Admin only.
+     */
+    async revokePermission(requestParameters: RevokePermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.revokePermissionRaw(requestParameters, initOverrides);
+    }
+
+}