@emilgroup/setting-sdk 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +2 -2
  5. package/api/default-api.ts +120 -0
  6. package/api/public-keys-api.ts +785 -0
  7. package/api.ts +29 -0
  8. package/base.ts +282 -0
  9. package/common.ts +198 -0
  10. package/configuration.ts +110 -0
  11. package/dist/api/default-api.d.ts +66 -0
  12. package/dist/api/default-api.js +196 -0
  13. package/dist/api/public-keys-api.d.ts +441 -0
  14. package/dist/api/public-keys-api.js +731 -0
  15. package/dist/api.d.ts +13 -0
  16. package/dist/api.js +31 -0
  17. package/dist/base.d.ts +77 -0
  18. package/dist/base.js +324 -0
  19. package/dist/common.d.ts +91 -0
  20. package/dist/common.js +276 -0
  21. package/dist/configuration.d.ts +89 -0
  22. package/dist/configuration.js +52 -0
  23. package/dist/index.d.ts +15 -0
  24. package/dist/index.js +36 -0
  25. package/dist/models/create-public-key-request-dto.d.ts +24 -0
  26. package/dist/models/create-public-key-request-dto.js +15 -0
  27. package/dist/models/create-public-key-response-class.d.ts +25 -0
  28. package/dist/models/create-public-key-response-class.js +15 -0
  29. package/dist/models/delete-public-key-request-dto.d.ts +24 -0
  30. package/dist/models/delete-public-key-request-dto.js +15 -0
  31. package/dist/models/get-public-key-response-class.d.ts +25 -0
  32. package/dist/models/get-public-key-response-class.js +15 -0
  33. package/dist/models/index.d.ts +11 -0
  34. package/dist/models/index.js +27 -0
  35. package/dist/models/inline-response200.d.ts +54 -0
  36. package/dist/models/inline-response200.js +15 -0
  37. package/dist/models/inline-response503.d.ts +54 -0
  38. package/dist/models/inline-response503.js +15 -0
  39. package/dist/models/list-public-keys-response-class.d.ts +43 -0
  40. package/dist/models/list-public-keys-response-class.js +15 -0
  41. package/dist/models/public-key-class.d.ts +66 -0
  42. package/dist/models/public-key-class.js +15 -0
  43. package/dist/models/rotate-public-key-response-class.d.ts +25 -0
  44. package/dist/models/rotate-public-key-response-class.js +15 -0
  45. package/dist/models/update-public-key-request-dto.d.ts +30 -0
  46. package/dist/models/update-public-key-request-dto.js +15 -0
  47. package/dist/models/update-public-key-response-class.d.ts +25 -0
  48. package/dist/models/update-public-key-response-class.js +15 -0
  49. package/git_push.sh +57 -0
  50. package/index.ts +19 -0
  51. package/models/create-public-key-request-dto.ts +30 -0
  52. package/models/create-public-key-response-class.ts +31 -0
  53. package/models/delete-public-key-request-dto.ts +30 -0
  54. package/models/get-public-key-response-class.ts +31 -0
  55. package/models/index.ts +11 -0
  56. package/models/inline-response200.ts +48 -0
  57. package/models/inline-response503.ts +48 -0
  58. package/models/list-public-keys-response-class.ts +49 -0
  59. package/models/public-key-class.ts +72 -0
  60. package/models/rotate-public-key-response-class.ts +31 -0
  61. package/models/update-public-key-request-dto.ts +36 -0
  62. package/models/update-public-key-response-class.ts +31 -0
  63. package/package.json +22 -8
  64. package/tsconfig.json +23 -0
  65. package/index.js +0 -99
  66. package/scripts/deploy.js +0 -235
@@ -0,0 +1,196 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL SettingService
6
+ * The EMIL SettingService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ 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;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ /**
89
+ * DefaultApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var DefaultApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ *
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ check: function (options) {
101
+ if (options === void 0) { options = {}; }
102
+ return __awaiter(_this, void 0, void 0, function () {
103
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
104
+ return __generator(this, function (_a) {
105
+ localVarPath = "/settingservice/health";
106
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
107
+ if (configuration) {
108
+ baseOptions = configuration.baseOptions;
109
+ baseAccessToken = configuration.accessToken;
110
+ }
111
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
112
+ localVarHeaderParameter = {};
113
+ localVarQueryParameter = {};
114
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
115
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
116
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
117
+ return [2 /*return*/, {
118
+ url: (0, common_1.toPathString)(localVarUrlObj),
119
+ options: localVarRequestOptions,
120
+ }];
121
+ });
122
+ });
123
+ },
124
+ };
125
+ };
126
+ exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
127
+ /**
128
+ * DefaultApi - functional programming interface
129
+ * @export
130
+ */
131
+ var DefaultApiFp = function (configuration) {
132
+ var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
133
+ return {
134
+ /**
135
+ *
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ check: function (options) {
140
+ return __awaiter(this, void 0, void 0, function () {
141
+ var localVarAxiosArgs;
142
+ return __generator(this, function (_a) {
143
+ switch (_a.label) {
144
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.check(options)];
145
+ case 1:
146
+ localVarAxiosArgs = _a.sent();
147
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
148
+ }
149
+ });
150
+ });
151
+ },
152
+ };
153
+ };
154
+ exports.DefaultApiFp = DefaultApiFp;
155
+ /**
156
+ * DefaultApi - factory interface
157
+ * @export
158
+ */
159
+ var DefaultApiFactory = function (configuration, basePath, axios) {
160
+ var localVarFp = (0, exports.DefaultApiFp)(configuration);
161
+ return {
162
+ /**
163
+ *
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ */
167
+ check: function (options) {
168
+ return localVarFp.check(options).then(function (request) { return request(axios, basePath); });
169
+ },
170
+ };
171
+ };
172
+ exports.DefaultApiFactory = DefaultApiFactory;
173
+ /**
174
+ * DefaultApi - object-oriented interface
175
+ * @export
176
+ * @class DefaultApi
177
+ * @extends {BaseAPI}
178
+ */
179
+ var DefaultApi = /** @class */ (function (_super) {
180
+ __extends(DefaultApi, _super);
181
+ function DefaultApi() {
182
+ return _super !== null && _super.apply(this, arguments) || this;
183
+ }
184
+ /**
185
+ *
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ * @memberof DefaultApi
189
+ */
190
+ DefaultApi.prototype.check = function (options) {
191
+ var _this = this;
192
+ return (0, exports.DefaultApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
193
+ };
194
+ return DefaultApi;
195
+ }(base_1.BaseAPI));
196
+ exports.DefaultApi = DefaultApi;
@@ -0,0 +1,441 @@
1
+ /**
2
+ * EMIL SettingService
3
+ * The EMIL SettingService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreatePublicKeyRequestDto } from '../models';
16
+ import { CreatePublicKeyResponseClass } from '../models';
17
+ import { DeletePublicKeyRequestDto } from '../models';
18
+ import { GetPublicKeyResponseClass } from '../models';
19
+ import { ListPublicKeysResponseClass } from '../models';
20
+ import { RotatePublicKeyResponseClass } from '../models';
21
+ import { UpdatePublicKeyRequestDto } from '../models';
22
+ import { UpdatePublicKeyResponseClass } from '../models';
23
+ /**
24
+ * PublicKeysApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ * Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
30
+ * @summary Create the public key
31
+ * @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ createPublicKey: (createPublicKeyRequestDto: CreatePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
39
+ * @summary Delete the public key
40
+ * @param {string} code Unique identifier for the object.
41
+ * @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
42
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ deletePublicKey: (code: string, deletePublicKeyRequestDto: DeletePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
+ /**
48
+ * Retrieve a single public key by its code.
49
+ * @summary Retrieve the public key
50
+ * @param {string} code
51
+ * @param {string} expand
52
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ getPublicKey: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
+ /**
58
+ * List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
59
+ * @summary List public keys
60
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
61
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
62
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
63
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, slug, key&lt;/i&gt;
64
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
65
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ listPublicKeys: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
+ /**
71
+ * Rotate (replace) a public key with new key material. The code stays the same; only the key value changes. We recommend rotating keys every three months for security. Returns the updated public key.
72
+ * @summary Create the public key
73
+ * @param {string} code
74
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ rotatePublicKey: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ /**
80
+ * Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
81
+ * @summary Update the public key
82
+ * @param {string} code
83
+ * @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
84
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ */
88
+ updatePublicKey: (code: string, updatePublicKeyRequestDto: UpdatePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
89
+ };
90
+ /**
91
+ * PublicKeysApi - functional programming interface
92
+ * @export
93
+ */
94
+ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
95
+ /**
96
+ * Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
97
+ * @summary Create the public key
98
+ * @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
99
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ createPublicKey(createPublicKeyRequestDto: CreatePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePublicKeyResponseClass>>;
104
+ /**
105
+ * Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
106
+ * @summary Delete the public key
107
+ * @param {string} code Unique identifier for the object.
108
+ * @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
109
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ deletePublicKey(code: string, deletePublicKeyRequestDto: DeletePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
114
+ /**
115
+ * Retrieve a single public key by its code.
116
+ * @summary Retrieve the public key
117
+ * @param {string} code
118
+ * @param {string} expand
119
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ */
123
+ getPublicKey(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicKeyResponseClass>>;
124
+ /**
125
+ * List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
126
+ * @summary List public keys
127
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
128
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
129
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
130
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, slug, key&lt;/i&gt;
131
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
132
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ listPublicKeys(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicKeysResponseClass>>;
137
+ /**
138
+ * Rotate (replace) a public key with new key material. The code stays the same; only the key value changes. We recommend rotating keys every three months for security. Returns the updated public key.
139
+ * @summary Create the public key
140
+ * @param {string} code
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ rotatePublicKey(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RotatePublicKeyResponseClass>>;
146
+ /**
147
+ * Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
148
+ * @summary Update the public key
149
+ * @param {string} code
150
+ * @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
151
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ */
155
+ updatePublicKey(code: string, updatePublicKeyRequestDto: UpdatePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePublicKeyResponseClass>>;
156
+ };
157
+ /**
158
+ * PublicKeysApi - factory interface
159
+ * @export
160
+ */
161
+ export declare const PublicKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
162
+ /**
163
+ * Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
164
+ * @summary Create the public key
165
+ * @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
166
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ */
170
+ createPublicKey(createPublicKeyRequestDto: CreatePublicKeyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePublicKeyResponseClass>;
171
+ /**
172
+ * Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
173
+ * @summary Delete the public key
174
+ * @param {string} code Unique identifier for the object.
175
+ * @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
176
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ */
180
+ deletePublicKey(code: string, deletePublicKeyRequestDto: DeletePublicKeyRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
181
+ /**
182
+ * Retrieve a single public key by its code.
183
+ * @summary Retrieve the public key
184
+ * @param {string} code
185
+ * @param {string} expand
186
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ getPublicKey(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetPublicKeyResponseClass>;
191
+ /**
192
+ * List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
193
+ * @summary List public keys
194
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
195
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
196
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
197
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, slug, key&lt;/i&gt;
198
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
199
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
200
+ * @param {*} [options] Override http request option.
201
+ * @throws {RequiredError}
202
+ */
203
+ listPublicKeys(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPublicKeysResponseClass>;
204
+ /**
205
+ * Rotate (replace) a public key with new key material. The code stays the same; only the key value changes. We recommend rotating keys every three months for security. Returns the updated public key.
206
+ * @summary Create the public key
207
+ * @param {string} code
208
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ rotatePublicKey(code: string, authorization?: string, options?: any): AxiosPromise<RotatePublicKeyResponseClass>;
213
+ /**
214
+ * Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
215
+ * @summary Update the public key
216
+ * @param {string} code
217
+ * @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
218
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ updatePublicKey(code: string, updatePublicKeyRequestDto: UpdatePublicKeyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePublicKeyResponseClass>;
223
+ };
224
+ /**
225
+ * Request parameters for createPublicKey operation in PublicKeysApi.
226
+ * @export
227
+ * @interface PublicKeysApiCreatePublicKeyRequest
228
+ */
229
+ export interface PublicKeysApiCreatePublicKeyRequest {
230
+ /**
231
+ *
232
+ * @type {CreatePublicKeyRequestDto}
233
+ * @memberof PublicKeysApiCreatePublicKey
234
+ */
235
+ readonly createPublicKeyRequestDto: CreatePublicKeyRequestDto;
236
+ /**
237
+ * Bearer Token: provided by the login endpoint under the name accessToken.
238
+ * @type {string}
239
+ * @memberof PublicKeysApiCreatePublicKey
240
+ */
241
+ readonly authorization?: string;
242
+ }
243
+ /**
244
+ * Request parameters for deletePublicKey operation in PublicKeysApi.
245
+ * @export
246
+ * @interface PublicKeysApiDeletePublicKeyRequest
247
+ */
248
+ export interface PublicKeysApiDeletePublicKeyRequest {
249
+ /**
250
+ * Unique identifier for the object.
251
+ * @type {string}
252
+ * @memberof PublicKeysApiDeletePublicKey
253
+ */
254
+ readonly code: string;
255
+ /**
256
+ *
257
+ * @type {DeletePublicKeyRequestDto}
258
+ * @memberof PublicKeysApiDeletePublicKey
259
+ */
260
+ readonly deletePublicKeyRequestDto: DeletePublicKeyRequestDto;
261
+ /**
262
+ * Bearer Token: provided by the login endpoint under the name accessToken.
263
+ * @type {string}
264
+ * @memberof PublicKeysApiDeletePublicKey
265
+ */
266
+ readonly authorization?: string;
267
+ }
268
+ /**
269
+ * Request parameters for getPublicKey operation in PublicKeysApi.
270
+ * @export
271
+ * @interface PublicKeysApiGetPublicKeyRequest
272
+ */
273
+ export interface PublicKeysApiGetPublicKeyRequest {
274
+ /**
275
+ *
276
+ * @type {string}
277
+ * @memberof PublicKeysApiGetPublicKey
278
+ */
279
+ readonly code: string;
280
+ /**
281
+ *
282
+ * @type {string}
283
+ * @memberof PublicKeysApiGetPublicKey
284
+ */
285
+ readonly expand: string;
286
+ /**
287
+ * Bearer Token: provided by the login endpoint under the name accessToken.
288
+ * @type {string}
289
+ * @memberof PublicKeysApiGetPublicKey
290
+ */
291
+ readonly authorization?: string;
292
+ }
293
+ /**
294
+ * Request parameters for listPublicKeys operation in PublicKeysApi.
295
+ * @export
296
+ * @interface PublicKeysApiListPublicKeysRequest
297
+ */
298
+ export interface PublicKeysApiListPublicKeysRequest {
299
+ /**
300
+ * Bearer Token: provided by the login endpoint under the name accessToken.
301
+ * @type {string}
302
+ * @memberof PublicKeysApiListPublicKeys
303
+ */
304
+ readonly authorization?: string;
305
+ /**
306
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
307
+ * @type {string}
308
+ * @memberof PublicKeysApiListPublicKeys
309
+ */
310
+ readonly filter?: string;
311
+ /**
312
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, slug, key, createdAt, updatedAt, deletedAt&lt;/i&gt;
313
+ * @type {string}
314
+ * @memberof PublicKeysApiListPublicKeys
315
+ */
316
+ readonly filters?: string;
317
+ /**
318
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, slug, key&lt;/i&gt;
319
+ * @type {string}
320
+ * @memberof PublicKeysApiListPublicKeys
321
+ */
322
+ readonly search?: string;
323
+ /**
324
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
325
+ * @type {string}
326
+ * @memberof PublicKeysApiListPublicKeys
327
+ */
328
+ readonly order?: string;
329
+ /**
330
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
331
+ * @type {string}
332
+ * @memberof PublicKeysApiListPublicKeys
333
+ */
334
+ readonly expand?: string;
335
+ }
336
+ /**
337
+ * Request parameters for rotatePublicKey operation in PublicKeysApi.
338
+ * @export
339
+ * @interface PublicKeysApiRotatePublicKeyRequest
340
+ */
341
+ export interface PublicKeysApiRotatePublicKeyRequest {
342
+ /**
343
+ *
344
+ * @type {string}
345
+ * @memberof PublicKeysApiRotatePublicKey
346
+ */
347
+ readonly code: string;
348
+ /**
349
+ * Bearer Token: provided by the login endpoint under the name accessToken.
350
+ * @type {string}
351
+ * @memberof PublicKeysApiRotatePublicKey
352
+ */
353
+ readonly authorization?: string;
354
+ }
355
+ /**
356
+ * Request parameters for updatePublicKey operation in PublicKeysApi.
357
+ * @export
358
+ * @interface PublicKeysApiUpdatePublicKeyRequest
359
+ */
360
+ export interface PublicKeysApiUpdatePublicKeyRequest {
361
+ /**
362
+ *
363
+ * @type {string}
364
+ * @memberof PublicKeysApiUpdatePublicKey
365
+ */
366
+ readonly code: string;
367
+ /**
368
+ *
369
+ * @type {UpdatePublicKeyRequestDto}
370
+ * @memberof PublicKeysApiUpdatePublicKey
371
+ */
372
+ readonly updatePublicKeyRequestDto: UpdatePublicKeyRequestDto;
373
+ /**
374
+ * Bearer Token: provided by the login endpoint under the name accessToken.
375
+ * @type {string}
376
+ * @memberof PublicKeysApiUpdatePublicKey
377
+ */
378
+ readonly authorization?: string;
379
+ }
380
+ /**
381
+ * PublicKeysApi - object-oriented interface
382
+ * @export
383
+ * @class PublicKeysApi
384
+ * @extends {BaseAPI}
385
+ */
386
+ export declare class PublicKeysApi extends BaseAPI {
387
+ /**
388
+ * Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
389
+ * @summary Create the public key
390
+ * @param {PublicKeysApiCreatePublicKeyRequest} requestParameters Request parameters.
391
+ * @param {*} [options] Override http request option.
392
+ * @throws {RequiredError}
393
+ * @memberof PublicKeysApi
394
+ */
395
+ createPublicKey(requestParameters: PublicKeysApiCreatePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePublicKeyResponseClass, any, {}>>;
396
+ /**
397
+ * Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
398
+ * @summary Delete the public key
399
+ * @param {PublicKeysApiDeletePublicKeyRequest} requestParameters Request parameters.
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ * @memberof PublicKeysApi
403
+ */
404
+ deletePublicKey(requestParameters: PublicKeysApiDeletePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
405
+ /**
406
+ * Retrieve a single public key by its code.
407
+ * @summary Retrieve the public key
408
+ * @param {PublicKeysApiGetPublicKeyRequest} requestParameters Request parameters.
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ * @memberof PublicKeysApi
412
+ */
413
+ getPublicKey(requestParameters: PublicKeysApiGetPublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPublicKeyResponseClass, any, {}>>;
414
+ /**
415
+ * List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
416
+ * @summary List public keys
417
+ * @param {PublicKeysApiListPublicKeysRequest} requestParameters Request parameters.
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ * @memberof PublicKeysApi
421
+ */
422
+ listPublicKeys(requestParameters?: PublicKeysApiListPublicKeysRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPublicKeysResponseClass, any, {}>>;
423
+ /**
424
+ * Rotate (replace) a public key with new key material. The code stays the same; only the key value changes. We recommend rotating keys every three months for security. Returns the updated public key.
425
+ * @summary Create the public key
426
+ * @param {PublicKeysApiRotatePublicKeyRequest} requestParameters Request parameters.
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ * @memberof PublicKeysApi
430
+ */
431
+ rotatePublicKey(requestParameters: PublicKeysApiRotatePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RotatePublicKeyResponseClass, any, {}>>;
432
+ /**
433
+ * Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
434
+ * @summary Update the public key
435
+ * @param {PublicKeysApiUpdatePublicKeyRequest} requestParameters Request parameters.
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ * @memberof PublicKeysApi
439
+ */
440
+ updatePublicKey(requestParameters: PublicKeysApiUpdatePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePublicKeyResponseClass, any, {}>>;
441
+ }