@emilgroup/tenant-sdk-node 1.34.1-beta.17 → 1.34.1-beta.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md 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/tenant-sdk-node@1.34.1-beta.17 --save
20
+ npm install @emilgroup/tenant-sdk-node@1.34.1-beta.20 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/tenant-sdk-node@1.34.1-beta.17
24
+ yarn add @emilgroup/tenant-sdk-node@1.34.1-beta.20
25
25
  ```
26
26
 
27
27
  And then you can import `UsersApi`.
@@ -240,12 +240,12 @@ export const UserGroupApiAxiosParamCreator = function (configuration?: Configura
240
240
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
241
241
  * @param {string} code
242
242
  * @param {string} [authorization] Bearer Token
243
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
244
- * @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.
245
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
243
+ * @param {number} [pageSize] Number of items per page.
244
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
245
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
246
246
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
247
- * @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.
248
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
247
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
248
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
249
249
  * @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.
250
250
  * @param {*} [options] Override http request option.
251
251
  * @throws {RequiredError}
@@ -318,11 +318,11 @@ export const UserGroupApiAxiosParamCreator = function (configuration?: Configura
318
318
  /**
319
319
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
320
320
  * @param {string} [authorization] Bearer Token
321
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
322
- * @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.
323
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
324
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
325
- * @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.
321
+ * @param {number} [pageSize] Number of items per page.
322
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
323
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
324
+ * @param {string} [search] Free-text search over searchable columns.
325
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
326
326
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
327
327
  * @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.
328
328
  * @param {*} [options] Override http request option.
@@ -549,12 +549,12 @@ export const UserGroupApiFp = function(configuration?: Configuration) {
549
549
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
550
550
  * @param {string} code
551
551
  * @param {string} [authorization] Bearer Token
552
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
553
- * @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.
554
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
552
+ * @param {number} [pageSize] Number of items per page.
553
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
554
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
555
555
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
556
- * @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.
557
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
556
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
557
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
558
558
  * @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.
559
559
  * @param {*} [options] Override http request option.
560
560
  * @throws {RequiredError}
@@ -566,11 +566,11 @@ export const UserGroupApiFp = function(configuration?: Configuration) {
566
566
  /**
567
567
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
568
568
  * @param {string} [authorization] Bearer Token
569
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
570
- * @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.
571
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
572
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
573
- * @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.
569
+ * @param {number} [pageSize] Number of items per page.
570
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
571
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
572
+ * @param {string} [search] Free-text search over searchable columns.
573
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
574
574
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
575
575
  * @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.
576
576
  * @param {*} [options] Override http request option.
@@ -659,12 +659,12 @@ export const UserGroupApiFactory = function (configuration?: Configuration, base
659
659
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
660
660
  * @param {string} code
661
661
  * @param {string} [authorization] Bearer Token
662
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
663
- * @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.
664
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
662
+ * @param {number} [pageSize] Number of items per page.
663
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
664
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
665
665
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
666
- * @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.
667
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
666
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
667
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
668
668
  * @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.
669
669
  * @param {*} [options] Override http request option.
670
670
  * @throws {RequiredError}
@@ -675,11 +675,11 @@ export const UserGroupApiFactory = function (configuration?: Configuration, base
675
675
  /**
676
676
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
677
677
  * @param {string} [authorization] Bearer Token
678
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
679
- * @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.
680
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
681
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
682
- * @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.
678
+ * @param {number} [pageSize] Number of items per page.
679
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
680
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
681
+ * @param {string} [search] Free-text search over searchable columns.
682
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
683
683
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
684
684
  * @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.
685
685
  * @param {*} [options] Override http request option.
@@ -825,21 +825,21 @@ export interface UserGroupApiListUserGroupMembersRequest {
825
825
  readonly authorization?: string
826
826
 
827
827
  /**
828
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
828
+ * Number of items per page.
829
829
  * @type {number}
830
830
  * @memberof UserGroupApiListUserGroupMembers
831
831
  */
832
832
  readonly pageSize?: number
833
833
 
834
834
  /**
835
- * 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.
835
+ * Opaque token for the next page (returned in a previous response).
836
836
  * @type {string}
837
837
  * @memberof UserGroupApiListUserGroupMembers
838
838
  */
839
839
  readonly pageToken?: string
840
840
 
841
841
  /**
842
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
842
+ * Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
843
843
  * @type {string}
844
844
  * @memberof UserGroupApiListUserGroupMembers
845
845
  */
@@ -853,14 +853,14 @@ export interface UserGroupApiListUserGroupMembersRequest {
853
853
  readonly search?: string
854
854
 
855
855
  /**
856
- * 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.
856
+ * Sort the response by allowed columns (see paginate config).
857
857
  * @type {string}
858
858
  * @memberof UserGroupApiListUserGroupMembers
859
859
  */
860
860
  readonly order?: string
861
861
 
862
862
  /**
863
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
863
+ * Comma-separated list of related objects to embed in each member (e.g. user details).
864
864
  * @type {string}
865
865
  * @memberof UserGroupApiListUserGroupMembers
866
866
  */
@@ -888,35 +888,35 @@ export interface UserGroupApiListUserGroupsRequest {
888
888
  readonly authorization?: string
889
889
 
890
890
  /**
891
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
891
+ * Number of items per page.
892
892
  * @type {number}
893
893
  * @memberof UserGroupApiListUserGroups
894
894
  */
895
895
  readonly pageSize?: number
896
896
 
897
897
  /**
898
- * 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.
898
+ * Opaque token for the next page (returned in a previous response).
899
899
  * @type {string}
900
900
  * @memberof UserGroupApiListUserGroups
901
901
  */
902
902
  readonly pageToken?: string
903
903
 
904
904
  /**
905
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
905
+ * Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
906
906
  * @type {string}
907
907
  * @memberof UserGroupApiListUserGroups
908
908
  */
909
909
  readonly filter?: string
910
910
 
911
911
  /**
912
- * To search the list by any field, pass search=xxx to fetch the result.
912
+ * Free-text search over searchable columns.
913
913
  * @type {string}
914
914
  * @memberof UserGroupApiListUserGroups
915
915
  */
916
916
  readonly search?: string
917
917
 
918
918
  /**
919
- * 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.
919
+ * Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
920
920
  * @type {string}
921
921
  * @memberof UserGroupApiListUserGroups
922
922
  */
@@ -65,12 +65,12 @@ export declare const UserGroupApiAxiosParamCreator: (configuration?: Configurati
65
65
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
66
66
  * @param {string} code
67
67
  * @param {string} [authorization] Bearer Token
68
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
69
- * @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.
70
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
68
+ * @param {number} [pageSize] Number of items per page.
69
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
70
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
71
71
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
72
- * @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.
73
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
72
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
73
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
74
74
  * @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.
75
75
  * @param {*} [options] Override http request option.
76
76
  * @throws {RequiredError}
@@ -79,11 +79,11 @@ export declare const UserGroupApiAxiosParamCreator: (configuration?: Configurati
79
79
  /**
80
80
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
81
81
  * @param {string} [authorization] Bearer Token
82
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
83
- * @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.
84
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
85
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
86
- * @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.
82
+ * @param {number} [pageSize] Number of items per page.
83
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
84
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
85
+ * @param {string} [search] Free-text search over searchable columns.
86
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
87
87
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
88
88
  * @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.
89
89
  * @param {*} [options] Override http request option.
@@ -151,12 +151,12 @@ export declare const UserGroupApiFp: (configuration?: Configuration) => {
151
151
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
152
152
  * @param {string} code
153
153
  * @param {string} [authorization] Bearer Token
154
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
155
- * @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.
156
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
154
+ * @param {number} [pageSize] Number of items per page.
155
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
156
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
157
157
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
158
- * @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.
159
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
158
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
159
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
160
160
  * @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.
161
161
  * @param {*} [options] Override http request option.
162
162
  * @throws {RequiredError}
@@ -165,11 +165,11 @@ export declare const UserGroupApiFp: (configuration?: Configuration) => {
165
165
  /**
166
166
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
167
167
  * @param {string} [authorization] Bearer Token
168
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
169
- * @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.
170
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
171
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
172
- * @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.
168
+ * @param {number} [pageSize] Number of items per page.
169
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
170
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
171
+ * @param {string} [search] Free-text search over searchable columns.
172
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
173
173
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
174
174
  * @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.
175
175
  * @param {*} [options] Override http request option.
@@ -237,12 +237,12 @@ export declare const UserGroupApiFactory: (configuration?: Configuration, basePa
237
237
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
238
238
  * @param {string} code
239
239
  * @param {string} [authorization] Bearer Token
240
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
241
- * @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.
242
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
240
+ * @param {number} [pageSize] Number of items per page.
241
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
242
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
243
243
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
244
- * @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.
245
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
244
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
245
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
246
246
  * @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.
247
247
  * @param {*} [options] Override http request option.
248
248
  * @throws {RequiredError}
@@ -251,11 +251,11 @@ export declare const UserGroupApiFactory: (configuration?: Configuration, basePa
251
251
  /**
252
252
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
253
253
  * @param {string} [authorization] Bearer Token
254
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
255
- * @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.
256
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
257
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
258
- * @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.
254
+ * @param {number} [pageSize] Number of items per page.
255
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
256
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
257
+ * @param {string} [search] Free-text search over searchable columns.
258
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
259
259
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
260
260
  * @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.
261
261
  * @param {*} [options] Override http request option.
@@ -382,19 +382,19 @@ export interface UserGroupApiListUserGroupMembersRequest {
382
382
  */
383
383
  readonly authorization?: string;
384
384
  /**
385
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
385
+ * Number of items per page.
386
386
  * @type {number}
387
387
  * @memberof UserGroupApiListUserGroupMembers
388
388
  */
389
389
  readonly pageSize?: number;
390
390
  /**
391
- * 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.
391
+ * Opaque token for the next page (returned in a previous response).
392
392
  * @type {string}
393
393
  * @memberof UserGroupApiListUserGroupMembers
394
394
  */
395
395
  readonly pageToken?: string;
396
396
  /**
397
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
397
+ * Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
398
398
  * @type {string}
399
399
  * @memberof UserGroupApiListUserGroupMembers
400
400
  */
@@ -406,13 +406,13 @@ export interface UserGroupApiListUserGroupMembersRequest {
406
406
  */
407
407
  readonly search?: string;
408
408
  /**
409
- * 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.
409
+ * Sort the response by allowed columns (see paginate config).
410
410
  * @type {string}
411
411
  * @memberof UserGroupApiListUserGroupMembers
412
412
  */
413
413
  readonly order?: string;
414
414
  /**
415
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
415
+ * Comma-separated list of related objects to embed in each member (e.g. user details).
416
416
  * @type {string}
417
417
  * @memberof UserGroupApiListUserGroupMembers
418
418
  */
@@ -437,31 +437,31 @@ export interface UserGroupApiListUserGroupsRequest {
437
437
  */
438
438
  readonly authorization?: string;
439
439
  /**
440
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
440
+ * Number of items per page.
441
441
  * @type {number}
442
442
  * @memberof UserGroupApiListUserGroups
443
443
  */
444
444
  readonly pageSize?: number;
445
445
  /**
446
- * 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.
446
+ * Opaque token for the next page (returned in a previous response).
447
447
  * @type {string}
448
448
  * @memberof UserGroupApiListUserGroups
449
449
  */
450
450
  readonly pageToken?: string;
451
451
  /**
452
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
452
+ * Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
453
453
  * @type {string}
454
454
  * @memberof UserGroupApiListUserGroups
455
455
  */
456
456
  readonly filter?: string;
457
457
  /**
458
- * To search the list by any field, pass search=xxx to fetch the result.
458
+ * Free-text search over searchable columns.
459
459
  * @type {string}
460
460
  * @memberof UserGroupApiListUserGroups
461
461
  */
462
462
  readonly search?: string;
463
463
  /**
464
- * 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.
464
+ * Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
465
465
  * @type {string}
466
466
  * @memberof UserGroupApiListUserGroups
467
467
  */
@@ -294,12 +294,12 @@ var UserGroupApiAxiosParamCreator = function (configuration) {
294
294
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
295
295
  * @param {string} code
296
296
  * @param {string} [authorization] Bearer Token
297
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
298
- * @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.
299
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
297
+ * @param {number} [pageSize] Number of items per page.
298
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
299
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
300
300
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
301
- * @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.
302
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
301
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
302
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
303
303
  * @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.
304
304
  * @param {*} [options] Override http request option.
305
305
  * @throws {RequiredError}
@@ -368,11 +368,11 @@ var UserGroupApiAxiosParamCreator = function (configuration) {
368
368
  /**
369
369
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
370
370
  * @param {string} [authorization] Bearer Token
371
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
372
- * @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.
373
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
374
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
375
- * @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.
371
+ * @param {number} [pageSize] Number of items per page.
372
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
373
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
374
+ * @param {string} [search] Free-text search over searchable columns.
375
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
376
376
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
377
377
  * @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.
378
378
  * @param {*} [options] Override http request option.
@@ -635,12 +635,12 @@ var UserGroupApiFp = function (configuration) {
635
635
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
636
636
  * @param {string} code
637
637
  * @param {string} [authorization] Bearer Token
638
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
639
- * @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.
640
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
638
+ * @param {number} [pageSize] Number of items per page.
639
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
640
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
641
641
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
642
- * @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.
643
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
642
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
643
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
644
644
  * @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.
645
645
  * @param {*} [options] Override http request option.
646
646
  * @throws {RequiredError}
@@ -661,11 +661,11 @@ var UserGroupApiFp = function (configuration) {
661
661
  /**
662
662
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
663
663
  * @param {string} [authorization] Bearer Token
664
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
665
- * @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.
666
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
667
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
668
- * @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.
664
+ * @param {number} [pageSize] Number of items per page.
665
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
666
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
667
+ * @param {string} [search] Free-text search over searchable columns.
668
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
669
669
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
670
670
  * @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.
671
671
  * @param {*} [options] Override http request option.
@@ -781,12 +781,12 @@ var UserGroupApiFactory = function (configuration, basePath, axios) {
781
781
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
782
782
  * @param {string} code
783
783
  * @param {string} [authorization] Bearer Token
784
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
785
- * @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.
786
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
784
+ * @param {number} [pageSize] Number of items per page.
785
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
786
+ * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
787
787
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
788
- * @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.
789
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
788
+ * @param {string} [order] Sort the response by allowed columns (see paginate config).
789
+ * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
790
790
  * @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.
791
791
  * @param {*} [options] Override http request option.
792
792
  * @throws {RequiredError}
@@ -797,11 +797,11 @@ var UserGroupApiFactory = function (configuration, basePath, axios) {
797
797
  /**
798
798
  * undefined **Required Permissions** \"identity-management.user-groups.view\"
799
799
  * @param {string} [authorization] Bearer Token
800
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
801
- * @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.
802
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
803
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
804
- * @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.
800
+ * @param {number} [pageSize] Number of items per page.
801
+ * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
802
+ * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
803
+ * @param {string} [search] Free-text search over searchable columns.
804
+ * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
805
805
  * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
806
806
  * @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.
807
807
  * @param {*} [options] Override http request option.
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CreateUserGroupRequestDto {
18
18
  /**
19
- * Human-readable, renameable identifier for the user group. Unique per tenant.
19
+ * Human-readable, renameable identifier for the user group. Unique per tenant. Must match /^[a-z0-9-]+$/.
20
20
  * @type {string}
21
21
  * @memberof CreateUserGroupRequestDto
22
22
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface UpdateUserGroupRequestDto {
18
18
  /**
19
- * New slug. Slug remains unique per tenant.
19
+ * New slug. Slug remains unique per tenant. Must match /^[a-z0-9-]+$/.
20
20
  * @type {string}
21
21
  * @memberof UpdateUserGroupRequestDto
22
22
  */
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface CreateUserGroupRequestDto {
23
23
  /**
24
- * Human-readable, renameable identifier for the user group. Unique per tenant.
24
+ * Human-readable, renameable identifier for the user group. Unique per tenant. Must match /^[a-z0-9-]+$/.
25
25
  * @type {string}
26
26
  * @memberof CreateUserGroupRequestDto
27
27
  */
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface UpdateUserGroupRequestDto {
23
23
  /**
24
- * New slug. Slug remains unique per tenant.
24
+ * New slug. Slug remains unique per tenant. Must match /^[a-z0-9-]+$/.
25
25
  * @type {string}
26
26
  * @memberof UpdateUserGroupRequestDto
27
27
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/tenant-sdk-node",
3
- "version": "1.34.1-beta.17",
3
+ "version": "1.34.1-beta.20",
4
4
  "description": "OpenAPI client for @emilgroup/tenant-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -18,7 +18,7 @@
18
18
  "prepare": "npm run build"
19
19
  },
20
20
  "dependencies": {
21
- "axios": "1.12.0",
21
+ "axios": "1.18.0",
22
22
  "form-data": "^4.0.0",
23
23
  "url": "^0.11.0"
24
24
  },