@emilgroup/setting-sdk 0.3.1-beta.22 → 0.3.1-beta.24
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@0.3.1-beta.
|
|
20
|
+
npm install @emilgroup/setting-sdk@0.3.1-beta.24 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/setting-sdk@0.3.1-beta.
|
|
24
|
+
yarn add @emilgroup/setting-sdk@0.3.1-beta.24
|
|
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';
|
|
@@ -81,6 +83,55 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
|
|
|
81
83
|
options: localVarRequestOptions,
|
|
82
84
|
};
|
|
83
85
|
},
|
|
86
|
+
/**
|
|
87
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
88
|
+
* @summary Delete the setting definition
|
|
89
|
+
* @param {string} code
|
|
90
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
91
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
deleteSettingDefinition: async (code: string, settingDefinition: any, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
96
|
+
// verify required parameter 'code' is not null or undefined
|
|
97
|
+
assertParamExists('deleteSettingDefinition', 'code', code)
|
|
98
|
+
// verify required parameter 'settingDefinition' is not null or undefined
|
|
99
|
+
assertParamExists('deleteSettingDefinition', 'settingDefinition', settingDefinition)
|
|
100
|
+
const localVarPath = `/settingservice/v1/settings/definitions/{code}`
|
|
101
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
102
|
+
.replace(`{${"setting definition"}}`, encodeURIComponent(String(settingDefinition)));
|
|
103
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
104
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
105
|
+
let baseOptions;
|
|
106
|
+
let baseAccessToken;
|
|
107
|
+
if (configuration) {
|
|
108
|
+
baseOptions = configuration.baseOptions;
|
|
109
|
+
baseAccessToken = configuration.accessToken;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
113
|
+
const localVarHeaderParameter = {} as any;
|
|
114
|
+
const localVarQueryParameter = {} as any;
|
|
115
|
+
|
|
116
|
+
// authentication bearer required
|
|
117
|
+
// http bearer authentication required
|
|
118
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
119
|
+
|
|
120
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
121
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
127
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
128
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
129
|
+
|
|
130
|
+
return {
|
|
131
|
+
url: toPathString(localVarUrlObj),
|
|
132
|
+
options: localVarRequestOptions,
|
|
133
|
+
};
|
|
134
|
+
},
|
|
84
135
|
/**
|
|
85
136
|
* 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\"
|
|
86
137
|
* @summary Retrieve the setting definition
|
|
@@ -224,6 +275,19 @@ export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
|
|
|
224
275
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options);
|
|
225
276
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
226
277
|
},
|
|
278
|
+
/**
|
|
279
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
280
|
+
* @summary Delete the setting definition
|
|
281
|
+
* @param {string} code
|
|
282
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
283
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
async deleteSettingDefinition(code: string, settingDefinition: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
288
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingDefinition(code, settingDefinition, authorization, options);
|
|
289
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
290
|
+
},
|
|
227
291
|
/**
|
|
228
292
|
* 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\"
|
|
229
293
|
* @summary Retrieve the setting definition
|
|
@@ -275,6 +339,18 @@ export const SettingDefinitionsApiFactory = function (configuration?: Configurat
|
|
|
275
339
|
createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingDefinitionResponseClass> {
|
|
276
340
|
return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
277
341
|
},
|
|
342
|
+
/**
|
|
343
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
344
|
+
* @summary Delete the setting definition
|
|
345
|
+
* @param {string} code
|
|
346
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
347
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
|
+
* @param {*} [options] Override http request option.
|
|
349
|
+
* @throws {RequiredError}
|
|
350
|
+
*/
|
|
351
|
+
deleteSettingDefinition(code: string, settingDefinition: any, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
352
|
+
return localVarFp.deleteSettingDefinition(code, settingDefinition, authorization, options).then((request) => request(axios, basePath));
|
|
353
|
+
},
|
|
278
354
|
/**
|
|
279
355
|
* 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\"
|
|
280
356
|
* @summary Retrieve the setting definition
|
|
@@ -327,6 +403,34 @@ export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
|
|
|
327
403
|
readonly authorization?: string
|
|
328
404
|
}
|
|
329
405
|
|
|
406
|
+
/**
|
|
407
|
+
* Request parameters for deleteSettingDefinition operation in SettingDefinitionsApi.
|
|
408
|
+
* @export
|
|
409
|
+
* @interface SettingDefinitionsApiDeleteSettingDefinitionRequest
|
|
410
|
+
*/
|
|
411
|
+
export interface SettingDefinitionsApiDeleteSettingDefinitionRequest {
|
|
412
|
+
/**
|
|
413
|
+
*
|
|
414
|
+
* @type {string}
|
|
415
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
416
|
+
*/
|
|
417
|
+
readonly code: string
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Unique identifier for the object.
|
|
421
|
+
* @type {any}
|
|
422
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
423
|
+
*/
|
|
424
|
+
readonly settingDefinition: any
|
|
425
|
+
|
|
426
|
+
/**
|
|
427
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
428
|
+
* @type {string}
|
|
429
|
+
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
430
|
+
*/
|
|
431
|
+
readonly authorization?: string
|
|
432
|
+
}
|
|
433
|
+
|
|
330
434
|
/**
|
|
331
435
|
* Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
|
|
332
436
|
* @export
|
|
@@ -430,6 +534,18 @@ export class SettingDefinitionsApi extends BaseAPI {
|
|
|
430
534
|
return SettingDefinitionsApiFp(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
431
535
|
}
|
|
432
536
|
|
|
537
|
+
/**
|
|
538
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
539
|
+
* @summary Delete the setting definition
|
|
540
|
+
* @param {SettingDefinitionsApiDeleteSettingDefinitionRequest} requestParameters Request parameters.
|
|
541
|
+
* @param {*} [options] Override http request option.
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
* @memberof SettingDefinitionsApi
|
|
544
|
+
*/
|
|
545
|
+
public deleteSettingDefinition(requestParameters: SettingDefinitionsApiDeleteSettingDefinitionRequest, options?: AxiosRequestConfig) {
|
|
546
|
+
return SettingDefinitionsApiFp(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.settingDefinition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
547
|
+
}
|
|
548
|
+
|
|
433
549
|
/**
|
|
434
550
|
* 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\"
|
|
435
551
|
* @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
|
|
@@ -412,7 +412,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
412
412
|
* @param {*} [options] Override http request option.
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
*/
|
|
415
|
-
async deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
415
|
+
async deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
416
416
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code, ifMatch, authorization, options);
|
|
417
417
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
418
418
|
},
|
|
@@ -505,7 +505,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
505
505
|
* @param {*} [options] Override http request option.
|
|
506
506
|
* @throws {RequiredError}
|
|
507
507
|
*/
|
|
508
|
-
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<
|
|
508
|
+
deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
509
509
|
return localVarFp.deleteSettingKey(code, ifMatch, authorization, options).then((request) => request(axios, basePath));
|
|
510
510
|
},
|
|
511
511
|
/**
|
|
@@ -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
|
|
@@ -141,6 +141,58 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
141
141
|
});
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
|
+
/**
|
|
145
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
146
|
+
* @summary Delete the setting definition
|
|
147
|
+
* @param {string} code
|
|
148
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
149
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
|
|
154
|
+
if (options === void 0) { options = {}; }
|
|
155
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
156
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
157
|
+
return __generator(this, function (_a) {
|
|
158
|
+
switch (_a.label) {
|
|
159
|
+
case 0:
|
|
160
|
+
// verify required parameter 'code' is not null or undefined
|
|
161
|
+
(0, common_1.assertParamExists)('deleteSettingDefinition', 'code', code);
|
|
162
|
+
// verify required parameter 'settingDefinition' is not null or undefined
|
|
163
|
+
(0, common_1.assertParamExists)('deleteSettingDefinition', 'settingDefinition', settingDefinition);
|
|
164
|
+
localVarPath = "/settingservice/v1/settings/definitions/{code}"
|
|
165
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)))
|
|
166
|
+
.replace("{".concat("setting definition", "}"), encodeURIComponent(String(settingDefinition)));
|
|
167
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
168
|
+
if (configuration) {
|
|
169
|
+
baseOptions = configuration.baseOptions;
|
|
170
|
+
baseAccessToken = configuration.accessToken;
|
|
171
|
+
}
|
|
172
|
+
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
173
|
+
localVarHeaderParameter = {};
|
|
174
|
+
localVarQueryParameter = {};
|
|
175
|
+
// authentication bearer required
|
|
176
|
+
// http bearer authentication required
|
|
177
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
178
|
+
case 1:
|
|
179
|
+
// authentication bearer required
|
|
180
|
+
// http bearer authentication required
|
|
181
|
+
_a.sent();
|
|
182
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
183
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
184
|
+
}
|
|
185
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
186
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
187
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
188
|
+
return [2 /*return*/, {
|
|
189
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
190
|
+
options: localVarRequestOptions,
|
|
191
|
+
}];
|
|
192
|
+
}
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
},
|
|
144
196
|
/**
|
|
145
197
|
* 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\"
|
|
146
198
|
* @summary Retrieve the setting definition
|
|
@@ -292,6 +344,28 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
292
344
|
});
|
|
293
345
|
});
|
|
294
346
|
},
|
|
347
|
+
/**
|
|
348
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
349
|
+
* @summary Delete the setting definition
|
|
350
|
+
* @param {string} code
|
|
351
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
352
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
*/
|
|
356
|
+
deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
|
|
357
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
358
|
+
var localVarAxiosArgs;
|
|
359
|
+
return __generator(this, function (_a) {
|
|
360
|
+
switch (_a.label) {
|
|
361
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingDefinition(code, settingDefinition, authorization, options)];
|
|
362
|
+
case 1:
|
|
363
|
+
localVarAxiosArgs = _a.sent();
|
|
364
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
365
|
+
}
|
|
366
|
+
});
|
|
367
|
+
});
|
|
368
|
+
},
|
|
295
369
|
/**
|
|
296
370
|
* 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\"
|
|
297
371
|
* @summary Retrieve the setting definition
|
|
@@ -361,6 +435,18 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
|
361
435
|
createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
|
|
362
436
|
return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
363
437
|
},
|
|
438
|
+
/**
|
|
439
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
440
|
+
* @summary Delete the setting definition
|
|
441
|
+
* @param {string} code
|
|
442
|
+
* @param {any} settingDefinition Unique identifier for the object.
|
|
443
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
444
|
+
* @param {*} [options] Override http request option.
|
|
445
|
+
* @throws {RequiredError}
|
|
446
|
+
*/
|
|
447
|
+
deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
|
|
448
|
+
return localVarFp.deleteSettingDefinition(code, settingDefinition, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
449
|
+
},
|
|
364
450
|
/**
|
|
365
451
|
* 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\"
|
|
366
452
|
* @summary Retrieve the setting definition
|
|
@@ -415,6 +501,18 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
|
|
|
415
501
|
var _this = this;
|
|
416
502
|
return (0, exports.SettingDefinitionsApiFp)(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
417
503
|
};
|
|
504
|
+
/**
|
|
505
|
+
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
506
|
+
* @summary Delete the setting definition
|
|
507
|
+
* @param {SettingDefinitionsApiDeleteSettingDefinitionRequest} requestParameters Request parameters.
|
|
508
|
+
* @param {*} [options] Override http request option.
|
|
509
|
+
* @throws {RequiredError}
|
|
510
|
+
* @memberof SettingDefinitionsApi
|
|
511
|
+
*/
|
|
512
|
+
SettingDefinitionsApi.prototype.deleteSettingDefinition = function (requestParameters, options) {
|
|
513
|
+
var _this = this;
|
|
514
|
+
return (0, exports.SettingDefinitionsApiFp)(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.settingDefinition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
515
|
+
};
|
|
418
516
|
/**
|
|
419
517
|
* 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\"
|
|
420
518
|
* @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
|