@emilgroup/setting-sdk-node 0.3.1-beta.22 → 0.3.1-beta.23
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/.openapi-generator/FILES +1 -1
- package/README.md +2 -2
- package/api/setting-definitions-api.ts +116 -0
- package/api/setting-keys-api.ts +3 -3
- package/dist/api/setting-definitions-api.d.ts +65 -0
- package/dist/api/setting-definitions-api.js +98 -0
- package/dist/api/setting-keys-api.d.ts +4 -4
- package/dist/models/{delete-setting-key-response-class.d.ts → delete-by-code-response-class.d.ts} +4 -4
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/models/{delete-setting-key-response-class.ts → delete-by-code-response-class.ts} +4 -4
- package/models/index.ts +1 -1
- package/package.json +1 -1
- /package/dist/models/{delete-setting-key-response-class.js → delete-by-code-response-class.js} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -19,8 +19,8 @@ models/create-setting-definition-request-dto.ts
|
|
|
19
19
|
models/create-setting-definition-response-class.ts
|
|
20
20
|
models/create-setting-key-request-dto.ts
|
|
21
21
|
models/create-setting-key-response-class.ts
|
|
22
|
+
models/delete-by-code-response-class.ts
|
|
22
23
|
models/delete-public-key-request-dto.ts
|
|
23
|
-
models/delete-setting-key-response-class.ts
|
|
24
24
|
models/get-public-key-response-class.ts
|
|
25
25
|
models/get-setting-definition-response-class.ts
|
|
26
26
|
models/get-setting-key-response-class.ts
|
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.3.1-beta.
|
|
20
|
+
npm install @emilgroup/setting-sdk-node@0.3.1-beta.23 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/setting-sdk-node@0.3.1-beta.
|
|
24
|
+
yarn add @emilgroup/setting-sdk-node@0.3.1-beta.23
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -25,6 +25,8 @@ import { CreateSettingDefinitionRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateSettingDefinitionResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
+
import { DeleteByCodeResponseClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
28
30
|
import { GetSettingDefinitionResponseClass } from '../models';
|
|
29
31
|
// @ts-ignore
|
|
30
32
|
import { ListSettingDefinitionsResponseClass } from '../models';
|
|
@@ -85,6 +87,55 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
|
|
|
85
87
|
options: localVarRequestOptions,
|
|
86
88
|
};
|
|
87
89
|
},
|
|
90
|
+
/**
|
|
91
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
92
|
+
* @summary Delete the setting definition
|
|
93
|
+
* @param {string} code
|
|
94
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
95
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
deleteSettingDefinition: async (code: string, settingDefinition: any, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
100
|
+
// verify required parameter 'code' is not null or undefined
|
|
101
|
+
assertParamExists('deleteSettingDefinition', 'code', code)
|
|
102
|
+
// verify required parameter 'settingDefinition' is not null or undefined
|
|
103
|
+
assertParamExists('deleteSettingDefinition', 'settingDefinition', settingDefinition)
|
|
104
|
+
const localVarPath = `/settingservice/v1/settings/definitions/{code}`
|
|
105
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
106
|
+
.replace(`{${"setting definition"}}`, encodeURIComponent(String(settingDefinition)));
|
|
107
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
108
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
109
|
+
let baseOptions;
|
|
110
|
+
let baseAccessToken;
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
baseAccessToken = configuration.accessToken;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
117
|
+
const localVarHeaderParameter = {} as any;
|
|
118
|
+
const localVarQueryParameter = {} as any;
|
|
119
|
+
|
|
120
|
+
// authentication bearer required
|
|
121
|
+
// http bearer authentication required
|
|
122
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
123
|
+
|
|
124
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
125
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
132
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
133
|
+
|
|
134
|
+
return {
|
|
135
|
+
url: toPathString(localVarUrlObj),
|
|
136
|
+
options: localVarRequestOptions,
|
|
137
|
+
};
|
|
138
|
+
},
|
|
88
139
|
/**
|
|
89
140
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
90
141
|
* @summary Retrieve the setting definition
|
|
@@ -228,6 +279,19 @@ export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
|
|
|
228
279
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options);
|
|
229
280
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
230
281
|
},
|
|
282
|
+
/**
|
|
283
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
284
|
+
* @summary Delete the setting definition
|
|
285
|
+
* @param {string} code
|
|
286
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
287
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
288
|
+
* @param {*} [options] Override http request option.
|
|
289
|
+
* @throws {RequiredError}
|
|
290
|
+
*/
|
|
291
|
+
async deleteSettingDefinition(code: string, settingDefinition: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
292
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingDefinition(code, settingDefinition, authorization, options);
|
|
293
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
294
|
+
},
|
|
231
295
|
/**
|
|
232
296
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
233
297
|
* @summary Retrieve the setting definition
|
|
@@ -279,6 +343,18 @@ export const SettingDefinitionsApiFactory = function (configuration?: Configurat
|
|
|
279
343
|
createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingDefinitionResponseClass> {
|
|
280
344
|
return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
281
345
|
},
|
|
346
|
+
/**
|
|
347
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
348
|
+
* @summary Delete the setting definition
|
|
349
|
+
* @param {string} code
|
|
350
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
351
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
deleteSettingDefinition(code: string, settingDefinition: any, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
356
|
+
return localVarFp.deleteSettingDefinition(code, settingDefinition, authorization, options).then((request) => request(axios, basePath));
|
|
357
|
+
},
|
|
282
358
|
/**
|
|
283
359
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
284
360
|
* @summary Retrieve the setting definition
|
|
@@ -331,6 +407,34 @@ export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
|
|
|
331
407
|
readonly authorization?: string
|
|
332
408
|
}
|
|
333
409
|
|
|
410
|
+
/**
|
|
411
|
+
* Request parameters for deleteSettingDefinition operation in SettingDefinitionsApi.
|
|
412
|
+
* @export
|
|
413
|
+
* @interface SettingDefinitionsApiDeleteSettingDefinitionRequest
|
|
414
|
+
*/
|
|
415
|
+
export interface SettingDefinitionsApiDeleteSettingDefinitionRequest {
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @type {string}
|
|
419
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
420
|
+
*/
|
|
421
|
+
readonly code: string
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Unique identifier for the object.
|
|
425
|
+
* @type {any}
|
|
426
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
427
|
+
*/
|
|
428
|
+
readonly settingDefinition: any
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
+
* @type {string}
|
|
433
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
434
|
+
*/
|
|
435
|
+
readonly authorization?: string
|
|
436
|
+
}
|
|
437
|
+
|
|
334
438
|
/**
|
|
335
439
|
* Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
|
|
336
440
|
* @export
|
|
@@ -434,6 +538,18 @@ export class SettingDefinitionsApi extends BaseAPI {
|
|
|
434
538
|
return SettingDefinitionsApiFp(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
435
539
|
}
|
|
436
540
|
|
|
541
|
+
/**
|
|
542
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
543
|
+
* @summary Delete the setting definition
|
|
544
|
+
* @param {SettingDefinitionsApiDeleteSettingDefinitionRequest} requestParameters Request parameters.
|
|
545
|
+
* @param {*} [options] Override http request option.
|
|
546
|
+
* @throws {RequiredError}
|
|
547
|
+
* @memberof SettingDefinitionsApi
|
|
548
|
+
*/
|
|
549
|
+
public deleteSettingDefinition(requestParameters: SettingDefinitionsApiDeleteSettingDefinitionRequest, options?: AxiosRequestConfig) {
|
|
550
|
+
return SettingDefinitionsApiFp(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.settingDefinition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
551
|
+
}
|
|
552
|
+
|
|
437
553
|
/**
|
|
438
554
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
439
555
|
* @summary Retrieve the setting definition
|
package/api/setting-keys-api.ts
CHANGED
|
@@ -25,7 +25,7 @@ import { CreateSettingKeyRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateSettingKeyResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import {
|
|
28
|
+
import { DeleteByCodeResponseClass } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import { GetSettingKeyResponseClass } from '../models';
|
|
31
31
|
// @ts-ignore
|
|
@@ -416,7 +416,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
416
416
|
* @param {*} [options] Override http request option.
|
|
417
417
|
* @throws {RequiredError}
|
|
418
418
|
*/
|
|
419
|
-
async deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
419
|
+
async deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
420
420
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code, ifMatch, authorization, options);
|
|
421
421
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
422
422
|
},
|
|
@@ -509,7 +509,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
511
511
|
*/
|
|
512
|
-
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<
|
|
512
|
+
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
513
513
|
return localVarFp.deleteSettingKey(code, ifMatch, authorization, options).then((request) => request(axios, basePath));
|
|
514
514
|
},
|
|
515
515
|
/**
|
|
@@ -14,6 +14,7 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateSettingDefinitionRequestDto } from '../models';
|
|
16
16
|
import { CreateSettingDefinitionResponseClass } from '../models';
|
|
17
|
+
import { DeleteByCodeResponseClass } from '../models';
|
|
17
18
|
import { GetSettingDefinitionResponseClass } from '../models';
|
|
18
19
|
import { ListSettingDefinitionsResponseClass } from '../models';
|
|
19
20
|
/**
|
|
@@ -30,6 +31,16 @@ export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Co
|
|
|
30
31
|
* @throws {RequiredError}
|
|
31
32
|
*/
|
|
32
33
|
createSettingDefinition: (createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
+
/**
|
|
35
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
36
|
+
* @summary Delete the setting definition
|
|
37
|
+
* @param {string} code
|
|
38
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
39
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
deleteSettingDefinition: (code: string, settingDefinition: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
44
|
/**
|
|
34
45
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
35
46
|
* @summary Retrieve the setting definition
|
|
@@ -69,6 +80,16 @@ export declare const SettingDefinitionsApiFp: (configuration?: Configuration) =>
|
|
|
69
80
|
* @throws {RequiredError}
|
|
70
81
|
*/
|
|
71
82
|
createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettingDefinitionResponseClass>>;
|
|
83
|
+
/**
|
|
84
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
85
|
+
* @summary Delete the setting definition
|
|
86
|
+
* @param {string} code
|
|
87
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
88
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
deleteSettingDefinition(code: string, settingDefinition: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
|
|
72
93
|
/**
|
|
73
94
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
74
95
|
* @summary Retrieve the setting definition
|
|
@@ -108,6 +129,16 @@ export declare const SettingDefinitionsApiFactory: (configuration?: Configuratio
|
|
|
108
129
|
* @throws {RequiredError}
|
|
109
130
|
*/
|
|
110
131
|
createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingDefinitionResponseClass>;
|
|
132
|
+
/**
|
|
133
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
134
|
+
* @summary Delete the setting definition
|
|
135
|
+
* @param {string} code
|
|
136
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
137
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
deleteSettingDefinition(code: string, settingDefinition: any, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
|
|
111
142
|
/**
|
|
112
143
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
113
144
|
* @summary Retrieve the setting definition
|
|
@@ -152,6 +183,31 @@ export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
|
|
|
152
183
|
*/
|
|
153
184
|
readonly authorization?: string;
|
|
154
185
|
}
|
|
186
|
+
/**
|
|
187
|
+
* Request parameters for deleteSettingDefinition operation in SettingDefinitionsApi.
|
|
188
|
+
* @export
|
|
189
|
+
* @interface SettingDefinitionsApiDeleteSettingDefinitionRequest
|
|
190
|
+
*/
|
|
191
|
+
export interface SettingDefinitionsApiDeleteSettingDefinitionRequest {
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {string}
|
|
195
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
196
|
+
*/
|
|
197
|
+
readonly code: string;
|
|
198
|
+
/**
|
|
199
|
+
* Unique identifier for the object.
|
|
200
|
+
* @type {any}
|
|
201
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
202
|
+
*/
|
|
203
|
+
readonly settingDefinition: any;
|
|
204
|
+
/**
|
|
205
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
206
|
+
* @type {string}
|
|
207
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
208
|
+
*/
|
|
209
|
+
readonly authorization?: string;
|
|
210
|
+
}
|
|
155
211
|
/**
|
|
156
212
|
* Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
|
|
157
213
|
* @export
|
|
@@ -242,6 +298,15 @@ export declare class SettingDefinitionsApi extends BaseAPI {
|
|
|
242
298
|
* @memberof SettingDefinitionsApi
|
|
243
299
|
*/
|
|
244
300
|
createSettingDefinition(requestParameters: SettingDefinitionsApiCreateSettingDefinitionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSettingDefinitionResponseClass, any, {}>>;
|
|
301
|
+
/**
|
|
302
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
303
|
+
* @summary Delete the setting definition
|
|
304
|
+
* @param {SettingDefinitionsApiDeleteSettingDefinitionRequest} requestParameters Request parameters.
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
* @memberof SettingDefinitionsApi
|
|
308
|
+
*/
|
|
309
|
+
deleteSettingDefinition(requestParameters: SettingDefinitionsApiDeleteSettingDefinitionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
|
|
245
310
|
/**
|
|
246
311
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
247
312
|
* @summary Retrieve the setting definition
|
|
@@ -145,6 +145,58 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
});
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
|
+
/**
|
|
149
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
150
|
+
* @summary Delete the setting definition
|
|
151
|
+
* @param {string} code
|
|
152
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
153
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
|
|
158
|
+
if (options === void 0) { options = {}; }
|
|
159
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
160
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
161
|
+
return __generator(this, function (_a) {
|
|
162
|
+
switch (_a.label) {
|
|
163
|
+
case 0:
|
|
164
|
+
// verify required parameter 'code' is not null or undefined
|
|
165
|
+
(0, common_1.assertParamExists)('deleteSettingDefinition', 'code', code);
|
|
166
|
+
// verify required parameter 'settingDefinition' is not null or undefined
|
|
167
|
+
(0, common_1.assertParamExists)('deleteSettingDefinition', 'settingDefinition', settingDefinition);
|
|
168
|
+
localVarPath = "/settingservice/v1/settings/definitions/{code}"
|
|
169
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)))
|
|
170
|
+
.replace("{".concat("setting definition", "}"), encodeURIComponent(String(settingDefinition)));
|
|
171
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
172
|
+
if (configuration) {
|
|
173
|
+
baseOptions = configuration.baseOptions;
|
|
174
|
+
baseAccessToken = configuration.accessToken;
|
|
175
|
+
}
|
|
176
|
+
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
177
|
+
localVarHeaderParameter = {};
|
|
178
|
+
localVarQueryParameter = {};
|
|
179
|
+
// authentication bearer required
|
|
180
|
+
// http bearer authentication required
|
|
181
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
182
|
+
case 1:
|
|
183
|
+
// authentication bearer required
|
|
184
|
+
// http bearer authentication required
|
|
185
|
+
_a.sent();
|
|
186
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
187
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
188
|
+
}
|
|
189
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
190
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
191
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
192
|
+
return [2 /*return*/, {
|
|
193
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
194
|
+
options: localVarRequestOptions,
|
|
195
|
+
}];
|
|
196
|
+
}
|
|
197
|
+
});
|
|
198
|
+
});
|
|
199
|
+
},
|
|
148
200
|
/**
|
|
149
201
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
150
202
|
* @summary Retrieve the setting definition
|
|
@@ -296,6 +348,28 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
296
348
|
});
|
|
297
349
|
});
|
|
298
350
|
},
|
|
351
|
+
/**
|
|
352
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
353
|
+
* @summary Delete the setting definition
|
|
354
|
+
* @param {string} code
|
|
355
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
356
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
|
+
* @param {*} [options] Override http request option.
|
|
358
|
+
* @throws {RequiredError}
|
|
359
|
+
*/
|
|
360
|
+
deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
|
|
361
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
362
|
+
var localVarAxiosArgs;
|
|
363
|
+
return __generator(this, function (_a) {
|
|
364
|
+
switch (_a.label) {
|
|
365
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingDefinition(code, settingDefinition, authorization, options)];
|
|
366
|
+
case 1:
|
|
367
|
+
localVarAxiosArgs = _a.sent();
|
|
368
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
369
|
+
}
|
|
370
|
+
});
|
|
371
|
+
});
|
|
372
|
+
},
|
|
299
373
|
/**
|
|
300
374
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
301
375
|
* @summary Retrieve the setting definition
|
|
@@ -365,6 +439,18 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
|
365
439
|
createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
|
|
366
440
|
return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
367
441
|
},
|
|
442
|
+
/**
|
|
443
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
444
|
+
* @summary Delete the setting definition
|
|
445
|
+
* @param {string} code
|
|
446
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
447
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
448
|
+
* @param {*} [options] Override http request option.
|
|
449
|
+
* @throws {RequiredError}
|
|
450
|
+
*/
|
|
451
|
+
deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
|
|
452
|
+
return localVarFp.deleteSettingDefinition(code, settingDefinition, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
453
|
+
},
|
|
368
454
|
/**
|
|
369
455
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
370
456
|
* @summary Retrieve the setting definition
|
|
@@ -419,6 +505,18 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
|
|
|
419
505
|
var _this = this;
|
|
420
506
|
return (0, exports.SettingDefinitionsApiFp)(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
421
507
|
};
|
|
508
|
+
/**
|
|
509
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
510
|
+
* @summary Delete the setting definition
|
|
511
|
+
* @param {SettingDefinitionsApiDeleteSettingDefinitionRequest} requestParameters Request parameters.
|
|
512
|
+
* @param {*} [options] Override http request option.
|
|
513
|
+
* @throws {RequiredError}
|
|
514
|
+
* @memberof SettingDefinitionsApi
|
|
515
|
+
*/
|
|
516
|
+
SettingDefinitionsApi.prototype.deleteSettingDefinition = function (requestParameters, options) {
|
|
517
|
+
var _this = this;
|
|
518
|
+
return (0, exports.SettingDefinitionsApiFp)(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.settingDefinition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
519
|
+
};
|
|
422
520
|
/**
|
|
423
521
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
424
522
|
* @summary Retrieve the setting definition
|
|
@@ -14,7 +14,7 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateSettingKeyRequestDto } from '../models';
|
|
16
16
|
import { CreateSettingKeyResponseClass } from '../models';
|
|
17
|
-
import {
|
|
17
|
+
import { DeleteByCodeResponseClass } from '../models';
|
|
18
18
|
import { GetSettingKeyResponseClass } from '../models';
|
|
19
19
|
import { ListSettingKeysResponseClass } from '../models';
|
|
20
20
|
import { UpdateSettingKeyRequestRestDto } from '../models';
|
|
@@ -113,7 +113,7 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
|
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
|
-
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
116
|
+
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
|
|
117
117
|
/**
|
|
118
118
|
* Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
|
|
119
119
|
* @summary Retrieve the setting key
|
|
@@ -185,7 +185,7 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
|
|
|
185
185
|
* @param {*} [options] Override http request option.
|
|
186
186
|
* @throws {RequiredError}
|
|
187
187
|
*/
|
|
188
|
-
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<
|
|
188
|
+
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
|
|
189
189
|
/**
|
|
190
190
|
* Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
|
|
191
191
|
* @summary Retrieve the setting key
|
|
@@ -450,7 +450,7 @@ export declare class SettingKeysApi extends BaseAPI {
|
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
* @memberof SettingKeysApi
|
|
452
452
|
*/
|
|
453
|
-
deleteSettingKey(requestParameters: SettingKeysApiDeleteSettingKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
453
|
+
deleteSettingKey(requestParameters: SettingKeysApiDeleteSettingKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteByCodeResponseClass, any, {}>>;
|
|
454
454
|
/**
|
|
455
455
|
* Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
|
|
456
456
|
* @summary Retrieve the setting key
|
package/dist/models/{delete-setting-key-response-class.d.ts → delete-by-code-response-class.d.ts}
RENAMED
|
@@ -12,13 +12,13 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface DeleteByCodeResponseClass
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface DeleteByCodeResponseClass {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* success
|
|
20
20
|
* @type {boolean}
|
|
21
|
-
* @memberof
|
|
21
|
+
* @memberof DeleteByCodeResponseClass
|
|
22
22
|
*/
|
|
23
23
|
'success': boolean;
|
|
24
24
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -4,8 +4,8 @@ export * from './create-setting-definition-request-dto';
|
|
|
4
4
|
export * from './create-setting-definition-response-class';
|
|
5
5
|
export * from './create-setting-key-request-dto';
|
|
6
6
|
export * from './create-setting-key-response-class';
|
|
7
|
+
export * from './delete-by-code-response-class';
|
|
7
8
|
export * from './delete-public-key-request-dto';
|
|
8
|
-
export * from './delete-setting-key-response-class';
|
|
9
9
|
export * from './get-public-key-response-class';
|
|
10
10
|
export * from './get-setting-definition-response-class';
|
|
11
11
|
export * from './get-setting-key-response-class';
|
package/dist/models/index.js
CHANGED
|
@@ -20,8 +20,8 @@ __exportStar(require("./create-setting-definition-request-dto"), exports);
|
|
|
20
20
|
__exportStar(require("./create-setting-definition-response-class"), exports);
|
|
21
21
|
__exportStar(require("./create-setting-key-request-dto"), exports);
|
|
22
22
|
__exportStar(require("./create-setting-key-response-class"), exports);
|
|
23
|
+
__exportStar(require("./delete-by-code-response-class"), exports);
|
|
23
24
|
__exportStar(require("./delete-public-key-request-dto"), exports);
|
|
24
|
-
__exportStar(require("./delete-setting-key-response-class"), exports);
|
|
25
25
|
__exportStar(require("./get-public-key-response-class"), exports);
|
|
26
26
|
__exportStar(require("./get-setting-definition-response-class"), exports);
|
|
27
27
|
__exportStar(require("./get-setting-key-response-class"), exports);
|
|
@@ -17,13 +17,13 @@
|
|
|
17
17
|
/**
|
|
18
18
|
*
|
|
19
19
|
* @export
|
|
20
|
-
* @interface
|
|
20
|
+
* @interface DeleteByCodeResponseClass
|
|
21
21
|
*/
|
|
22
|
-
export interface
|
|
22
|
+
export interface DeleteByCodeResponseClass {
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* success
|
|
25
25
|
* @type {boolean}
|
|
26
|
-
* @memberof
|
|
26
|
+
* @memberof DeleteByCodeResponseClass
|
|
27
27
|
*/
|
|
28
28
|
'success': boolean;
|
|
29
29
|
}
|
package/models/index.ts
CHANGED
|
@@ -4,8 +4,8 @@ export * from './create-setting-definition-request-dto';
|
|
|
4
4
|
export * from './create-setting-definition-response-class';
|
|
5
5
|
export * from './create-setting-key-request-dto';
|
|
6
6
|
export * from './create-setting-key-response-class';
|
|
7
|
+
export * from './delete-by-code-response-class';
|
|
7
8
|
export * from './delete-public-key-request-dto';
|
|
8
|
-
export * from './delete-setting-key-response-class';
|
|
9
9
|
export * from './get-public-key-response-class';
|
|
10
10
|
export * from './get-setting-definition-response-class';
|
|
11
11
|
export * from './get-setting-key-response-class';
|
package/package.json
CHANGED
/package/dist/models/{delete-setting-key-response-class.js → delete-by-code-response-class.js}
RENAMED
|
File without changes
|