@emilgroup/setting-sdk 0.3.1-beta.24 → 0.3.1-beta.26

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.
@@ -144,12 +144,11 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
144
144
  /**
145
145
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
146
146
  * @param {string} code
147
- * @param {string} ifMatch
148
147
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
149
148
  * @param {*} [options] Override http request option.
150
149
  * @throws {RequiredError}
151
150
  */
152
- deleteSettingKey: function (code, ifMatch, authorization, options) {
151
+ deleteSettingKey: function (code, authorization, options) {
153
152
  if (options === void 0) { options = {}; }
154
153
  return __awaiter(_this, void 0, void 0, function () {
155
154
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -158,8 +157,6 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
158
157
  case 0:
159
158
  // verify required parameter 'code' is not null or undefined
160
159
  (0, common_1.assertParamExists)('deleteSettingKey', 'code', code);
161
- // verify required parameter 'ifMatch' is not null or undefined
162
- (0, common_1.assertParamExists)('deleteSettingKey', 'ifMatch', ifMatch);
163
160
  localVarPath = "/settingservice/v1/setting-keys/{code}"
164
161
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
165
162
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -180,9 +177,6 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
180
177
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
181
178
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
182
179
  }
183
- if (ifMatch !== undefined && ifMatch !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
184
- localVarHeaderParameter['if-match'] = String(ifMatch ? ifMatch : baseAccessToken);
185
- }
186
180
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
187
181
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
188
182
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -200,7 +194,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
200
194
  * @param {string} code
201
195
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
196
  * @param {number} [version] Specific value version. Defaults to latest.
203
- * @param {string} [expand] Optional expand (definition only).
197
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
204
198
  * @param {*} [options] Override http request option.
205
199
  * @throws {RequiredError}
206
200
  */
@@ -256,7 +250,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
256
250
  * @param {string} slug
257
251
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
258
252
  * @param {number} [version] Specific value version. Defaults to latest.
259
- * @param {string} [expand] Optional expand (definition only).
253
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
260
254
  * @param {*} [options] Override http request option.
261
255
  * @throws {RequiredError}
262
256
  */
@@ -307,16 +301,16 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
307
301
  });
308
302
  },
309
303
  /**
310
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
304
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
311
305
  * @summary List setting keys
312
306
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
313
307
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
314
308
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
315
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
309
+ * @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: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
316
310
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
317
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
318
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
319
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
311
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
312
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
313
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
320
314
  * @param {*} [options] Override http request option.
321
315
  * @throws {RequiredError}
322
316
  */
@@ -382,7 +376,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
382
376
  * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
383
377
  * @summary Update the setting key
384
378
  * @param {string} code
385
- * @param {string} ifMatch
379
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
386
380
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
387
381
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
388
382
  * @param {*} [options] Override http request option.
@@ -471,17 +465,16 @@ var SettingKeysApiFp = function (configuration) {
471
465
  /**
472
466
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
473
467
  * @param {string} code
474
- * @param {string} ifMatch
475
468
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
476
469
  * @param {*} [options] Override http request option.
477
470
  * @throws {RequiredError}
478
471
  */
479
- deleteSettingKey: function (code, ifMatch, authorization, options) {
472
+ deleteSettingKey: function (code, authorization, options) {
480
473
  return __awaiter(this, void 0, void 0, function () {
481
474
  var localVarAxiosArgs;
482
475
  return __generator(this, function (_a) {
483
476
  switch (_a.label) {
484
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingKey(code, ifMatch, authorization, options)];
477
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingKey(code, authorization, options)];
485
478
  case 1:
486
479
  localVarAxiosArgs = _a.sent();
487
480
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -495,7 +488,7 @@ var SettingKeysApiFp = function (configuration) {
495
488
  * @param {string} code
496
489
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
490
  * @param {number} [version] Specific value version. Defaults to latest.
498
- * @param {string} [expand] Optional expand (definition only).
491
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
499
492
  * @param {*} [options] Override http request option.
500
493
  * @throws {RequiredError}
501
494
  */
@@ -518,7 +511,7 @@ var SettingKeysApiFp = function (configuration) {
518
511
  * @param {string} slug
519
512
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
520
513
  * @param {number} [version] Specific value version. Defaults to latest.
521
- * @param {string} [expand] Optional expand (definition only).
514
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
522
515
  * @param {*} [options] Override http request option.
523
516
  * @throws {RequiredError}
524
517
  */
@@ -536,16 +529,16 @@ var SettingKeysApiFp = function (configuration) {
536
529
  });
537
530
  },
538
531
  /**
539
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
532
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
540
533
  * @summary List setting keys
541
534
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
542
535
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
543
536
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
544
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
537
+ * @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: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
545
538
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
546
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
547
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
548
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
539
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
540
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
541
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
549
542
  * @param {*} [options] Override http request option.
550
543
  * @throws {RequiredError}
551
544
  */
@@ -566,7 +559,7 @@ var SettingKeysApiFp = function (configuration) {
566
559
  * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
567
560
  * @summary Update the setting key
568
561
  * @param {string} code
569
- * @param {string} ifMatch
562
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
570
563
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
571
564
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
572
565
  * @param {*} [options] Override http request option.
@@ -609,13 +602,12 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
609
602
  /**
610
603
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
611
604
  * @param {string} code
612
- * @param {string} ifMatch
613
605
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
614
606
  * @param {*} [options] Override http request option.
615
607
  * @throws {RequiredError}
616
608
  */
617
- deleteSettingKey: function (code, ifMatch, authorization, options) {
618
- return localVarFp.deleteSettingKey(code, ifMatch, authorization, options).then(function (request) { return request(axios, basePath); });
609
+ deleteSettingKey: function (code, authorization, options) {
610
+ return localVarFp.deleteSettingKey(code, authorization, options).then(function (request) { return request(axios, basePath); });
619
611
  },
620
612
  /**
621
613
  * 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\"
@@ -623,7 +615,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
623
615
  * @param {string} code
624
616
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
625
617
  * @param {number} [version] Specific value version. Defaults to latest.
626
- * @param {string} [expand] Optional expand (definition only).
618
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
627
619
  * @param {*} [options] Override http request option.
628
620
  * @throws {RequiredError}
629
621
  */
@@ -636,7 +628,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
636
628
  * @param {string} slug
637
629
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
638
630
  * @param {number} [version] Specific value version. Defaults to latest.
639
- * @param {string} [expand] Optional expand (definition only).
631
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
640
632
  * @param {*} [options] Override http request option.
641
633
  * @throws {RequiredError}
642
634
  */
@@ -644,16 +636,16 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
644
636
  return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then(function (request) { return request(axios, basePath); });
645
637
  },
646
638
  /**
647
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
639
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
648
640
  * @summary List setting keys
649
641
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
650
642
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
651
643
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
652
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
644
+ * @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: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
653
645
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
654
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
655
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
656
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
646
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
647
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
648
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
657
649
  * @param {*} [options] Override http request option.
658
650
  * @throws {RequiredError}
659
651
  */
@@ -664,7 +656,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
664
656
  * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
665
657
  * @summary Update the setting key
666
658
  * @param {string} code
667
- * @param {string} ifMatch
659
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
668
660
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
669
661
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
670
662
  * @param {*} [options] Override http request option.
@@ -708,7 +700,7 @@ var SettingKeysApi = /** @class */ (function (_super) {
708
700
  */
709
701
  SettingKeysApi.prototype.deleteSettingKey = function (requestParameters, options) {
710
702
  var _this = this;
711
- return (0, exports.SettingKeysApiFp)(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.ifMatch, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
703
+ return (0, exports.SettingKeysApiFp)(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
712
704
  };
713
705
  /**
714
706
  * 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\"
@@ -735,7 +727,7 @@ var SettingKeysApi = /** @class */ (function (_super) {
735
727
  return (0, exports.SettingKeysApiFp)(this.configuration).getSettingKeyBySlug(requestParameters.slug, requestParameters.authorization, requestParameters.version, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
736
728
  };
737
729
  /**
738
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
730
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
739
731
  * @summary List setting keys
740
732
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
741
733
  * @param {*} [options] Override http request option.
package/dist/api.d.ts CHANGED
@@ -13,4 +13,3 @@ export * from './api/health-api';
13
13
  export * from './api/public-keys-api';
14
14
  export * from './api/setting-definitions-api';
15
15
  export * from './api/setting-keys-api';
16
- export * from './api/setting-values-api';
package/dist/api.js CHANGED
@@ -31,4 +31,3 @@ __exportStar(require("./api/health-api"), exports);
31
31
  __exportStar(require("./api/public-keys-api"), exports);
32
32
  __exportStar(require("./api/setting-definitions-api"), exports);
33
33
  __exportStar(require("./api/setting-keys-api"), exports);
34
- __exportStar(require("./api/setting-values-api"), exports);
@@ -14,7 +14,6 @@ export * from './inline-response503';
14
14
  export * from './list-public-keys-response-class';
15
15
  export * from './list-setting-definitions-response-class';
16
16
  export * from './list-setting-keys-response-class';
17
- export * from './list-setting-values-response-class';
18
17
  export * from './public-key-class';
19
18
  export * from './rotate-public-key-response-class';
20
19
  export * from './setting-definition-class';
@@ -30,7 +30,6 @@ __exportStar(require("./inline-response503"), exports);
30
30
  __exportStar(require("./list-public-keys-response-class"), exports);
31
31
  __exportStar(require("./list-setting-definitions-response-class"), exports);
32
32
  __exportStar(require("./list-setting-keys-response-class"), exports);
33
- __exportStar(require("./list-setting-values-response-class"), exports);
34
33
  __exportStar(require("./public-key-class"), exports);
35
34
  __exportStar(require("./rotate-public-key-response-class"), exports);
36
35
  __exportStar(require("./setting-definition-class"), exports);
@@ -77,7 +77,7 @@ export interface SettingKeyClass {
77
77
  */
78
78
  'updatedBy': string;
79
79
  /**
80
- * Value versions with payload and etag. Populated on create, update, and get responses. Use the values list endpoint for full version history.
80
+ * Setting values with payload and etag. Populated on create, update, and get responses. On list, included when expand=values is requested.
81
81
  * @type {Array<SettingValueClass>}
82
82
  * @memberof SettingKeyClass
83
83
  */
package/models/index.ts CHANGED
@@ -14,7 +14,6 @@ export * from './inline-response503';
14
14
  export * from './list-public-keys-response-class';
15
15
  export * from './list-setting-definitions-response-class';
16
16
  export * from './list-setting-keys-response-class';
17
- export * from './list-setting-values-response-class';
18
17
  export * from './public-key-class';
19
18
  export * from './rotate-public-key-response-class';
20
19
  export * from './setting-definition-class';
@@ -82,7 +82,7 @@ export interface SettingKeyClass {
82
82
  */
83
83
  'updatedBy': string;
84
84
  /**
85
- * Value versions with payload and etag. Populated on create, update, and get responses. Use the values list endpoint for full version history.
85
+ * Setting values with payload and etag. Populated on create, update, and get responses. On list, included when expand=values is requested.
86
86
  * @type {Array<SettingValueClass>}
87
87
  * @memberof SettingKeyClass
88
88
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/setting-sdk",
3
- "version": "0.3.1-beta.24",
3
+ "version": "0.3.1-beta.26",
4
4
  "description": "OpenAPI client for @emilgroup/setting-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -1,246 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * EMIL SettingService
5
- * The EMIL SettingService API description
6
- *
7
- * The version of the OpenAPI document: 1.0
8
- * Contact: kontakt@emil.de
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
- import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
- import { Configuration } from '../configuration';
18
- // Some imports not used depending on template conditions
19
- // @ts-ignore
20
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
- // @ts-ignore
22
- import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
- // @ts-ignore
24
- import { ListSettingValuesResponseClass } from '../models';
25
- /**
26
- * SettingValuesApi - axios parameter creator
27
- * @export
28
- */
29
- export const SettingValuesApiAxiosParamCreator = function (configuration?: Configuration) {
30
- return {
31
- /**
32
- * Returns a list of setting values you have previously created. The setting values are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
33
- * @summary List setting values
34
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
36
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
37
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
38
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
39
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
40
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
41
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
42
- * @param {*} [options] Override http request option.
43
- * @throws {RequiredError}
44
- */
45
- listSettingValues: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
- const localVarPath = `/settingservice/v2/setting-values`;
47
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
- let baseOptions;
50
- let baseAccessToken;
51
- if (configuration) {
52
- baseOptions = configuration.baseOptions;
53
- baseAccessToken = configuration.accessToken;
54
- }
55
-
56
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
57
- const localVarHeaderParameter = {} as any;
58
- const localVarQueryParameter = {} as any;
59
-
60
- // authentication bearer required
61
- // http bearer authentication required
62
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
63
-
64
- if (pageSize !== undefined) {
65
- localVarQueryParameter['pageSize'] = pageSize;
66
- }
67
-
68
- if (pageToken !== undefined) {
69
- localVarQueryParameter['pageToken'] = pageToken;
70
- }
71
-
72
- if (filter !== undefined) {
73
- localVarQueryParameter['filter'] = filter;
74
- }
75
-
76
- if (search !== undefined) {
77
- localVarQueryParameter['search'] = search;
78
- }
79
-
80
- if (order !== undefined) {
81
- localVarQueryParameter['order'] = order;
82
- }
83
-
84
- if (expand !== undefined) {
85
- localVarQueryParameter['expand'] = expand;
86
- }
87
-
88
- if (filters !== undefined) {
89
- localVarQueryParameter['filters'] = filters;
90
- }
91
-
92
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
93
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
94
- }
95
-
96
-
97
-
98
- setSearchParams(localVarUrlObj, localVarQueryParameter);
99
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
100
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
101
-
102
- return {
103
- url: toPathString(localVarUrlObj),
104
- options: localVarRequestOptions,
105
- };
106
- },
107
- }
108
- };
109
-
110
- /**
111
- * SettingValuesApi - functional programming interface
112
- * @export
113
- */
114
- export const SettingValuesApiFp = function(configuration?: Configuration) {
115
- const localVarAxiosParamCreator = SettingValuesApiAxiosParamCreator(configuration)
116
- return {
117
- /**
118
- * Returns a list of setting values you have previously created. The setting values are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
119
- * @summary List setting values
120
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
121
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
122
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
123
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
124
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
125
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
126
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
127
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
128
- * @param {*} [options] Override http request option.
129
- * @throws {RequiredError}
130
- */
131
- async listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettingValuesResponseClass>> {
132
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
133
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
134
- },
135
- }
136
- };
137
-
138
- /**
139
- * SettingValuesApi - factory interface
140
- * @export
141
- */
142
- export const SettingValuesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
143
- const localVarFp = SettingValuesApiFp(configuration)
144
- return {
145
- /**
146
- * Returns a list of setting values you have previously created. The setting values are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
147
- * @summary List setting values
148
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
149
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
150
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
151
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
152
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
153
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
154
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
155
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
156
- * @param {*} [options] Override http request option.
157
- * @throws {RequiredError}
158
- */
159
- listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingValuesResponseClass> {
160
- return localVarFp.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
161
- },
162
- };
163
- };
164
-
165
- /**
166
- * Request parameters for listSettingValues operation in SettingValuesApi.
167
- * @export
168
- * @interface SettingValuesApiListSettingValuesRequest
169
- */
170
- export interface SettingValuesApiListSettingValuesRequest {
171
- /**
172
- * Bearer Token: provided by the login endpoint under the name accessToken.
173
- * @type {string}
174
- * @memberof SettingValuesApiListSettingValues
175
- */
176
- readonly authorization?: string
177
-
178
- /**
179
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
180
- * @type {number}
181
- * @memberof SettingValuesApiListSettingValues
182
- */
183
- readonly pageSize?: number
184
-
185
- /**
186
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
187
- * @type {string}
188
- * @memberof SettingValuesApiListSettingValues
189
- */
190
- readonly pageToken?: string
191
-
192
- /**
193
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
194
- * @type {string}
195
- * @memberof SettingValuesApiListSettingValues
196
- */
197
- readonly filter?: string
198
-
199
- /**
200
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
201
- * @type {string}
202
- * @memberof SettingValuesApiListSettingValues
203
- */
204
- readonly search?: string
205
-
206
- /**
207
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
208
- * @type {string}
209
- * @memberof SettingValuesApiListSettingValues
210
- */
211
- readonly order?: string
212
-
213
- /**
214
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
215
- * @type {string}
216
- * @memberof SettingValuesApiListSettingValues
217
- */
218
- readonly expand?: string
219
-
220
- /**
221
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
222
- * @type {string}
223
- * @memberof SettingValuesApiListSettingValues
224
- */
225
- readonly filters?: string
226
- }
227
-
228
- /**
229
- * SettingValuesApi - object-oriented interface
230
- * @export
231
- * @class SettingValuesApi
232
- * @extends {BaseAPI}
233
- */
234
- export class SettingValuesApi extends BaseAPI {
235
- /**
236
- * Returns a list of setting values you have previously created. The setting values are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
237
- * @summary List setting values
238
- * @param {SettingValuesApiListSettingValuesRequest} requestParameters Request parameters.
239
- * @param {*} [options] Override http request option.
240
- * @throws {RequiredError}
241
- * @memberof SettingValuesApi
242
- */
243
- public listSettingValues(requestParameters: SettingValuesApiListSettingValuesRequest = {}, options?: AxiosRequestConfig) {
244
- return SettingValuesApiFp(this.configuration).listSettingValues(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
245
- }
246
- }