@emilgroup/tenant-sdk-node 1.28.1-beta.0 → 1.28.1-beta.2
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 +2 -2
- package/api/custom-schema-api.ts +40 -40
- package/api/dashboard-api.ts +184 -87
- package/api/dashboard-group-api.ts +40 -40
- package/api/data-report-api.ts +40 -40
- package/api/invite-users-api.ts +19 -19
- package/api/list-organization-invitations-api.ts +40 -40
- package/api/organizations-api.ts +40 -40
- package/api/users-api.ts +19 -19
- package/dist/api/custom-schema-api.d.ts +40 -40
- package/dist/api/custom-schema-api.js +21 -21
- package/dist/api/dashboard-api.d.ts +133 -82
- package/dist/api/dashboard-api.js +151 -63
- package/dist/api/dashboard-group-api.d.ts +40 -40
- package/dist/api/dashboard-group-api.js +21 -21
- package/dist/api/data-report-api.d.ts +40 -40
- package/dist/api/data-report-api.js +21 -21
- package/dist/api/invite-users-api.d.ts +19 -19
- package/dist/api/invite-users-api.js +9 -9
- package/dist/api/list-organization-invitations-api.d.ts +40 -40
- package/dist/api/list-organization-invitations-api.js +21 -21
- package/dist/api/organizations-api.d.ts +40 -40
- package/dist/api/organizations-api.js +21 -21
- package/dist/api/users-api.d.ts +19 -19
- package/dist/api/users-api.js +9 -9
- package/dist/models/list-org-invitations-response-class.d.ts +12 -0
- package/dist/models/list-organizations-response-class.d.ts +12 -0
- package/models/list-org-invitations-response-class.ts +12 -0
- package/models/list-organizations-response-class.ts +12 -0
- package/package.json +1 -1
package/api/organizations-api.ts
CHANGED
|
@@ -87,17 +87,17 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
87
87
|
* This will fetch list of organizations **Required Permissions** \"tenant-management.organizations.view\"
|
|
88
88
|
* @summary List organizations
|
|
89
89
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
90
|
-
* @param {
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
93
|
-
* @param {
|
|
94
|
-
* @param {
|
|
95
|
-
* @param {
|
|
96
|
-
* @param {
|
|
90
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
91
|
+
* @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.
|
|
92
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
93
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
94
|
+
* @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.
|
|
95
|
+
* @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.
|
|
96
|
+
* @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.
|
|
97
97
|
* @param {*} [options] Override http request option.
|
|
98
98
|
* @throws {RequiredError}
|
|
99
99
|
*/
|
|
100
|
-
listOrganizations: async (authorization?: string, pageSize?:
|
|
100
|
+
listOrganizations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
101
|
const localVarPath = `/tenantservice/v1/organizations`;
|
|
102
102
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
103
103
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -236,17 +236,17 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
236
236
|
* This will fetch list of organizations **Required Permissions** \"tenant-management.organizations.view\"
|
|
237
237
|
* @summary List organizations
|
|
238
238
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
239
|
-
* @param {
|
|
240
|
-
* @param {
|
|
241
|
-
* @param {
|
|
242
|
-
* @param {
|
|
243
|
-
* @param {
|
|
244
|
-
* @param {
|
|
245
|
-
* @param {
|
|
239
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
240
|
+
* @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.
|
|
241
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
242
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
243
|
+
* @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.
|
|
244
|
+
* @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.
|
|
245
|
+
* @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.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
248
248
|
*/
|
|
249
|
-
async listOrganizations(authorization?: string, pageSize?:
|
|
249
|
+
async listOrganizations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizationsResponseClass>> {
|
|
250
250
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
251
251
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
252
252
|
},
|
|
@@ -288,17 +288,17 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
288
288
|
* This will fetch list of organizations **Required Permissions** \"tenant-management.organizations.view\"
|
|
289
289
|
* @summary List organizations
|
|
290
290
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
291
|
-
* @param {
|
|
292
|
-
* @param {
|
|
293
|
-
* @param {
|
|
294
|
-
* @param {
|
|
295
|
-
* @param {
|
|
296
|
-
* @param {
|
|
297
|
-
* @param {
|
|
291
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
292
|
+
* @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.
|
|
293
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
294
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
295
|
+
* @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.
|
|
296
|
+
* @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.
|
|
297
|
+
* @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.
|
|
298
298
|
* @param {*} [options] Override http request option.
|
|
299
299
|
* @throws {RequiredError}
|
|
300
300
|
*/
|
|
301
|
-
listOrganizations(authorization?: string, pageSize?:
|
|
301
|
+
listOrganizations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListOrganizationsResponseClass> {
|
|
302
302
|
return localVarFp.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
303
303
|
},
|
|
304
304
|
/**
|
|
@@ -352,52 +352,52 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
352
352
|
|
|
353
353
|
/**
|
|
354
354
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
355
|
-
* @type {
|
|
355
|
+
* @type {number}
|
|
356
356
|
* @memberof OrganizationsApiListOrganizations
|
|
357
357
|
*/
|
|
358
|
-
readonly pageSize?:
|
|
358
|
+
readonly pageSize?: number
|
|
359
359
|
|
|
360
360
|
/**
|
|
361
|
-
* 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,
|
|
362
|
-
* @type {
|
|
361
|
+
* 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.
|
|
362
|
+
* @type {string}
|
|
363
363
|
* @memberof OrganizationsApiListOrganizations
|
|
364
364
|
*/
|
|
365
|
-
readonly pageToken?:
|
|
365
|
+
readonly pageToken?: string
|
|
366
366
|
|
|
367
367
|
/**
|
|
368
368
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
369
|
-
* @type {
|
|
369
|
+
* @type {string}
|
|
370
370
|
* @memberof OrganizationsApiListOrganizations
|
|
371
371
|
*/
|
|
372
|
-
readonly filter?:
|
|
372
|
+
readonly filter?: string
|
|
373
373
|
|
|
374
374
|
/**
|
|
375
375
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
376
|
-
* @type {
|
|
376
|
+
* @type {string}
|
|
377
377
|
* @memberof OrganizationsApiListOrganizations
|
|
378
378
|
*/
|
|
379
|
-
readonly search?:
|
|
379
|
+
readonly search?: string
|
|
380
380
|
|
|
381
381
|
/**
|
|
382
382
|
* 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.
|
|
383
|
-
* @type {
|
|
383
|
+
* @type {string}
|
|
384
384
|
* @memberof OrganizationsApiListOrganizations
|
|
385
385
|
*/
|
|
386
|
-
readonly order?:
|
|
386
|
+
readonly order?: string
|
|
387
387
|
|
|
388
388
|
/**
|
|
389
|
-
* 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
|
|
390
|
-
* @type {
|
|
389
|
+
* 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.
|
|
390
|
+
* @type {string}
|
|
391
391
|
* @memberof OrganizationsApiListOrganizations
|
|
392
392
|
*/
|
|
393
|
-
readonly expand?:
|
|
393
|
+
readonly expand?: string
|
|
394
394
|
|
|
395
395
|
/**
|
|
396
396
|
* 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.
|
|
397
|
-
* @type {
|
|
397
|
+
* @type {string}
|
|
398
398
|
* @memberof OrganizationsApiListOrganizations
|
|
399
399
|
*/
|
|
400
|
-
readonly filters?:
|
|
400
|
+
readonly filters?: string
|
|
401
401
|
}
|
|
402
402
|
|
|
403
403
|
/**
|
package/api/users-api.ts
CHANGED
|
@@ -346,17 +346,17 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
346
346
|
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\"
|
|
347
347
|
* @summary List users
|
|
348
348
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
|
-
* @param {
|
|
350
|
-
* @param {
|
|
349
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
350
|
+
* @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.
|
|
351
351
|
* @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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
352
|
-
* @param {
|
|
352
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
353
353
|
* @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: email</i>
|
|
354
354
|
* @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: subscriptions, organizations<i>
|
|
355
355
|
* @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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
357
357
|
* @throws {RequiredError}
|
|
358
358
|
*/
|
|
359
|
-
listUsers: async (authorization?: string, pageSize?:
|
|
359
|
+
listUsers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
360
360
|
const localVarPath = `/tenantservice/v1/users`;
|
|
361
361
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
362
362
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -502,17 +502,17 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
502
502
|
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\"
|
|
503
503
|
* @summary List users
|
|
504
504
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
505
|
-
* @param {
|
|
506
|
-
* @param {
|
|
505
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
506
|
+
* @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.
|
|
507
507
|
* @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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
508
|
-
* @param {
|
|
508
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
509
509
|
* @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: email</i>
|
|
510
510
|
* @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: subscriptions, organizations<i>
|
|
511
511
|
* @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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
512
512
|
* @param {*} [options] Override http request option.
|
|
513
513
|
* @throws {RequiredError}
|
|
514
514
|
*/
|
|
515
|
-
async listUsers(authorization?: string, pageSize?:
|
|
515
|
+
async listUsers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>> {
|
|
516
516
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
517
517
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
518
518
|
},
|
|
@@ -594,17 +594,17 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
594
594
|
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\"
|
|
595
595
|
* @summary List users
|
|
596
596
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
597
|
-
* @param {
|
|
598
|
-
* @param {
|
|
597
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
598
|
+
* @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.
|
|
599
599
|
* @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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
600
|
-
* @param {
|
|
600
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
601
601
|
* @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: email</i>
|
|
602
602
|
* @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: subscriptions, organizations<i>
|
|
603
603
|
* @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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
604
604
|
* @param {*} [options] Override http request option.
|
|
605
605
|
* @throws {RequiredError}
|
|
606
606
|
*/
|
|
607
|
-
listUsers(authorization?: string, pageSize?:
|
|
607
|
+
listUsers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListUsersResponseClass> {
|
|
608
608
|
return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
609
609
|
},
|
|
610
610
|
};
|
|
@@ -772,17 +772,17 @@ export interface UsersApiListUsersRequest {
|
|
|
772
772
|
|
|
773
773
|
/**
|
|
774
774
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
775
|
-
* @type {
|
|
775
|
+
* @type {number}
|
|
776
776
|
* @memberof UsersApiListUsers
|
|
777
777
|
*/
|
|
778
|
-
readonly pageSize?:
|
|
778
|
+
readonly pageSize?: number
|
|
779
779
|
|
|
780
780
|
/**
|
|
781
|
-
* 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,
|
|
782
|
-
* @type {
|
|
781
|
+
* 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.
|
|
782
|
+
* @type {string}
|
|
783
783
|
* @memberof UsersApiListUsers
|
|
784
784
|
*/
|
|
785
|
-
readonly pageToken?:
|
|
785
|
+
readonly pageToken?: string
|
|
786
786
|
|
|
787
787
|
/**
|
|
788
788
|
* 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, email, sub, status, organizationId, ern, partnerCode</i>
|
|
@@ -793,10 +793,10 @@ export interface UsersApiListUsersRequest {
|
|
|
793
793
|
|
|
794
794
|
/**
|
|
795
795
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
796
|
-
* @type {
|
|
796
|
+
* @type {string}
|
|
797
797
|
* @memberof UsersApiListUsers
|
|
798
798
|
*/
|
|
799
|
-
readonly search?:
|
|
799
|
+
readonly search?: string
|
|
800
800
|
|
|
801
801
|
/**
|
|
802
802
|
* 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: email</i>
|
|
@@ -46,17 +46,17 @@ export declare const CustomSchemaApiAxiosParamCreator: (configuration?: Configur
|
|
|
46
46
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
47
47
|
* @summary List custom-schemas
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
|
-
* @param {
|
|
50
|
-
* @param {
|
|
51
|
-
* @param {
|
|
52
|
-
* @param {
|
|
53
|
-
* @param {
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {
|
|
49
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
|
+
* @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.
|
|
51
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
52
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
53
|
+
* @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.
|
|
54
|
+
* @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.
|
|
55
|
+
* @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.
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
58
58
|
*/
|
|
59
|
-
listCustomSchemas: (authorization?: string, pageSize?:
|
|
59
|
+
listCustomSchemas: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
61
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
|
|
62
62
|
* @summary Update the custom-schema
|
|
@@ -96,17 +96,17 @@ export declare const CustomSchemaApiFp: (configuration?: Configuration) => {
|
|
|
96
96
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
97
97
|
* @summary List custom-schemas
|
|
98
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
-
* @param {
|
|
100
|
-
* @param {
|
|
101
|
-
* @param {
|
|
102
|
-
* @param {
|
|
103
|
-
* @param {
|
|
104
|
-
* @param {
|
|
105
|
-
* @param {
|
|
99
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
|
+
* @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.
|
|
101
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
102
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
103
|
+
* @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.
|
|
104
|
+
* @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.
|
|
105
|
+
* @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.
|
|
106
106
|
* @param {*} [options] Override http request option.
|
|
107
107
|
* @throws {RequiredError}
|
|
108
108
|
*/
|
|
109
|
-
listCustomSchemas(authorization?: string, pageSize?:
|
|
109
|
+
listCustomSchemas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>>;
|
|
110
110
|
/**
|
|
111
111
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
|
|
112
112
|
* @summary Update the custom-schema
|
|
@@ -146,17 +146,17 @@ export declare const CustomSchemaApiFactory: (configuration?: Configuration, bas
|
|
|
146
146
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
147
147
|
* @summary List custom-schemas
|
|
148
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {
|
|
151
|
-
* @param {
|
|
152
|
-
* @param {
|
|
153
|
-
* @param {
|
|
154
|
-
* @param {
|
|
155
|
-
* @param {
|
|
149
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
150
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
151
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
152
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
153
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
154
|
+
* @param {string} [expand] 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.
|
|
155
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
158
158
|
*/
|
|
159
|
-
listCustomSchemas(authorization?: string, pageSize?:
|
|
159
|
+
listCustomSchemas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCustomSchemasResponseClass>;
|
|
160
160
|
/**
|
|
161
161
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
|
|
162
162
|
* @summary Update the custom-schema
|
|
@@ -226,46 +226,46 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
226
226
|
readonly authorization?: string;
|
|
227
227
|
/**
|
|
228
228
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
229
|
-
* @type {
|
|
229
|
+
* @type {number}
|
|
230
230
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
231
231
|
*/
|
|
232
|
-
readonly pageSize?:
|
|
232
|
+
readonly pageSize?: number;
|
|
233
233
|
/**
|
|
234
|
-
* 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,
|
|
235
|
-
* @type {
|
|
234
|
+
* 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.
|
|
235
|
+
* @type {string}
|
|
236
236
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
237
237
|
*/
|
|
238
|
-
readonly pageToken?:
|
|
238
|
+
readonly pageToken?: string;
|
|
239
239
|
/**
|
|
240
240
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
241
|
-
* @type {
|
|
241
|
+
* @type {string}
|
|
242
242
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
243
243
|
*/
|
|
244
|
-
readonly filter?:
|
|
244
|
+
readonly filter?: string;
|
|
245
245
|
/**
|
|
246
246
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
247
|
-
* @type {
|
|
247
|
+
* @type {string}
|
|
248
248
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
249
249
|
*/
|
|
250
|
-
readonly search?:
|
|
250
|
+
readonly search?: string;
|
|
251
251
|
/**
|
|
252
252
|
* 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.
|
|
253
|
-
* @type {
|
|
253
|
+
* @type {string}
|
|
254
254
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
255
255
|
*/
|
|
256
|
-
readonly order?:
|
|
256
|
+
readonly order?: string;
|
|
257
257
|
/**
|
|
258
|
-
* 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
|
|
259
|
-
* @type {
|
|
258
|
+
* 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.
|
|
259
|
+
* @type {string}
|
|
260
260
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
261
261
|
*/
|
|
262
|
-
readonly expand?:
|
|
262
|
+
readonly expand?: string;
|
|
263
263
|
/**
|
|
264
264
|
* 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.
|
|
265
|
-
* @type {
|
|
265
|
+
* @type {string}
|
|
266
266
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
267
267
|
*/
|
|
268
|
-
readonly filters?:
|
|
268
|
+
readonly filters?: string;
|
|
269
269
|
}
|
|
270
270
|
/**
|
|
271
271
|
* Request parameters for updateCustomSchema operation in CustomSchemaApi.
|
|
@@ -201,13 +201,13 @@ var CustomSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
201
201
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
202
202
|
* @summary List custom-schemas
|
|
203
203
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
204
|
-
* @param {
|
|
205
|
-
* @param {
|
|
206
|
-
* @param {
|
|
207
|
-
* @param {
|
|
208
|
-
* @param {
|
|
209
|
-
* @param {
|
|
210
|
-
* @param {
|
|
204
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
205
|
+
* @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.
|
|
206
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
207
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
208
|
+
* @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.
|
|
209
|
+
* @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.
|
|
210
|
+
* @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.
|
|
211
211
|
* @param {*} [options] Override http request option.
|
|
212
212
|
* @throws {RequiredError}
|
|
213
213
|
*/
|
|
@@ -379,13 +379,13 @@ var CustomSchemaApiFp = function (configuration) {
|
|
|
379
379
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
380
380
|
* @summary List custom-schemas
|
|
381
381
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
382
|
-
* @param {
|
|
383
|
-
* @param {
|
|
384
|
-
* @param {
|
|
385
|
-
* @param {
|
|
386
|
-
* @param {
|
|
387
|
-
* @param {
|
|
388
|
-
* @param {
|
|
382
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
383
|
+
* @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.
|
|
384
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
385
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
386
|
+
* @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.
|
|
387
|
+
* @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.
|
|
388
|
+
* @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.
|
|
389
389
|
* @param {*} [options] Override http request option.
|
|
390
390
|
* @throws {RequiredError}
|
|
391
391
|
*/
|
|
@@ -461,13 +461,13 @@ var CustomSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
461
461
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
462
462
|
* @summary List custom-schemas
|
|
463
463
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
464
|
-
* @param {
|
|
465
|
-
* @param {
|
|
466
|
-
* @param {
|
|
467
|
-
* @param {
|
|
468
|
-
* @param {
|
|
469
|
-
* @param {
|
|
470
|
-
* @param {
|
|
464
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
465
|
+
* @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.
|
|
466
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
467
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
468
|
+
* @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.
|
|
469
|
+
* @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.
|
|
470
|
+
* @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.
|
|
471
471
|
* @param {*} [options] Override http request option.
|
|
472
472
|
* @throws {RequiredError}
|
|
473
473
|
*/
|