fulcrum-cem-client 0.0.1 → 0.0.3

package/dist/apis/TokensApi.d.ts

@@ -2,7 +2,7 @@
  * Fulcrum CEM API
  * A comprehensive cloud infrastructure management system designed to orchestrate and monitor distributed cloud resources across multiple providers, with CEM-specific extensions.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,26 +10,26 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { TokenReq, TokenRes, UpdateTokenRequest } from '../models/index';
-export interface CreateTokenRequest {
+import type { TokenReq, TokenRes, TokensList200Response, TokensUpdateRequest } from '../models/index';
+export interface TokensCreateRequest {
     tokenReq: TokenReq;
 }
-export interface DeleteTokenRequest {
+export interface TokensDeleteRequest {
     id: string;
 }
-export interface GetTokenByIdRequest {
+export interface TokensGetRequest {
     id: string;
 }
-export interface ListTokensRequest {
+export interface TokensListRequest {
     page?: number;
     pageSize?: number;
 }
-export interface RegenerateTokenRequest {
+export interface TokensRegenerateRequest {
     id: string;
 }
-export interface UpdateTokenOperationRequest {
+export interface TokensUpdateOperationRequest {
     id: string;
-    updateTokenRequest: UpdateTokenRequest;
+    tokensUpdateRequest: TokensUpdateRequest;
 }
 /**
  * TokensApi - interface
@@ -39,136 +39,154 @@ export interface UpdateTokenOperationRequest {
  */
 export interface TokensApiInterface {
     /**
-     *
-     * @summary Create a new token
+     * Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+     * @summary Create a token
      * @param {TokenReq} tokenReq
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TokensApiInterface
      */
-    createTokenRaw(requestParameters: CreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensCreateRaw(requestParameters: TokensCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
-     * Create a new token
+     * Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+     * Create a token
      */
-    createToken(requestParameters: CreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensCreate(requestParameters: TokensCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
     /**
-     *
+     * Deletes a token by ID
      * @summary Delete a token
-     * @param {string} id The ID of the resource
+     * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TokensApiInterface
      */
-    deleteTokenRaw(requestParameters: DeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    tokensDeleteRaw(requestParameters: TokensDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    deleteToken(requestParameters: DeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    tokensDelete(requestParameters: TokensDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @summary Get a token by ID
-     * @param {string} id The ID of the resource
+     * Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+     * @summary Get a token
+     * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TokensApiInterface
      */
-    getTokenByIdRaw(requestParameters: GetTokenByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensGetRaw(requestParameters: TokensGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
-     * Get a token by ID
+     * Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+     * Get a token
      */
-    getTokenById(requestParameters: GetTokenByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensGet(requestParameters: TokensGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
     /**
-     *
-     * @summary List all tokens
-     * @param {number} [page] The page number (1-based)
-     * @param {number} [pageSize] The number of items per page
+     * Retrieves a paginated list of tokens
+     * @summary List tokens
+     * @param {number} [page]
+     * @param {number} [pageSize]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TokensApiInterface
      */
-    listTokensRaw(requestParameters: ListTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TokenRes>>>;
+    tokensListRaw(requestParameters: TokensListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokensList200Response>>;
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    listTokens(requestParameters: ListTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TokenRes>>;
+    tokensList(requestParameters: TokensListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokensList200Response>;
     /**
-     *
-     * @summary Regenerate a token
-     * @param {string} id The ID of the resource
+     * Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+     * @summary Regenerate token value
+     * @param {string} id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TokensApiInterface
      */
-    regenerateTokenRaw(requestParameters: RegenerateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensRegenerateRaw(requestParameters: TokensRegenerateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
-     * Regenerate a token
+     * Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+     * Regenerate token value
      */
-    regenerateToken(requestParameters: RegenerateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensRegenerate(requestParameters: TokensRegenerateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
     /**
-     *
+     * Updates an existing token
      * @summary Update a token
-     * @param {string} id The ID of the resource
-     * @param {UpdateTokenRequest} updateTokenRequest
+     * @param {string} id
+     * @param {TokensUpdateRequest} tokensUpdateRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TokensApiInterface
      */
-    updateTokenRaw(requestParameters: UpdateTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensUpdateRaw(requestParameters: TokensUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
+     * Updates an existing token
      * Update a token
      */
-    updateToken(requestParameters: UpdateTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensUpdate(requestParameters: TokensUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
 }
 /**
  *
  */
 export declare class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
     /**
-     * Create a new token
+     * Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+     * Create a token
      */
-    createTokenRaw(requestParameters: CreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensCreateRaw(requestParameters: TokensCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
-     * Create a new token
+     * Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+     * Create a token
      */
-    createToken(requestParameters: CreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensCreate(requestParameters: TokensCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    deleteTokenRaw(requestParameters: DeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    tokensDeleteRaw(requestParameters: TokensDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    deleteToken(requestParameters: DeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    tokensDelete(requestParameters: TokensDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Get a token by ID
+     * Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+     * Get a token
      */
-    getTokenByIdRaw(requestParameters: GetTokenByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensGetRaw(requestParameters: TokensGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
-     * Get a token by ID
+     * Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+     * Get a token
      */
-    getTokenById(requestParameters: GetTokenByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensGet(requestParameters: TokensGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    listTokensRaw(requestParameters: ListTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TokenRes>>>;
+    tokensListRaw(requestParameters: TokensListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokensList200Response>>;
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    listTokens(requestParameters?: ListTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TokenRes>>;
+    tokensList(requestParameters?: TokensListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokensList200Response>;
     /**
-     * Regenerate a token
+     * Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+     * Regenerate token value
      */
-    regenerateTokenRaw(requestParameters: RegenerateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensRegenerateRaw(requestParameters: TokensRegenerateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
-     * Regenerate a token
+     * Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+     * Regenerate token value
      */
-    regenerateToken(requestParameters: RegenerateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensRegenerate(requestParameters: TokensRegenerateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
     /**
+     * Updates an existing token
      * Update a token
      */
-    updateTokenRaw(requestParameters: UpdateTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
+    tokensUpdateRaw(requestParameters: TokensUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>>;
     /**
+     * Updates an existing token
      * Update a token
      */
-    updateToken(requestParameters: UpdateTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
+    tokensUpdate(requestParameters: TokensUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes>;
 }

package/dist/apis/TokensApi.js

@@ -5,7 +5,7 @@
  * Fulcrum CEM API
  * A comprehensive cloud infrastructure management system designed to orchestrate and monitor distributed cloud resources across multiple providers, with CEM-specific extensions.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,12 +30,13 @@ const index_1 = require("../models/index");
  */
 class TokensApi extends runtime.BaseAPI {
     /**
-     * Create a new token
+     * Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+     * Create a token
      */
-    createTokenRaw(requestParameters, initOverrides) {
+    tokensCreateRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['tokenReq'] == null) {
-                throw new runtime.RequiredError('tokenReq', 'Required parameter "tokenReq" was null or undefined when calling createToken().');
+                throw new runtime.RequiredError('tokenReq', 'Required parameter "tokenReq" was null or undefined when calling tokensCreate().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -56,21 +57,23 @@ class TokensApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create a new token
+     * Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+     * Create a token
      */
-    createToken(requestParameters, initOverrides) {
+    tokensCreate(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.createTokenRaw(requestParameters, initOverrides);
+            const response = yield this.tokensCreateRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    deleteTokenRaw(requestParameters, initOverrides) {
+    tokensDeleteRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteToken().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling tokensDelete().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -90,20 +93,22 @@ class TokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    deleteToken(requestParameters, initOverrides) {
+    tokensDelete(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.deleteTokenRaw(requestParameters, initOverrides);
+            yield this.tokensDeleteRaw(requestParameters, initOverrides);
         });
     }
     /**
-     * Get a token by ID
+     * Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+     * Get a token
      */
-    getTokenByIdRaw(requestParameters, initOverrides) {
+    tokensGetRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTokenById().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling tokensGet().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -123,18 +128,20 @@ class TokensApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a token by ID
+     * Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+     * Get a token
      */
-    getTokenById(requestParameters, initOverrides) {
+    tokensGet(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getTokenByIdRaw(requestParameters, initOverrides);
+            const response = yield this.tokensGetRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    listTokensRaw(requestParameters, initOverrides) {
+    tokensListRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['page'] != null) {
@@ -155,25 +162,27 @@ class TokensApi extends runtime.BaseAPI {
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.TokenResFromJSON));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TokensList200ResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    listTokens() {
+    tokensList() {
         return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
-            const response = yield this.listTokensRaw(requestParameters, initOverrides);
+            const response = yield this.tokensListRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * Regenerate a token
+     * Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+     * Regenerate token value
      */
-    regenerateTokenRaw(requestParameters, initOverrides) {
+    tokensRegenerateRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling regenerateToken().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling tokensRegenerate().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -193,24 +202,26 @@ class TokensApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Regenerate a token
+     * Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+     * Regenerate token value
      */
-    regenerateToken(requestParameters, initOverrides) {
+    tokensRegenerate(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.regenerateTokenRaw(requestParameters, initOverrides);
+            const response = yield this.tokensRegenerateRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
+     * Updates an existing token
      * Update a token
      */
-    updateTokenRaw(requestParameters, initOverrides) {
+    tokensUpdateRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateToken().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling tokensUpdate().');
             }
-            if (requestParameters['updateTokenRequest'] == null) {
-                throw new runtime.RequiredError('updateTokenRequest', 'Required parameter "updateTokenRequest" was null or undefined when calling updateToken().');
+            if (requestParameters['tokensUpdateRequest'] == null) {
+                throw new runtime.RequiredError('tokensUpdateRequest', 'Required parameter "tokensUpdateRequest" was null or undefined when calling tokensUpdate().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -226,17 +237,18 @@ class TokensApi extends runtime.BaseAPI {
                 method: 'PATCH',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.UpdateTokenRequestToJSON)(requestParameters['updateTokenRequest']),
+                body: (0, index_1.TokensUpdateRequestToJSON)(requestParameters['tokensUpdateRequest']),
             }, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TokenResFromJSON)(jsonValue));
         });
     }
     /**
+     * Updates an existing token
      * Update a token
      */
-    updateToken(requestParameters, initOverrides) {
+    tokensUpdate(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.updateTokenRaw(requestParameters, initOverrides);
+            const response = yield this.tokensUpdateRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }