@emilgroup/setting-sdk-node 0.1.1-beta.4 → 0.2.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.
- package/README.md +2 -2
- package/api/public-keys-api.ts +24 -24
- package/dist/api/public-keys-api.d.ts +24 -24
- package/dist/api/public-keys-api.js +24 -24
- package/dist/models/create-public-key-request-dto.d.ts +1 -1
- package/dist/models/public-key-class.d.ts +3 -3
- package/dist/models/update-public-key-request-dto.d.ts +2 -2
- package/models/create-public-key-request-dto.ts +1 -1
- package/models/public-key-class.ts +3 -3
- package/models/update-public-key-request-dto.ts +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/setting-sdk-node@0.
|
|
20
|
+
npm install @emilgroup/setting-sdk-node@0.2.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/setting-sdk-node@0.
|
|
24
|
+
yarn add @emilgroup/setting-sdk-node@0.2.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
package/api/public-keys-api.ts
CHANGED
|
@@ -47,7 +47,7 @@ const FormData = require('form-data');
|
|
|
47
47
|
export const PublicKeysApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
48
|
return {
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
51
51
|
* @summary Create the public key
|
|
52
52
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
53
53
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -94,7 +94,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
94
94
|
};
|
|
95
95
|
},
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
98
98
|
* @summary Delete the public key
|
|
99
99
|
* @param {string} code Unique identifier for the object.
|
|
100
100
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -145,7 +145,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
145
145
|
};
|
|
146
146
|
},
|
|
147
147
|
/**
|
|
148
|
-
*
|
|
148
|
+
* Retrieve a single public key by its code.
|
|
149
149
|
* @summary Retrieve the public key
|
|
150
150
|
* @param {string} code
|
|
151
151
|
* @param {string} expand
|
|
@@ -197,7 +197,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
197
197
|
};
|
|
198
198
|
},
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
200
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
201
201
|
* @summary List public keys
|
|
202
202
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
203
203
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -263,7 +263,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
263
263
|
};
|
|
264
264
|
},
|
|
265
265
|
/**
|
|
266
|
-
*
|
|
266
|
+
* 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.
|
|
267
267
|
* @summary Create the public key
|
|
268
268
|
* @param {string} code
|
|
269
269
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -308,7 +308,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
308
308
|
};
|
|
309
309
|
},
|
|
310
310
|
/**
|
|
311
|
-
*
|
|
311
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
312
312
|
* @summary Update the public key
|
|
313
313
|
* @param {string} code
|
|
314
314
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -369,7 +369,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
369
369
|
const localVarAxiosParamCreator = PublicKeysApiAxiosParamCreator(configuration)
|
|
370
370
|
return {
|
|
371
371
|
/**
|
|
372
|
-
*
|
|
372
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
373
373
|
* @summary Create the public key
|
|
374
374
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
375
375
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -381,7 +381,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
381
381
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
382
382
|
},
|
|
383
383
|
/**
|
|
384
|
-
*
|
|
384
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
385
385
|
* @summary Delete the public key
|
|
386
386
|
* @param {string} code Unique identifier for the object.
|
|
387
387
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -394,7 +394,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
394
394
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
395
395
|
},
|
|
396
396
|
/**
|
|
397
|
-
*
|
|
397
|
+
* Retrieve a single public key by its code.
|
|
398
398
|
* @summary Retrieve the public key
|
|
399
399
|
* @param {string} code
|
|
400
400
|
* @param {string} expand
|
|
@@ -407,7 +407,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
407
407
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
408
408
|
},
|
|
409
409
|
/**
|
|
410
|
-
*
|
|
410
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
411
411
|
* @summary List public keys
|
|
412
412
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
413
413
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -423,7 +423,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
423
423
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
424
424
|
},
|
|
425
425
|
/**
|
|
426
|
-
*
|
|
426
|
+
* 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.
|
|
427
427
|
* @summary Create the public key
|
|
428
428
|
* @param {string} code
|
|
429
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -435,7 +435,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
435
435
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
436
436
|
},
|
|
437
437
|
/**
|
|
438
|
-
*
|
|
438
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
439
439
|
* @summary Update the public key
|
|
440
440
|
* @param {string} code
|
|
441
441
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -458,7 +458,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
458
458
|
const localVarFp = PublicKeysApiFp(configuration)
|
|
459
459
|
return {
|
|
460
460
|
/**
|
|
461
|
-
*
|
|
461
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
462
462
|
* @summary Create the public key
|
|
463
463
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
464
464
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -469,7 +469,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
469
469
|
return localVarFp.createPublicKey(createPublicKeyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
470
470
|
},
|
|
471
471
|
/**
|
|
472
|
-
*
|
|
472
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
473
473
|
* @summary Delete the public key
|
|
474
474
|
* @param {string} code Unique identifier for the object.
|
|
475
475
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -481,7 +481,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
481
481
|
return localVarFp.deletePublicKey(code, deletePublicKeyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
482
482
|
},
|
|
483
483
|
/**
|
|
484
|
-
*
|
|
484
|
+
* Retrieve a single public key by its code.
|
|
485
485
|
* @summary Retrieve the public key
|
|
486
486
|
* @param {string} code
|
|
487
487
|
* @param {string} expand
|
|
@@ -493,7 +493,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
493
493
|
return localVarFp.getPublicKey(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
494
494
|
},
|
|
495
495
|
/**
|
|
496
|
-
*
|
|
496
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
497
497
|
* @summary List public keys
|
|
498
498
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
499
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -508,7 +508,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
508
508
|
return localVarFp.listPublicKeys(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
|
|
509
509
|
},
|
|
510
510
|
/**
|
|
511
|
-
*
|
|
511
|
+
* 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.
|
|
512
512
|
* @summary Create the public key
|
|
513
513
|
* @param {string} code
|
|
514
514
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -519,7 +519,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
519
519
|
return localVarFp.rotatePublicKey(code, authorization, options).then((request) => request(axios, basePath));
|
|
520
520
|
},
|
|
521
521
|
/**
|
|
522
|
-
*
|
|
522
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
523
523
|
* @summary Update the public key
|
|
524
524
|
* @param {string} code
|
|
525
525
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -716,7 +716,7 @@ export interface PublicKeysApiUpdatePublicKeyRequest {
|
|
|
716
716
|
*/
|
|
717
717
|
export class PublicKeysApi extends BaseAPI {
|
|
718
718
|
/**
|
|
719
|
-
*
|
|
719
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
720
720
|
* @summary Create the public key
|
|
721
721
|
* @param {PublicKeysApiCreatePublicKeyRequest} requestParameters Request parameters.
|
|
722
722
|
* @param {*} [options] Override http request option.
|
|
@@ -728,7 +728,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
728
728
|
}
|
|
729
729
|
|
|
730
730
|
/**
|
|
731
|
-
*
|
|
731
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
732
732
|
* @summary Delete the public key
|
|
733
733
|
* @param {PublicKeysApiDeletePublicKeyRequest} requestParameters Request parameters.
|
|
734
734
|
* @param {*} [options] Override http request option.
|
|
@@ -740,7 +740,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
740
740
|
}
|
|
741
741
|
|
|
742
742
|
/**
|
|
743
|
-
*
|
|
743
|
+
* Retrieve a single public key by its code.
|
|
744
744
|
* @summary Retrieve the public key
|
|
745
745
|
* @param {PublicKeysApiGetPublicKeyRequest} requestParameters Request parameters.
|
|
746
746
|
* @param {*} [options] Override http request option.
|
|
@@ -752,7 +752,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
752
752
|
}
|
|
753
753
|
|
|
754
754
|
/**
|
|
755
|
-
*
|
|
755
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
756
756
|
* @summary List public keys
|
|
757
757
|
* @param {PublicKeysApiListPublicKeysRequest} requestParameters Request parameters.
|
|
758
758
|
* @param {*} [options] Override http request option.
|
|
@@ -764,7 +764,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
764
764
|
}
|
|
765
765
|
|
|
766
766
|
/**
|
|
767
|
-
*
|
|
767
|
+
* 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.
|
|
768
768
|
* @summary Create the public key
|
|
769
769
|
* @param {PublicKeysApiRotatePublicKeyRequest} requestParameters Request parameters.
|
|
770
770
|
* @param {*} [options] Override http request option.
|
|
@@ -776,7 +776,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
776
776
|
}
|
|
777
777
|
|
|
778
778
|
/**
|
|
779
|
-
*
|
|
779
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
780
780
|
* @summary Update the public key
|
|
781
781
|
* @param {PublicKeysApiUpdatePublicKeyRequest} requestParameters Request parameters.
|
|
782
782
|
* @param {*} [options] Override http request option.
|
|
@@ -26,7 +26,7 @@ import { UpdatePublicKeyResponseClass } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
30
30
|
* @summary Create the public key
|
|
31
31
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
32
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,7 +35,7 @@ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configurat
|
|
|
35
35
|
*/
|
|
36
36
|
createPublicKey: (createPublicKeyRequestDto: CreatePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
39
39
|
* @summary Delete the public key
|
|
40
40
|
* @param {string} code Unique identifier for the object.
|
|
41
41
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -45,7 +45,7 @@ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configurat
|
|
|
45
45
|
*/
|
|
46
46
|
deletePublicKey: (code: string, deletePublicKeyRequestDto: DeletePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
48
|
+
* Retrieve a single public key by its code.
|
|
49
49
|
* @summary Retrieve the public key
|
|
50
50
|
* @param {string} code
|
|
51
51
|
* @param {string} expand
|
|
@@ -55,7 +55,7 @@ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configurat
|
|
|
55
55
|
*/
|
|
56
56
|
getPublicKey: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
59
59
|
* @summary List public keys
|
|
60
60
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
61
61
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -68,7 +68,7 @@ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configurat
|
|
|
68
68
|
*/
|
|
69
69
|
listPublicKeys: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
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
72
|
* @summary Create the public key
|
|
73
73
|
* @param {string} code
|
|
74
74
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -77,7 +77,7 @@ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configurat
|
|
|
77
77
|
*/
|
|
78
78
|
rotatePublicKey: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
79
|
/**
|
|
80
|
-
*
|
|
80
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
81
81
|
* @summary Update the public key
|
|
82
82
|
* @param {string} code
|
|
83
83
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -93,7 +93,7 @@ export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configurat
|
|
|
93
93
|
*/
|
|
94
94
|
export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
97
97
|
* @summary Create the public key
|
|
98
98
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -102,7 +102,7 @@ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
|
102
102
|
*/
|
|
103
103
|
createPublicKey(createPublicKeyRequestDto: CreatePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePublicKeyResponseClass>>;
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
106
106
|
* @summary Delete the public key
|
|
107
107
|
* @param {string} code Unique identifier for the object.
|
|
108
108
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -112,7 +112,7 @@ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
|
112
112
|
*/
|
|
113
113
|
deletePublicKey(code: string, deletePublicKeyRequestDto: DeletePublicKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
114
114
|
/**
|
|
115
|
-
*
|
|
115
|
+
* Retrieve a single public key by its code.
|
|
116
116
|
* @summary Retrieve the public key
|
|
117
117
|
* @param {string} code
|
|
118
118
|
* @param {string} expand
|
|
@@ -122,7 +122,7 @@ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
|
122
122
|
*/
|
|
123
123
|
getPublicKey(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicKeyResponseClass>>;
|
|
124
124
|
/**
|
|
125
|
-
*
|
|
125
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
126
126
|
* @summary List public keys
|
|
127
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
128
128
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -135,7 +135,7 @@ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
|
135
135
|
*/
|
|
136
136
|
listPublicKeys(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicKeysResponseClass>>;
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
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
139
|
* @summary Create the public key
|
|
140
140
|
* @param {string} code
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -144,7 +144,7 @@ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
|
144
144
|
*/
|
|
145
145
|
rotatePublicKey(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RotatePublicKeyResponseClass>>;
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
147
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
148
148
|
* @summary Update the public key
|
|
149
149
|
* @param {string} code
|
|
150
150
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -160,7 +160,7 @@ export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
|
160
160
|
*/
|
|
161
161
|
export declare const PublicKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
164
164
|
* @summary Create the public key
|
|
165
165
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
166
166
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -169,7 +169,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
169
169
|
*/
|
|
170
170
|
createPublicKey(createPublicKeyRequestDto: CreatePublicKeyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePublicKeyResponseClass>;
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
172
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
173
173
|
* @summary Delete the public key
|
|
174
174
|
* @param {string} code Unique identifier for the object.
|
|
175
175
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -179,7 +179,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
179
179
|
*/
|
|
180
180
|
deletePublicKey(code: string, deletePublicKeyRequestDto: DeletePublicKeyRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
181
181
|
/**
|
|
182
|
-
*
|
|
182
|
+
* Retrieve a single public key by its code.
|
|
183
183
|
* @summary Retrieve the public key
|
|
184
184
|
* @param {string} code
|
|
185
185
|
* @param {string} expand
|
|
@@ -189,7 +189,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
189
189
|
*/
|
|
190
190
|
getPublicKey(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetPublicKeyResponseClass>;
|
|
191
191
|
/**
|
|
192
|
-
*
|
|
192
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
193
193
|
* @summary List public keys
|
|
194
194
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
195
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -202,7 +202,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
202
202
|
*/
|
|
203
203
|
listPublicKeys(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPublicKeysResponseClass>;
|
|
204
204
|
/**
|
|
205
|
-
*
|
|
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
206
|
* @summary Create the public key
|
|
207
207
|
* @param {string} code
|
|
208
208
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -211,7 +211,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
211
211
|
*/
|
|
212
212
|
rotatePublicKey(code: string, authorization?: string, options?: any): AxiosPromise<RotatePublicKeyResponseClass>;
|
|
213
213
|
/**
|
|
214
|
-
*
|
|
214
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
215
215
|
* @summary Update the public key
|
|
216
216
|
* @param {string} code
|
|
217
217
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -385,7 +385,7 @@ export interface PublicKeysApiUpdatePublicKeyRequest {
|
|
|
385
385
|
*/
|
|
386
386
|
export declare class PublicKeysApi extends BaseAPI {
|
|
387
387
|
/**
|
|
388
|
-
*
|
|
388
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
389
389
|
* @summary Create the public key
|
|
390
390
|
* @param {PublicKeysApiCreatePublicKeyRequest} requestParameters Request parameters.
|
|
391
391
|
* @param {*} [options] Override http request option.
|
|
@@ -394,7 +394,7 @@ export declare class PublicKeysApi extends BaseAPI {
|
|
|
394
394
|
*/
|
|
395
395
|
createPublicKey(requestParameters: PublicKeysApiCreatePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePublicKeyResponseClass, any, {}>>;
|
|
396
396
|
/**
|
|
397
|
-
*
|
|
397
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
398
398
|
* @summary Delete the public key
|
|
399
399
|
* @param {PublicKeysApiDeletePublicKeyRequest} requestParameters Request parameters.
|
|
400
400
|
* @param {*} [options] Override http request option.
|
|
@@ -403,7 +403,7 @@ export declare class PublicKeysApi extends BaseAPI {
|
|
|
403
403
|
*/
|
|
404
404
|
deletePublicKey(requestParameters: PublicKeysApiDeletePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
405
405
|
/**
|
|
406
|
-
*
|
|
406
|
+
* Retrieve a single public key by its code.
|
|
407
407
|
* @summary Retrieve the public key
|
|
408
408
|
* @param {PublicKeysApiGetPublicKeyRequest} requestParameters Request parameters.
|
|
409
409
|
* @param {*} [options] Override http request option.
|
|
@@ -412,7 +412,7 @@ export declare class PublicKeysApi extends BaseAPI {
|
|
|
412
412
|
*/
|
|
413
413
|
getPublicKey(requestParameters: PublicKeysApiGetPublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPublicKeyResponseClass, any, {}>>;
|
|
414
414
|
/**
|
|
415
|
-
*
|
|
415
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
416
416
|
* @summary List public keys
|
|
417
417
|
* @param {PublicKeysApiListPublicKeysRequest} requestParameters Request parameters.
|
|
418
418
|
* @param {*} [options] Override http request option.
|
|
@@ -421,7 +421,7 @@ export declare class PublicKeysApi extends BaseAPI {
|
|
|
421
421
|
*/
|
|
422
422
|
listPublicKeys(requestParameters?: PublicKeysApiListPublicKeysRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPublicKeysResponseClass, any, {}>>;
|
|
423
423
|
/**
|
|
424
|
-
*
|
|
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
425
|
* @summary Create the public key
|
|
426
426
|
* @param {PublicKeysApiRotatePublicKeyRequest} requestParameters Request parameters.
|
|
427
427
|
* @param {*} [options] Override http request option.
|
|
@@ -430,7 +430,7 @@ export declare class PublicKeysApi extends BaseAPI {
|
|
|
430
430
|
*/
|
|
431
431
|
rotatePublicKey(requestParameters: PublicKeysApiRotatePublicKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RotatePublicKeyResponseClass, any, {}>>;
|
|
432
432
|
/**
|
|
433
|
-
*
|
|
433
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
434
434
|
* @summary Update the public key
|
|
435
435
|
* @param {PublicKeysApiUpdatePublicKeyRequest} requestParameters Request parameters.
|
|
436
436
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
101
101
|
* @summary Create the public key
|
|
102
102
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -146,7 +146,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
150
150
|
* @summary Delete the public key
|
|
151
151
|
* @param {string} code Unique identifier for the object.
|
|
152
152
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -199,7 +199,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
199
199
|
});
|
|
200
200
|
},
|
|
201
201
|
/**
|
|
202
|
-
*
|
|
202
|
+
* Retrieve a single public key by its code.
|
|
203
203
|
* @summary Retrieve the public key
|
|
204
204
|
* @param {string} code
|
|
205
205
|
* @param {string} expand
|
|
@@ -253,7 +253,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
253
253
|
});
|
|
254
254
|
},
|
|
255
255
|
/**
|
|
256
|
-
*
|
|
256
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
257
257
|
* @summary List public keys
|
|
258
258
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
259
259
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -317,7 +317,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
317
317
|
});
|
|
318
318
|
},
|
|
319
319
|
/**
|
|
320
|
-
*
|
|
320
|
+
* 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.
|
|
321
321
|
* @summary Create the public key
|
|
322
322
|
* @param {string} code
|
|
323
323
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -365,7 +365,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
365
365
|
});
|
|
366
366
|
},
|
|
367
367
|
/**
|
|
368
|
-
*
|
|
368
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
369
369
|
* @summary Update the public key
|
|
370
370
|
* @param {string} code
|
|
371
371
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -428,7 +428,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
428
428
|
var localVarAxiosParamCreator = (0, exports.PublicKeysApiAxiosParamCreator)(configuration);
|
|
429
429
|
return {
|
|
430
430
|
/**
|
|
431
|
-
*
|
|
431
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
432
432
|
* @summary Create the public key
|
|
433
433
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
434
434
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -449,7 +449,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
449
449
|
});
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
452
|
-
*
|
|
452
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
453
453
|
* @summary Delete the public key
|
|
454
454
|
* @param {string} code Unique identifier for the object.
|
|
455
455
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -471,7 +471,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
471
471
|
});
|
|
472
472
|
},
|
|
473
473
|
/**
|
|
474
|
-
*
|
|
474
|
+
* Retrieve a single public key by its code.
|
|
475
475
|
* @summary Retrieve the public key
|
|
476
476
|
* @param {string} code
|
|
477
477
|
* @param {string} expand
|
|
@@ -493,7 +493,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
493
493
|
});
|
|
494
494
|
},
|
|
495
495
|
/**
|
|
496
|
-
*
|
|
496
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
497
497
|
* @summary List public keys
|
|
498
498
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
499
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -518,7 +518,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
518
518
|
});
|
|
519
519
|
},
|
|
520
520
|
/**
|
|
521
|
-
*
|
|
521
|
+
* 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.
|
|
522
522
|
* @summary Create the public key
|
|
523
523
|
* @param {string} code
|
|
524
524
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -539,7 +539,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
539
539
|
});
|
|
540
540
|
},
|
|
541
541
|
/**
|
|
542
|
-
*
|
|
542
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
543
543
|
* @summary Update the public key
|
|
544
544
|
* @param {string} code
|
|
545
545
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -571,7 +571,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
571
571
|
var localVarFp = (0, exports.PublicKeysApiFp)(configuration);
|
|
572
572
|
return {
|
|
573
573
|
/**
|
|
574
|
-
*
|
|
574
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
575
575
|
* @summary Create the public key
|
|
576
576
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
577
577
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -582,7 +582,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
582
582
|
return localVarFp.createPublicKey(createPublicKeyRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
583
583
|
},
|
|
584
584
|
/**
|
|
585
|
-
*
|
|
585
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
586
586
|
* @summary Delete the public key
|
|
587
587
|
* @param {string} code Unique identifier for the object.
|
|
588
588
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -594,7 +594,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
594
594
|
return localVarFp.deletePublicKey(code, deletePublicKeyRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
595
595
|
},
|
|
596
596
|
/**
|
|
597
|
-
*
|
|
597
|
+
* Retrieve a single public key by its code.
|
|
598
598
|
* @summary Retrieve the public key
|
|
599
599
|
* @param {string} code
|
|
600
600
|
* @param {string} expand
|
|
@@ -606,7 +606,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
606
606
|
return localVarFp.getPublicKey(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
607
607
|
},
|
|
608
608
|
/**
|
|
609
|
-
*
|
|
609
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
610
610
|
* @summary List public keys
|
|
611
611
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
612
612
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, key, createdAt, updatedAt, deletedAt</i>
|
|
@@ -621,7 +621,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
621
621
|
return localVarFp.listPublicKeys(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
622
622
|
},
|
|
623
623
|
/**
|
|
624
|
-
*
|
|
624
|
+
* 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.
|
|
625
625
|
* @summary Create the public key
|
|
626
626
|
* @param {string} code
|
|
627
627
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -632,7 +632,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
632
632
|
return localVarFp.rotatePublicKey(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
633
633
|
},
|
|
634
634
|
/**
|
|
635
|
-
*
|
|
635
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
636
636
|
* @summary Update the public key
|
|
637
637
|
* @param {string} code
|
|
638
638
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -658,7 +658,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
658
658
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
659
659
|
}
|
|
660
660
|
/**
|
|
661
|
-
*
|
|
661
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
662
662
|
* @summary Create the public key
|
|
663
663
|
* @param {PublicKeysApiCreatePublicKeyRequest} requestParameters Request parameters.
|
|
664
664
|
* @param {*} [options] Override http request option.
|
|
@@ -670,7 +670,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
670
670
|
return (0, exports.PublicKeysApiFp)(this.configuration).createPublicKey(requestParameters.createPublicKeyRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
671
671
|
};
|
|
672
672
|
/**
|
|
673
|
-
*
|
|
673
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
674
674
|
* @summary Delete the public key
|
|
675
675
|
* @param {PublicKeysApiDeletePublicKeyRequest} requestParameters Request parameters.
|
|
676
676
|
* @param {*} [options] Override http request option.
|
|
@@ -682,7 +682,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
682
682
|
return (0, exports.PublicKeysApiFp)(this.configuration).deletePublicKey(requestParameters.code, requestParameters.deletePublicKeyRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
683
683
|
};
|
|
684
684
|
/**
|
|
685
|
-
*
|
|
685
|
+
* Retrieve a single public key by its code.
|
|
686
686
|
* @summary Retrieve the public key
|
|
687
687
|
* @param {PublicKeysApiGetPublicKeyRequest} requestParameters Request parameters.
|
|
688
688
|
* @param {*} [options] Override http request option.
|
|
@@ -694,7 +694,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
694
694
|
return (0, exports.PublicKeysApiFp)(this.configuration).getPublicKey(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
695
695
|
};
|
|
696
696
|
/**
|
|
697
|
-
*
|
|
697
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
698
698
|
* @summary List public keys
|
|
699
699
|
* @param {PublicKeysApiListPublicKeysRequest} requestParameters Request parameters.
|
|
700
700
|
* @param {*} [options] Override http request option.
|
|
@@ -707,7 +707,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
707
707
|
return (0, exports.PublicKeysApiFp)(this.configuration).listPublicKeys(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
708
708
|
};
|
|
709
709
|
/**
|
|
710
|
-
*
|
|
710
|
+
* 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.
|
|
711
711
|
* @summary Create the public key
|
|
712
712
|
* @param {PublicKeysApiRotatePublicKeyRequest} requestParameters Request parameters.
|
|
713
713
|
* @param {*} [options] Override http request option.
|
|
@@ -719,7 +719,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
719
719
|
return (0, exports.PublicKeysApiFp)(this.configuration).rotatePublicKey(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
720
720
|
};
|
|
721
721
|
/**
|
|
722
|
-
*
|
|
722
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
723
723
|
* @summary Update the public key
|
|
724
724
|
* @param {PublicKeysApiUpdatePublicKeyRequest} requestParameters Request parameters.
|
|
725
725
|
* @param {*} [options] Override http request option.
|
|
@@ -22,19 +22,19 @@ export interface PublicKeyClass {
|
|
|
22
22
|
*/
|
|
23
23
|
'id': number;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Stable code used to reference this public key in API calls
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof PublicKeyClass
|
|
28
28
|
*/
|
|
29
29
|
'code': string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Human-readable slug used to identify the key uniquely
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof PublicKeyClass
|
|
34
34
|
*/
|
|
35
35
|
'slug': string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Public key value. Use this for public API authentication.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof PublicKeyClass
|
|
40
40
|
*/
|
|
@@ -16,13 +16,13 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface UpdatePublicKeyRequestDto {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Public key code (identifies the key to update)
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof UpdatePublicKeyRequestDto
|
|
22
22
|
*/
|
|
23
23
|
'code': string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* New slug for the public key (unique identifier used for lookup)
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof UpdatePublicKeyRequestDto
|
|
28
28
|
*/
|
|
@@ -27,19 +27,19 @@ export interface PublicKeyClass {
|
|
|
27
27
|
*/
|
|
28
28
|
'id': number;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Stable code used to reference this public key in API calls
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof PublicKeyClass
|
|
33
33
|
*/
|
|
34
34
|
'code': string;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* Human-readable slug used to identify the key uniquely
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof PublicKeyClass
|
|
39
39
|
*/
|
|
40
40
|
'slug': string;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Public key value. Use this for public API authentication.
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof PublicKeyClass
|
|
45
45
|
*/
|
|
@@ -21,13 +21,13 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface UpdatePublicKeyRequestDto {
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Public key code (identifies the key to update)
|
|
25
25
|
* @type {string}
|
|
26
26
|
* @memberof UpdatePublicKeyRequestDto
|
|
27
27
|
*/
|
|
28
28
|
'code': string;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* New slug for the public key (unique identifier used for lookup)
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof UpdatePublicKeyRequestDto
|
|
33
33
|
*/
|