@emilgroup/setting-sdk-node 0.3.1-beta.23 → 0.3.1-beta.25

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.
@@ -148,12 +148,11 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
148
148
  /**
149
149
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
150
150
  * @param {string} code
151
- * @param {string} ifMatch
152
151
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
152
  * @param {*} [options] Override http request option.
154
153
  * @throws {RequiredError}
155
154
  */
156
- deleteSettingKey: function (code, ifMatch, authorization, options) {
155
+ deleteSettingKey: function (code, authorization, options) {
157
156
  if (options === void 0) { options = {}; }
158
157
  return __awaiter(_this, void 0, void 0, function () {
159
158
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -162,8 +161,6 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
162
161
  case 0:
163
162
  // verify required parameter 'code' is not null or undefined
164
163
  (0, common_1.assertParamExists)('deleteSettingKey', 'code', code);
165
- // verify required parameter 'ifMatch' is not null or undefined
166
- (0, common_1.assertParamExists)('deleteSettingKey', 'ifMatch', ifMatch);
167
164
  localVarPath = "/settingservice/v1/setting-keys/{code}"
168
165
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
169
166
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -184,9 +181,6 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
184
181
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
185
182
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
186
183
  }
187
- if (ifMatch !== undefined && ifMatch !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
188
- localVarHeaderParameter['if-match'] = String(ifMatch ? ifMatch : baseAccessToken);
189
- }
190
184
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
191
185
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
192
186
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -204,7 +198,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
204
198
  * @param {string} code
205
199
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
206
200
  * @param {number} [version] Specific value version. Defaults to latest.
207
- * @param {string} [expand] Optional expand (definition only).
201
+ * @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>
208
202
  * @param {*} [options] Override http request option.
209
203
  * @throws {RequiredError}
210
204
  */
@@ -260,7 +254,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
260
254
  * @param {string} slug
261
255
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
262
256
  * @param {number} [version] Specific value version. Defaults to latest.
263
- * @param {string} [expand] Optional expand (definition only).
257
+ * @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>
264
258
  * @param {*} [options] Override http request option.
265
259
  * @throws {RequiredError}
266
260
  */
@@ -311,16 +305,16 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
311
305
  });
312
306
  },
313
307
  /**
314
- * 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\"
308
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
315
309
  * @summary List setting keys
316
310
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
317
311
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
318
312
  * @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.
319
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
313
+ * @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>
320
314
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
321
- * @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.
322
- * @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/>
323
- * @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.
315
+ * @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>
316
+ * @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>
317
+ * @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>
324
318
  * @param {*} [options] Override http request option.
325
319
  * @throws {RequiredError}
326
320
  */
@@ -386,7 +380,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
386
380
  * 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\"
387
381
  * @summary Update the setting key
388
382
  * @param {string} code
389
- * @param {string} ifMatch
383
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
390
384
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
391
385
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
392
386
  * @param {*} [options] Override http request option.
@@ -475,17 +469,16 @@ var SettingKeysApiFp = function (configuration) {
475
469
  /**
476
470
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
477
471
  * @param {string} code
478
- * @param {string} ifMatch
479
472
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
480
473
  * @param {*} [options] Override http request option.
481
474
  * @throws {RequiredError}
482
475
  */
483
- deleteSettingKey: function (code, ifMatch, authorization, options) {
476
+ deleteSettingKey: function (code, authorization, options) {
484
477
  return __awaiter(this, void 0, void 0, function () {
485
478
  var localVarAxiosArgs;
486
479
  return __generator(this, function (_a) {
487
480
  switch (_a.label) {
488
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingKey(code, ifMatch, authorization, options)];
481
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingKey(code, authorization, options)];
489
482
  case 1:
490
483
  localVarAxiosArgs = _a.sent();
491
484
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -499,7 +492,7 @@ var SettingKeysApiFp = function (configuration) {
499
492
  * @param {string} code
500
493
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
501
494
  * @param {number} [version] Specific value version. Defaults to latest.
502
- * @param {string} [expand] Optional expand (definition only).
495
+ * @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>
503
496
  * @param {*} [options] Override http request option.
504
497
  * @throws {RequiredError}
505
498
  */
@@ -522,7 +515,7 @@ var SettingKeysApiFp = function (configuration) {
522
515
  * @param {string} slug
523
516
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
524
517
  * @param {number} [version] Specific value version. Defaults to latest.
525
- * @param {string} [expand] Optional expand (definition only).
518
+ * @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>
526
519
  * @param {*} [options] Override http request option.
527
520
  * @throws {RequiredError}
528
521
  */
@@ -540,16 +533,16 @@ var SettingKeysApiFp = function (configuration) {
540
533
  });
541
534
  },
542
535
  /**
543
- * 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\"
536
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
544
537
  * @summary List setting keys
545
538
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
546
539
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
547
540
  * @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.
548
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
541
+ * @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>
549
542
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
550
- * @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.
551
- * @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/>
552
- * @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.
543
+ * @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>
544
+ * @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>
545
+ * @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>
553
546
  * @param {*} [options] Override http request option.
554
547
  * @throws {RequiredError}
555
548
  */
@@ -570,7 +563,7 @@ var SettingKeysApiFp = function (configuration) {
570
563
  * 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\"
571
564
  * @summary Update the setting key
572
565
  * @param {string} code
573
- * @param {string} ifMatch
566
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
574
567
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
575
568
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
576
569
  * @param {*} [options] Override http request option.
@@ -613,13 +606,12 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
613
606
  /**
614
607
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
615
608
  * @param {string} code
616
- * @param {string} ifMatch
617
609
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
618
610
  * @param {*} [options] Override http request option.
619
611
  * @throws {RequiredError}
620
612
  */
621
- deleteSettingKey: function (code, ifMatch, authorization, options) {
622
- return localVarFp.deleteSettingKey(code, ifMatch, authorization, options).then(function (request) { return request(axios, basePath); });
613
+ deleteSettingKey: function (code, authorization, options) {
614
+ return localVarFp.deleteSettingKey(code, authorization, options).then(function (request) { return request(axios, basePath); });
623
615
  },
624
616
  /**
625
617
  * 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\"
@@ -627,7 +619,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
627
619
  * @param {string} code
628
620
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
629
621
  * @param {number} [version] Specific value version. Defaults to latest.
630
- * @param {string} [expand] Optional expand (definition only).
622
+ * @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>
631
623
  * @param {*} [options] Override http request option.
632
624
  * @throws {RequiredError}
633
625
  */
@@ -640,7 +632,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
640
632
  * @param {string} slug
641
633
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
642
634
  * @param {number} [version] Specific value version. Defaults to latest.
643
- * @param {string} [expand] Optional expand (definition only).
635
+ * @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>
644
636
  * @param {*} [options] Override http request option.
645
637
  * @throws {RequiredError}
646
638
  */
@@ -648,16 +640,16 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
648
640
  return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then(function (request) { return request(axios, basePath); });
649
641
  },
650
642
  /**
651
- * 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\"
643
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
652
644
  * @summary List setting keys
653
645
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
654
646
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
655
647
  * @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.
656
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
648
+ * @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>
657
649
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
658
- * @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.
659
- * @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/>
660
- * @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.
650
+ * @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>
651
+ * @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>
652
+ * @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>
661
653
  * @param {*} [options] Override http request option.
662
654
  * @throws {RequiredError}
663
655
  */
@@ -668,7 +660,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
668
660
  * 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\"
669
661
  * @summary Update the setting key
670
662
  * @param {string} code
671
- * @param {string} ifMatch
663
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
672
664
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
673
665
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
674
666
  * @param {*} [options] Override http request option.
@@ -712,7 +704,7 @@ var SettingKeysApi = /** @class */ (function (_super) {
712
704
  */
713
705
  SettingKeysApi.prototype.deleteSettingKey = function (requestParameters, options) {
714
706
  var _this = this;
715
- return (0, exports.SettingKeysApiFp)(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.ifMatch, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
707
+ return (0, exports.SettingKeysApiFp)(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
716
708
  };
717
709
  /**
718
710
  * 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\"
@@ -739,7 +731,7 @@ var SettingKeysApi = /** @class */ (function (_super) {
739
731
  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); });
740
732
  };
741
733
  /**
742
- * 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\"
734
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
743
735
  * @summary List setting keys
744
736
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
745
737
  * @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-node",
3
- "version": "0.3.1-beta.23",
3
+ "version": "0.3.1-beta.25",
4
4
  "description": "OpenAPI client for @emilgroup/setting-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -1,250 +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
- // URLSearchParams not necessarily used
26
- // @ts-ignore
27
- import { URL, URLSearchParams } from 'url';
28
- const FormData = require('form-data');
29
- /**
30
- * SettingValuesApi - axios parameter creator
31
- * @export
32
- */
33
- export const SettingValuesApiAxiosParamCreator = function (configuration?: Configuration) {
34
- return {
35
- /**
36
- * 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\"
37
- * @summary List setting values
38
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
40
- * @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.
41
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
42
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
43
- * @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.
44
- * @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;
45
- * @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.
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- listSettingValues: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
- const localVarPath = `/settingservice/v2/setting-values`;
51
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
52
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
53
- let baseOptions;
54
- let baseAccessToken;
55
- if (configuration) {
56
- baseOptions = configuration.baseOptions;
57
- baseAccessToken = configuration.accessToken;
58
- }
59
-
60
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
61
- const localVarHeaderParameter = {} as any;
62
- const localVarQueryParameter = {} as any;
63
-
64
- // authentication bearer required
65
- // http bearer authentication required
66
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
67
-
68
- if (pageSize !== undefined) {
69
- localVarQueryParameter['pageSize'] = pageSize;
70
- }
71
-
72
- if (pageToken !== undefined) {
73
- localVarQueryParameter['pageToken'] = pageToken;
74
- }
75
-
76
- if (filter !== undefined) {
77
- localVarQueryParameter['filter'] = filter;
78
- }
79
-
80
- if (search !== undefined) {
81
- localVarQueryParameter['search'] = search;
82
- }
83
-
84
- if (order !== undefined) {
85
- localVarQueryParameter['order'] = order;
86
- }
87
-
88
- if (expand !== undefined) {
89
- localVarQueryParameter['expand'] = expand;
90
- }
91
-
92
- if (filters !== undefined) {
93
- localVarQueryParameter['filters'] = filters;
94
- }
95
-
96
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
97
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
98
- }
99
-
100
-
101
-
102
- setSearchParams(localVarUrlObj, localVarQueryParameter);
103
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
104
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
105
-
106
- return {
107
- url: toPathString(localVarUrlObj),
108
- options: localVarRequestOptions,
109
- };
110
- },
111
- }
112
- };
113
-
114
- /**
115
- * SettingValuesApi - functional programming interface
116
- * @export
117
- */
118
- export const SettingValuesApiFp = function(configuration?: Configuration) {
119
- const localVarAxiosParamCreator = SettingValuesApiAxiosParamCreator(configuration)
120
- return {
121
- /**
122
- * 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\"
123
- * @summary List setting values
124
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
125
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
126
- * @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.
127
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
128
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
129
- * @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.
130
- * @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;
131
- * @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.
132
- * @param {*} [options] Override http request option.
133
- * @throws {RequiredError}
134
- */
135
- 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>> {
136
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
137
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
138
- },
139
- }
140
- };
141
-
142
- /**
143
- * SettingValuesApi - factory interface
144
- * @export
145
- */
146
- export const SettingValuesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
147
- const localVarFp = SettingValuesApiFp(configuration)
148
- return {
149
- /**
150
- * 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\"
151
- * @summary List setting values
152
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
154
- * @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.
155
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
156
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
157
- * @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.
158
- * @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;
159
- * @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.
160
- * @param {*} [options] Override http request option.
161
- * @throws {RequiredError}
162
- */
163
- listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingValuesResponseClass> {
164
- return localVarFp.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
165
- },
166
- };
167
- };
168
-
169
- /**
170
- * Request parameters for listSettingValues operation in SettingValuesApi.
171
- * @export
172
- * @interface SettingValuesApiListSettingValuesRequest
173
- */
174
- export interface SettingValuesApiListSettingValuesRequest {
175
- /**
176
- * Bearer Token: provided by the login endpoint under the name accessToken.
177
- * @type {string}
178
- * @memberof SettingValuesApiListSettingValues
179
- */
180
- readonly authorization?: string
181
-
182
- /**
183
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
184
- * @type {number}
185
- * @memberof SettingValuesApiListSettingValues
186
- */
187
- readonly pageSize?: number
188
-
189
- /**
190
- * 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.
191
- * @type {string}
192
- * @memberof SettingValuesApiListSettingValues
193
- */
194
- readonly pageToken?: string
195
-
196
- /**
197
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
198
- * @type {string}
199
- * @memberof SettingValuesApiListSettingValues
200
- */
201
- readonly filter?: string
202
-
203
- /**
204
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
205
- * @type {string}
206
- * @memberof SettingValuesApiListSettingValues
207
- */
208
- readonly search?: string
209
-
210
- /**
211
- * 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.
212
- * @type {string}
213
- * @memberof SettingValuesApiListSettingValues
214
- */
215
- readonly order?: string
216
-
217
- /**
218
- * 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;
219
- * @type {string}
220
- * @memberof SettingValuesApiListSettingValues
221
- */
222
- readonly expand?: string
223
-
224
- /**
225
- * 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.
226
- * @type {string}
227
- * @memberof SettingValuesApiListSettingValues
228
- */
229
- readonly filters?: string
230
- }
231
-
232
- /**
233
- * SettingValuesApi - object-oriented interface
234
- * @export
235
- * @class SettingValuesApi
236
- * @extends {BaseAPI}
237
- */
238
- export class SettingValuesApi extends BaseAPI {
239
- /**
240
- * 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\"
241
- * @summary List setting values
242
- * @param {SettingValuesApiListSettingValuesRequest} requestParameters Request parameters.
243
- * @param {*} [options] Override http request option.
244
- * @throws {RequiredError}
245
- * @memberof SettingValuesApi
246
- */
247
- public listSettingValues(requestParameters: SettingValuesApiListSettingValuesRequest = {}, options?: AxiosRequestConfig) {
248
- 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));
249
- }
250
- }