@randock/nameshift-api-client 0.0.447 → 0.0.449

package/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 .openapi-generator-ignore
 README.md
 package.json
+src/apis/APIKeysApi.ts
 src/apis/AccountsApi.ts
 src/apis/AccountsPublicApi.ts
 src/apis/AddressPublicApi.ts
@@ -106,6 +107,8 @@ src/models/AirwallexBankAccountDetailsDtoLocalMethod.ts
 src/models/AirwallexBankAccountDetailsDtoLocalMethodCode.ts
 src/models/AirwallexDepositDto.ts
 src/models/AirwallexDepositDtoFee.ts
+src/models/ApiKeyDto.ts
+src/models/ApiKeyScopeDto.ts
 src/models/AuBankAccountDetails.ts
 src/models/AuctionBidDto.ts
 src/models/AuctionBidInput.ts
@@ -196,6 +199,7 @@ src/models/CompanyTaxIdDto.ts
 src/models/ConflictException.ts
 src/models/CreateAccountPaymentInput.ts
 src/models/CreateAccountPaymentManualTransactionInput.ts
+src/models/CreateApiKeyInput.ts
 src/models/CreateBankAccountInput.ts
 src/models/CreateBuyerLeadMessageInput.ts
 src/models/CreateChallengeInput.ts
@@ -207,6 +211,7 @@ src/models/CreateOrderInput.ts
 src/models/CreateSubscriptionBillingPeriodicityInput.ts
 src/models/CreateSubscriptionInput.ts
 src/models/CreateSubscriptionManualTransactionInput.ts
+src/models/CreatedApiKeyDto.ts
 src/models/CursorBasedPageInfo.ts
 src/models/CursorBasedPaginationResponse.ts
 src/models/DeleteDomainsInput.ts
@@ -506,6 +511,7 @@ src/models/TopSellerAccountDto.ts
 src/models/UkBankAccountDetails.ts
 src/models/UpdateAccountBillingInformationInput.ts
 src/models/UpdateAccountChallengeRewardBalanceInput.ts
+src/models/UpdateApiKeyInput.ts
 src/models/UpdateAuctionMuteStatusInput.ts
 src/models/UpdateBuyerDomainTransferBuyerInfoInput.ts
 src/models/UpdateBuyerDomainTransferIpsTagInputDto.ts

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.447
+## @randock/nameshift-api-client@0.0.449
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.447 --save
+npm install @randock/nameshift-api-client@0.0.449 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-b16518573bfed486629257b16565a7436b69e47de57a4687cf2b290774663712d2ca7860ddbea923af3e066d5a2b9b11
+ef35da7f8b5a1be28b52ab412632a00d9304060f6dfc00b9920c1e53d7de37a2123c512e852434329c6418d266a52fa8

package/dist/apis/APIKeysApi.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 } from '../models/index';
+export interface APIKeysApiCreateApiKeyRequest {
+    createApiKeyInput: CreateApiKeyInput;
+}
+export interface APIKeysApiRevokeApiKeyRequest {
+    apiKeyId: string;
+}
+export interface APIKeysApiUpdateApiKeyRequest {
+    apiKeyId: string;
+    updateApiKeyInput: UpdateApiKeyInput;
+}
+/**
+ *
+ */
+export declare 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
+     */
+    createApiKeyRaw(requestParameters: APIKeysApiCreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedApiKeyDto>>;
+    /**
+     * 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
+     */
+    createApiKey(requestParameters: APIKeysApiCreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedApiKeyDto>;
+    /**
+     * Lists the API keys belonging to the seller account. Tokens are never returned.
+     * List API keys
+     */
+    getApiKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiKeyDto>>>;
+    /**
+     * Lists the API keys belonging to the seller account. Tokens are never returned.
+     * List API keys
+     */
+    getApiKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiKeyDto>>;
+    /**
+     * 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
+     */
+    getAvailableApiKeyScopesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiKeyScopeDto>>>;
+    /**
+     * 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
+     */
+    getAvailableApiKeyScopes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiKeyScopeDto>>;
+    /**
+     * Revokes an API key. Requests made with it stop being accepted immediately.
+     * Revoke an API key
+     */
+    revokeApiKeyRaw(requestParameters: APIKeysApiRevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Revokes an API key. Requests made with it stop being accepted immediately.
+     * Revoke an API key
+     */
+    revokeApiKey(requestParameters: APIKeysApiRevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Renames an API key or replaces its scopes. The token itself is unchanged.
+     * Update an API key
+     */
+    updateApiKeyRaw(requestParameters: APIKeysApiUpdateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyDto>>;
+    /**
+     * Renames an API key or replaces its scopes. The token itself is unchanged.
+     * Update an API key
+     */
+    updateApiKey(requestParameters: APIKeysApiUpdateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyDto>;
+}

package/dist/apis/APIKeysApi.js

@@ -0,0 +1,354 @@
+"use strict";
+/* 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.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIKeysApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var APIKeysApi = /** @class */ (function (_super) {
+    __extends(APIKeysApi, _super);
+    function APIKeysApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * 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
+     */
+    APIKeysApi.prototype.createApiKeyRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['createApiKeyInput'] == null) {
+                            throw new runtime.RequiredError('createApiKeyInput', 'Required parameter "createApiKeyInput" was null or undefined when calling createApiKey().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/private/api-keys",
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.CreateApiKeyInputToJSON)(requestParameters['createApiKeyInput']),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.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
+     */
+    APIKeysApi.prototype.createApiKey = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.createApiKeyRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Lists the API keys belonging to the seller account. Tokens are never returned.
+     * List API keys
+     */
+    APIKeysApi.prototype.getApiKeysRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/private/api-keys",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.ApiKeyDtoFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * Lists the API keys belonging to the seller account. Tokens are never returned.
+     * List API keys
+     */
+    APIKeysApi.prototype.getApiKeys = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getApiKeysRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    APIKeysApi.prototype.getAvailableApiKeyScopesRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/private/api-keys/available-scopes",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.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
+     */
+    APIKeysApi.prototype.getAvailableApiKeyScopes = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAvailableApiKeyScopesRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Revokes an API key. Requests made with it stop being accepted immediately.
+     * Revoke an API key
+     */
+    APIKeysApi.prototype.revokeApiKeyRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['apiKeyId'] == null) {
+                            throw new runtime.RequiredError('apiKeyId', 'Required parameter "apiKeyId" was null or undefined when calling revokeApiKey().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/private/api-keys/{apiKeyId}".replace("{".concat("apiKeyId", "}"), encodeURIComponent(String(requestParameters['apiKeyId']))),
+                            method: 'DELETE',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Revokes an API key. Requests made with it stop being accepted immediately.
+     * Revoke an API key
+     */
+    APIKeysApi.prototype.revokeApiKey = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.revokeApiKeyRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Renames an API key or replaces its scopes. The token itself is unchanged.
+     * Update an API key
+     */
+    APIKeysApi.prototype.updateApiKeyRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        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().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/private/api-keys/{apiKeyId}".replace("{".concat("apiKeyId", "}"), encodeURIComponent(String(requestParameters['apiKeyId']))),
+                            method: 'PATCH',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.UpdateApiKeyInputToJSON)(requestParameters['updateApiKeyInput']),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ApiKeyDtoFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Renames an API key or replaces its scopes. The token itself is unchanged.
+     * Update an API key
+     */
+    APIKeysApi.prototype.updateApiKey = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateApiKeyRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return APIKeysApi;
+}(runtime.BaseAPI));
+exports.APIKeysApi = APIKeysApi;