@emilgroup/setting-sdk 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@0.
|
|
20
|
+
npm install @emilgroup/setting-sdk@0.2.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/setting-sdk@0.
|
|
24
|
+
yarn add @emilgroup/setting-sdk@0.2.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
package/api/public-keys-api.ts
CHANGED
|
@@ -43,7 +43,7 @@ import { UpdatePublicKeyResponseClass } from '../models';
|
|
|
43
43
|
export const PublicKeysApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
*
|
|
46
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
47
47
|
* @summary Create the public key
|
|
48
48
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +90,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
94
94
|
* @summary Delete the public key
|
|
95
95
|
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -141,7 +141,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* Retrieve a single public key by its code.
|
|
145
145
|
* @summary Retrieve the public key
|
|
146
146
|
* @param {string} code
|
|
147
147
|
* @param {string} expand
|
|
@@ -193,7 +193,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
193
193
|
};
|
|
194
194
|
},
|
|
195
195
|
/**
|
|
196
|
-
*
|
|
196
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
197
197
|
* @summary List public keys
|
|
198
198
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
199
199
|
* @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>
|
|
@@ -259,7 +259,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
259
259
|
};
|
|
260
260
|
},
|
|
261
261
|
/**
|
|
262
|
-
*
|
|
262
|
+
* 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.
|
|
263
263
|
* @summary Create the public key
|
|
264
264
|
* @param {string} code
|
|
265
265
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -304,7 +304,7 @@ export const PublicKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
304
304
|
};
|
|
305
305
|
},
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
307
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
308
308
|
* @summary Update the public key
|
|
309
309
|
* @param {string} code
|
|
310
310
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -365,7 +365,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
365
365
|
const localVarAxiosParamCreator = PublicKeysApiAxiosParamCreator(configuration)
|
|
366
366
|
return {
|
|
367
367
|
/**
|
|
368
|
-
*
|
|
368
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
369
369
|
* @summary Create the public key
|
|
370
370
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
371
371
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -377,7 +377,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
377
377
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
378
378
|
},
|
|
379
379
|
/**
|
|
380
|
-
*
|
|
380
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
381
381
|
* @summary Delete the public key
|
|
382
382
|
* @param {string} code Unique identifier for the object.
|
|
383
383
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -390,7 +390,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
390
390
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
391
391
|
},
|
|
392
392
|
/**
|
|
393
|
-
*
|
|
393
|
+
* Retrieve a single public key by its code.
|
|
394
394
|
* @summary Retrieve the public key
|
|
395
395
|
* @param {string} code
|
|
396
396
|
* @param {string} expand
|
|
@@ -403,7 +403,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
403
403
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
404
404
|
},
|
|
405
405
|
/**
|
|
406
|
-
*
|
|
406
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
407
407
|
* @summary List public keys
|
|
408
408
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
409
409
|
* @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>
|
|
@@ -419,7 +419,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
419
419
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
420
420
|
},
|
|
421
421
|
/**
|
|
422
|
-
*
|
|
422
|
+
* 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.
|
|
423
423
|
* @summary Create the public key
|
|
424
424
|
* @param {string} code
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -431,7 +431,7 @@ export const PublicKeysApiFp = function(configuration?: Configuration) {
|
|
|
431
431
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
432
432
|
},
|
|
433
433
|
/**
|
|
434
|
-
*
|
|
434
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
435
435
|
* @summary Update the public key
|
|
436
436
|
* @param {string} code
|
|
437
437
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -454,7 +454,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
454
454
|
const localVarFp = PublicKeysApiFp(configuration)
|
|
455
455
|
return {
|
|
456
456
|
/**
|
|
457
|
-
*
|
|
457
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
458
458
|
* @summary Create the public key
|
|
459
459
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
460
460
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -465,7 +465,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
465
465
|
return localVarFp.createPublicKey(createPublicKeyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
466
466
|
},
|
|
467
467
|
/**
|
|
468
|
-
*
|
|
468
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
469
469
|
* @summary Delete the public key
|
|
470
470
|
* @param {string} code Unique identifier for the object.
|
|
471
471
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -477,7 +477,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
477
477
|
return localVarFp.deletePublicKey(code, deletePublicKeyRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
478
478
|
},
|
|
479
479
|
/**
|
|
480
|
-
*
|
|
480
|
+
* Retrieve a single public key by its code.
|
|
481
481
|
* @summary Retrieve the public key
|
|
482
482
|
* @param {string} code
|
|
483
483
|
* @param {string} expand
|
|
@@ -489,7 +489,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
489
489
|
return localVarFp.getPublicKey(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
490
490
|
},
|
|
491
491
|
/**
|
|
492
|
-
*
|
|
492
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
493
493
|
* @summary List public keys
|
|
494
494
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
495
495
|
* @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>
|
|
@@ -504,7 +504,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
504
504
|
return localVarFp.listPublicKeys(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
|
|
505
505
|
},
|
|
506
506
|
/**
|
|
507
|
-
*
|
|
507
|
+
* 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.
|
|
508
508
|
* @summary Create the public key
|
|
509
509
|
* @param {string} code
|
|
510
510
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -515,7 +515,7 @@ export const PublicKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
515
515
|
return localVarFp.rotatePublicKey(code, authorization, options).then((request) => request(axios, basePath));
|
|
516
516
|
},
|
|
517
517
|
/**
|
|
518
|
-
*
|
|
518
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
519
519
|
* @summary Update the public key
|
|
520
520
|
* @param {string} code
|
|
521
521
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -712,7 +712,7 @@ export interface PublicKeysApiUpdatePublicKeyRequest {
|
|
|
712
712
|
*/
|
|
713
713
|
export class PublicKeysApi extends BaseAPI {
|
|
714
714
|
/**
|
|
715
|
-
*
|
|
715
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
716
716
|
* @summary Create the public key
|
|
717
717
|
* @param {PublicKeysApiCreatePublicKeyRequest} requestParameters Request parameters.
|
|
718
718
|
* @param {*} [options] Override http request option.
|
|
@@ -724,7 +724,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
724
724
|
}
|
|
725
725
|
|
|
726
726
|
/**
|
|
727
|
-
*
|
|
727
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
728
728
|
* @summary Delete the public key
|
|
729
729
|
* @param {PublicKeysApiDeletePublicKeyRequest} requestParameters Request parameters.
|
|
730
730
|
* @param {*} [options] Override http request option.
|
|
@@ -736,7 +736,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
736
736
|
}
|
|
737
737
|
|
|
738
738
|
/**
|
|
739
|
-
*
|
|
739
|
+
* Retrieve a single public key by its code.
|
|
740
740
|
* @summary Retrieve the public key
|
|
741
741
|
* @param {PublicKeysApiGetPublicKeyRequest} requestParameters Request parameters.
|
|
742
742
|
* @param {*} [options] Override http request option.
|
|
@@ -748,7 +748,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
748
748
|
}
|
|
749
749
|
|
|
750
750
|
/**
|
|
751
|
-
*
|
|
751
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
752
752
|
* @summary List public keys
|
|
753
753
|
* @param {PublicKeysApiListPublicKeysRequest} requestParameters Request parameters.
|
|
754
754
|
* @param {*} [options] Override http request option.
|
|
@@ -760,7 +760,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
760
760
|
}
|
|
761
761
|
|
|
762
762
|
/**
|
|
763
|
-
*
|
|
763
|
+
* 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.
|
|
764
764
|
* @summary Create the public key
|
|
765
765
|
* @param {PublicKeysApiRotatePublicKeyRequest} requestParameters Request parameters.
|
|
766
766
|
* @param {*} [options] Override http request option.
|
|
@@ -772,7 +772,7 @@ export class PublicKeysApi extends BaseAPI {
|
|
|
772
772
|
}
|
|
773
773
|
|
|
774
774
|
/**
|
|
775
|
-
*
|
|
775
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
776
776
|
* @summary Update the public key
|
|
777
777
|
* @param {PublicKeysApiUpdatePublicKeyRequest} requestParameters Request parameters.
|
|
778
778
|
* @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.
|
|
@@ -93,7 +93,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
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.
|
|
@@ -142,7 +142,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
145
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
146
146
|
* @summary Delete the public key
|
|
147
147
|
* @param {string} code Unique identifier for the object.
|
|
148
148
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -195,7 +195,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
195
195
|
});
|
|
196
196
|
},
|
|
197
197
|
/**
|
|
198
|
-
*
|
|
198
|
+
* Retrieve a single public key by its code.
|
|
199
199
|
* @summary Retrieve the public key
|
|
200
200
|
* @param {string} code
|
|
201
201
|
* @param {string} expand
|
|
@@ -249,7 +249,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
});
|
|
250
250
|
},
|
|
251
251
|
/**
|
|
252
|
-
*
|
|
252
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
253
253
|
* @summary List public keys
|
|
254
254
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
255
|
* @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>
|
|
@@ -313,7 +313,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
313
313
|
});
|
|
314
314
|
},
|
|
315
315
|
/**
|
|
316
|
-
*
|
|
316
|
+
* 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.
|
|
317
317
|
* @summary Create the public key
|
|
318
318
|
* @param {string} code
|
|
319
319
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -361,7 +361,7 @@ var PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
|
361
361
|
});
|
|
362
362
|
},
|
|
363
363
|
/**
|
|
364
|
-
*
|
|
364
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
365
365
|
* @summary Update the public key
|
|
366
366
|
* @param {string} code
|
|
367
367
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -424,7 +424,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
424
424
|
var localVarAxiosParamCreator = (0, exports.PublicKeysApiAxiosParamCreator)(configuration);
|
|
425
425
|
return {
|
|
426
426
|
/**
|
|
427
|
-
*
|
|
427
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
428
428
|
* @summary Create the public key
|
|
429
429
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
430
430
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -445,7 +445,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
445
445
|
});
|
|
446
446
|
},
|
|
447
447
|
/**
|
|
448
|
-
*
|
|
448
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
449
449
|
* @summary Delete the public key
|
|
450
450
|
* @param {string} code Unique identifier for the object.
|
|
451
451
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -467,7 +467,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
467
467
|
});
|
|
468
468
|
},
|
|
469
469
|
/**
|
|
470
|
-
*
|
|
470
|
+
* Retrieve a single public key by its code.
|
|
471
471
|
* @summary Retrieve the public key
|
|
472
472
|
* @param {string} code
|
|
473
473
|
* @param {string} expand
|
|
@@ -489,7 +489,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
489
489
|
});
|
|
490
490
|
},
|
|
491
491
|
/**
|
|
492
|
-
*
|
|
492
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
493
493
|
* @summary List public keys
|
|
494
494
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
495
495
|
* @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>
|
|
@@ -514,7 +514,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
514
514
|
});
|
|
515
515
|
},
|
|
516
516
|
/**
|
|
517
|
-
*
|
|
517
|
+
* 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.
|
|
518
518
|
* @summary Create the public key
|
|
519
519
|
* @param {string} code
|
|
520
520
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -535,7 +535,7 @@ var PublicKeysApiFp = function (configuration) {
|
|
|
535
535
|
});
|
|
536
536
|
},
|
|
537
537
|
/**
|
|
538
|
-
*
|
|
538
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
539
539
|
* @summary Update the public key
|
|
540
540
|
* @param {string} code
|
|
541
541
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -567,7 +567,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
567
567
|
var localVarFp = (0, exports.PublicKeysApiFp)(configuration);
|
|
568
568
|
return {
|
|
569
569
|
/**
|
|
570
|
-
*
|
|
570
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
571
571
|
* @summary Create the public key
|
|
572
572
|
* @param {CreatePublicKeyRequestDto} createPublicKeyRequestDto
|
|
573
573
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -578,7 +578,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
578
578
|
return localVarFp.createPublicKey(createPublicKeyRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
579
579
|
},
|
|
580
580
|
/**
|
|
581
|
-
*
|
|
581
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
582
582
|
* @summary Delete the public key
|
|
583
583
|
* @param {string} code Unique identifier for the object.
|
|
584
584
|
* @param {DeletePublicKeyRequestDto} deletePublicKeyRequestDto
|
|
@@ -590,7 +590,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
590
590
|
return localVarFp.deletePublicKey(code, deletePublicKeyRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
591
591
|
},
|
|
592
592
|
/**
|
|
593
|
-
*
|
|
593
|
+
* Retrieve a single public key by its code.
|
|
594
594
|
* @summary Retrieve the public key
|
|
595
595
|
* @param {string} code
|
|
596
596
|
* @param {string} expand
|
|
@@ -602,7 +602,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
602
602
|
return localVarFp.getPublicKey(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
603
603
|
},
|
|
604
604
|
/**
|
|
605
|
-
*
|
|
605
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
606
606
|
* @summary List public keys
|
|
607
607
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
608
608
|
* @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>
|
|
@@ -617,7 +617,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
617
617
|
return localVarFp.listPublicKeys(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
618
618
|
},
|
|
619
619
|
/**
|
|
620
|
-
*
|
|
620
|
+
* 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.
|
|
621
621
|
* @summary Create the public key
|
|
622
622
|
* @param {string} code
|
|
623
623
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -628,7 +628,7 @@ var PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
|
628
628
|
return localVarFp.rotatePublicKey(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
629
629
|
},
|
|
630
630
|
/**
|
|
631
|
-
*
|
|
631
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
632
632
|
* @summary Update the public key
|
|
633
633
|
* @param {string} code
|
|
634
634
|
* @param {UpdatePublicKeyRequestDto} updatePublicKeyRequestDto
|
|
@@ -654,7 +654,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
654
654
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
655
655
|
}
|
|
656
656
|
/**
|
|
657
|
-
*
|
|
657
|
+
* Create a new public key. Use the returned key for public API authentication. We recommend rotating keys every three months.
|
|
658
658
|
* @summary Create the public key
|
|
659
659
|
* @param {PublicKeysApiCreatePublicKeyRequest} requestParameters Request parameters.
|
|
660
660
|
* @param {*} [options] Override http request option.
|
|
@@ -666,7 +666,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
666
666
|
return (0, exports.PublicKeysApiFp)(this.configuration).createPublicKey(requestParameters.createPublicKeyRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
667
667
|
};
|
|
668
668
|
/**
|
|
669
|
-
*
|
|
669
|
+
* Delete a public key by code. Ensure no integrations or services depend on this key before deleting.
|
|
670
670
|
* @summary Delete the public key
|
|
671
671
|
* @param {PublicKeysApiDeletePublicKeyRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
|
@@ -678,7 +678,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
678
678
|
return (0, exports.PublicKeysApiFp)(this.configuration).deletePublicKey(requestParameters.code, requestParameters.deletePublicKeyRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
679
679
|
};
|
|
680
680
|
/**
|
|
681
|
-
*
|
|
681
|
+
* Retrieve a single public key by its code.
|
|
682
682
|
* @summary Retrieve the public key
|
|
683
683
|
* @param {PublicKeysApiGetPublicKeyRequest} requestParameters Request parameters.
|
|
684
684
|
* @param {*} [options] Override http request option.
|
|
@@ -690,7 +690,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
690
690
|
return (0, exports.PublicKeysApiFp)(this.configuration).getPublicKey(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
691
691
|
};
|
|
692
692
|
/**
|
|
693
|
-
*
|
|
693
|
+
* List public keys with optional filters, sorting, and pagination. Use filters to find keys by slug, code, or other attributes.
|
|
694
694
|
* @summary List public keys
|
|
695
695
|
* @param {PublicKeysApiListPublicKeysRequest} requestParameters Request parameters.
|
|
696
696
|
* @param {*} [options] Override http request option.
|
|
@@ -703,7 +703,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
703
703
|
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); });
|
|
704
704
|
};
|
|
705
705
|
/**
|
|
706
|
-
*
|
|
706
|
+
* 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.
|
|
707
707
|
* @summary Create the public key
|
|
708
708
|
* @param {PublicKeysApiRotatePublicKeyRequest} requestParameters Request parameters.
|
|
709
709
|
* @param {*} [options] Override http request option.
|
|
@@ -715,7 +715,7 @@ var PublicKeysApi = /** @class */ (function (_super) {
|
|
|
715
715
|
return (0, exports.PublicKeysApiFp)(this.configuration).rotatePublicKey(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
716
716
|
};
|
|
717
717
|
/**
|
|
718
|
-
*
|
|
718
|
+
* Update a public key\'s metadata (e.g. slug). Does not change the key material; use rotate to replace the key.
|
|
719
719
|
* @summary Update the public key
|
|
720
720
|
* @param {PublicKeysApiUpdatePublicKeyRequest} requestParameters Request parameters.
|
|
721
721
|
* @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
|
*/
|