fulcrum-cem-client 0.0.1 → 0.0.3

package/src/apis/TokensApi.ts

@@ -4,7 +4,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).
@@ -18,7 +18,8 @@ import type {
   ErrorRes,
   TokenReq,
   TokenRes,
-  UpdateTokenRequest,
+  TokensList200Response,
+  TokensUpdateRequest,
 } from '../models/index';
 import {
     ErrorResFromJSON,
@@ -27,34 +28,36 @@ import {
     TokenReqToJSON,
     TokenResFromJSON,
     TokenResToJSON,
-    UpdateTokenRequestFromJSON,
-    UpdateTokenRequestToJSON,
+    TokensList200ResponseFromJSON,
+    TokensList200ResponseToJSON,
+    TokensUpdateRequestFromJSON,
+    TokensUpdateRequestToJSON,
 } from '../models/index';
 
-export interface CreateTokenRequest {
+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;
 }
 
 /**
@@ -65,96 +68,102 @@ 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>;
 
 }
 
@@ -164,13 +173,14 @@ export interface TokensApiInterface {
 export 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
      */
-    async createTokenRaw(requestParameters: CreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
+    async tokensCreateRaw(requestParameters: TokensCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
         if (requestParameters['tokenReq'] == null) {
             throw new runtime.RequiredError(
                 'tokenReq',
-                'Required parameter "tokenReq" was null or undefined when calling createToken().'
+                'Required parameter "tokenReq" was null or undefined when calling tokensCreate().'
             );
         }
 
@@ -200,21 +210,23 @@ export 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
      */
-    async createToken(requestParameters: CreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
-        const response = await this.createTokenRaw(requestParameters, initOverrides);
+    async tokensCreate(requestParameters: TokensCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
+        const response = await this.tokensCreateRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    async deleteTokenRaw(requestParameters: DeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async tokensDeleteRaw(requestParameters: TokensDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['id'] == null) {
             throw new runtime.RequiredError(
                 'id',
-                'Required parameter "id" was null or undefined when calling deleteToken().'
+                'Required parameter "id" was null or undefined when calling tokensDelete().'
             );
         }
 
@@ -242,20 +254,22 @@ export class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
     }
 
     /**
+     * Deletes a token by ID
      * Delete a token
      */
-    async deleteToken(requestParameters: DeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.deleteTokenRaw(requestParameters, initOverrides);
+    async tokensDelete(requestParameters: TokensDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await 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
      */
-    async getTokenByIdRaw(requestParameters: GetTokenByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
+    async tokensGetRaw(requestParameters: TokensGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
         if (requestParameters['id'] == null) {
             throw new runtime.RequiredError(
                 'id',
-                'Required parameter "id" was null or undefined when calling getTokenById().'
+                'Required parameter "id" was null or undefined when calling tokensGet().'
             );
         }
 
@@ -283,17 +297,19 @@ export class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
     }
 
     /**
-     * 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
      */
-    async getTokenById(requestParameters: GetTokenByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
-        const response = await this.getTokenByIdRaw(requestParameters, initOverrides);
+    async tokensGet(requestParameters: TokensGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
+        const response = await this.tokensGetRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    async listTokensRaw(requestParameters: ListTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TokenRes>>> {
+    async tokensListRaw(requestParameters: TokensListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokensList200Response>> {
         const queryParameters: any = {};
 
         if (requestParameters['page'] != null) {
@@ -321,25 +337,27 @@ export class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TokenResFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => TokensList200ResponseFromJSON(jsonValue));
     }
 
     /**
-     * List all tokens
+     * Retrieves a paginated list of tokens
+     * List tokens
      */
-    async listTokens(requestParameters: ListTokensRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TokenRes>> {
-        const response = await this.listTokensRaw(requestParameters, initOverrides);
+    async tokensList(requestParameters: TokensListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokensList200Response> {
+        const response = await this.tokensListRaw(requestParameters, initOverrides);
         return await 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
      */
-    async regenerateTokenRaw(requestParameters: RegenerateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
+    async tokensRegenerateRaw(requestParameters: TokensRegenerateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
         if (requestParameters['id'] == null) {
             throw new runtime.RequiredError(
                 'id',
-                'Required parameter "id" was null or undefined when calling regenerateToken().'
+                'Required parameter "id" was null or undefined when calling tokensRegenerate().'
             );
         }
 
@@ -367,28 +385,30 @@ export class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
     }
 
     /**
-     * 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
      */
-    async regenerateToken(requestParameters: RegenerateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
-        const response = await this.regenerateTokenRaw(requestParameters, initOverrides);
+    async tokensRegenerate(requestParameters: TokensRegenerateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
+        const response = await this.tokensRegenerateRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
+     * Updates an existing token
      * Update a token
      */
-    async updateTokenRaw(requestParameters: UpdateTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
+    async tokensUpdateRaw(requestParameters: TokensUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRes>> {
         if (requestParameters['id'] == null) {
             throw new runtime.RequiredError(
                 'id',
-                'Required parameter "id" was null or undefined when calling updateToken().'
+                'Required parameter "id" was null or undefined when calling tokensUpdate().'
             );
         }
 
-        if (requestParameters['updateTokenRequest'] == null) {
+        if (requestParameters['tokensUpdateRequest'] == null) {
             throw new runtime.RequiredError(
-                'updateTokenRequest',
-                'Required parameter "updateTokenRequest" was null or undefined when calling updateToken().'
+                'tokensUpdateRequest',
+                'Required parameter "tokensUpdateRequest" was null or undefined when calling tokensUpdate().'
             );
         }
 
@@ -412,17 +432,18 @@ export class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
-            body: UpdateTokenRequestToJSON(requestParameters['updateTokenRequest']),
+            body: TokensUpdateRequestToJSON(requestParameters['tokensUpdateRequest']),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => TokenResFromJSON(jsonValue));
     }
 
     /**
+     * Updates an existing token
      * Update a token
      */
-    async updateToken(requestParameters: UpdateTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
-        const response = await this.updateTokenRaw(requestParameters, initOverrides);
+    async tokensUpdate(requestParameters: TokensUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRes> {
+        const response = await this.tokensUpdateRaw(requestParameters, initOverrides);
         return await response.value();
     }