@randock/nameshift-api-client 0.0.447 → 0.0.449

package/src/apis/APIKeysApi.ts

@@ -0,0 +1,271 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 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 {
+  ApiKeyDto,
+  ApiKeyScopeDto,
+  CreateApiKeyInput,
+  CreatedApiKeyDto,
+  UpdateApiKeyInput,
+  ValidationException,
+} from '../models/index';
+import {
+    ApiKeyDtoFromJSON,
+    ApiKeyDtoToJSON,
+    ApiKeyScopeDtoFromJSON,
+    ApiKeyScopeDtoToJSON,
+    CreateApiKeyInputFromJSON,
+    CreateApiKeyInputToJSON,
+    CreatedApiKeyDtoFromJSON,
+    CreatedApiKeyDtoToJSON,
+    UpdateApiKeyInputFromJSON,
+    UpdateApiKeyInputToJSON,
+    ValidationExceptionFromJSON,
+    ValidationExceptionToJSON,
+} from '../models/index';
+
+export interface APIKeysApiCreateApiKeyRequest {
+    createApiKeyInput: CreateApiKeyInput;
+}
+
+export interface APIKeysApiRevokeApiKeyRequest {
+    apiKeyId: string;
+}
+
+export interface APIKeysApiUpdateApiKeyRequest {
+    apiKeyId: string;
+    updateApiKeyInput: UpdateApiKeyInput;
+}
+
+/**
+ * 
+ */
+export class APIKeysApi extends runtime.BaseAPI {
+
+    /**
+     * Creates an API key for the seller account. The token is returned once in this response and cannot be retrieved afterwards.
+     * Create an API key
+     */
+    async createApiKeyRaw(requestParameters: APIKeysApiCreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedApiKeyDto>> {
+        if (requestParameters['createApiKeyInput'] == null) {
+            throw new runtime.RequiredError(
+                'createApiKeyInput',
+                'Required parameter "createApiKeyInput" was null or undefined when calling createApiKey().'
+            );
+        }
+
+        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", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/api-keys`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateApiKeyInputToJSON(requestParameters['createApiKeyInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreatedApiKeyDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates an API key for the seller account. The token is returned once in this response and cannot be retrieved afterwards.
+     * Create an API key
+     */
+    async createApiKey(requestParameters: APIKeysApiCreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedApiKeyDto> {
+        const response = await this.createApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists the API keys belonging to the seller account. Tokens are never returned.
+     * List API keys
+     */
+    async getApiKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiKeyDto>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/api-keys`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ApiKeyDtoFromJSON));
+    }
+
+    /**
+     * Lists the API keys belonging to the seller account. Tokens are never returned.
+     * List API keys
+     */
+    async getApiKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiKeyDto>> {
+        const response = await this.getApiKeysRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists the scopes that can be granted to a seller API key, with a description of the access each one confers.
+     * List grantable API key scopes
+     */
+    async getAvailableApiKeyScopesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiKeyScopeDto>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/api-keys/available-scopes`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ApiKeyScopeDtoFromJSON));
+    }
+
+    /**
+     * Lists the scopes that can be granted to a seller API key, with a description of the access each one confers.
+     * List grantable API key scopes
+     */
+    async getAvailableApiKeyScopes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiKeyScopeDto>> {
+        const response = await this.getAvailableApiKeyScopesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Revokes an API key. Requests made with it stop being accepted immediately.
+     * Revoke an API key
+     */
+    async revokeApiKeyRaw(requestParameters: APIKeysApiRevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['apiKeyId'] == null) {
+            throw new runtime.RequiredError(
+                'apiKeyId',
+                'Required parameter "apiKeyId" was null or undefined when calling revokeApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/api-keys/{apiKeyId}`.replace(`{${"apiKeyId"}}`, encodeURIComponent(String(requestParameters['apiKeyId']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Revokes an API key. Requests made with it stop being accepted immediately.
+     * Revoke an API key
+     */
+    async revokeApiKey(requestParameters: APIKeysApiRevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.revokeApiKeyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Renames an API key or replaces its scopes. The token itself is unchanged.
+     * Update an API key
+     */
+    async updateApiKeyRaw(requestParameters: APIKeysApiUpdateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyDto>> {
+        if (requestParameters['apiKeyId'] == null) {
+            throw new runtime.RequiredError(
+                'apiKeyId',
+                'Required parameter "apiKeyId" was null or undefined when calling updateApiKey().'
+            );
+        }
+
+        if (requestParameters['updateApiKeyInput'] == null) {
+            throw new runtime.RequiredError(
+                'updateApiKeyInput',
+                'Required parameter "updateApiKeyInput" was null or undefined when calling updateApiKey().'
+            );
+        }
+
+        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", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/api-keys/{apiKeyId}`.replace(`{${"apiKeyId"}}`, encodeURIComponent(String(requestParameters['apiKeyId']))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateApiKeyInputToJSON(requestParameters['updateApiKeyInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Renames an API key or replaces its scopes. The token itself is unchanged.
+     * Update an API key
+     */
+    async updateApiKey(requestParameters: APIKeysApiUpdateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyDto> {
+        const response = await this.updateApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}