@emilgroup/tenant-sdk-node 1.33.1-beta.8 → 1.34.1-beta.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +5 -0
- package/README.md +2 -2
- package/api/invitation-controller-rest-api.ts +561 -0
- package/api/invite-users-api.ts +12 -12
- package/api/settings-api.ts +304 -0
- package/api/user-controller-rest-api.ts +1413 -0
- package/api/users-api.ts +12 -12
- package/api.ts +4 -0
- package/base.ts +1 -0
- package/dist/api/invitation-controller-rest-api.d.ts +315 -0
- package/dist/api/invitation-controller-rest-api.js +538 -0
- package/dist/api/invite-users-api.d.ts +12 -12
- package/dist/api/invite-users-api.js +10 -10
- package/dist/api/settings-api.d.ts +156 -0
- package/dist/api/settings-api.js +268 -0
- package/dist/api/user-controller-rest-api.d.ts +777 -0
- package/dist/api/user-controller-rest-api.js +1227 -0
- package/dist/api/users-api.d.ts +12 -12
- package/dist/api/users-api.js +10 -10
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/get-settings-response-class.d.ts +5 -3
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/set-setting-grpc-request-dto.d.ts +42 -0
- package/dist/models/set-setting-grpc-request-dto.js +15 -0
- package/dist/models/set-setting-request-dto.d.ts +6 -6
- package/dist/models/set-tenant-setting-response-class.d.ts +36 -0
- package/dist/models/set-tenant-setting-response-class.js +15 -0
- package/dist/models/set-user-setting-response-class.d.ts +36 -0
- package/dist/models/set-user-setting-response-class.js +15 -0
- package/dist/models/tenant-settings-class.d.ts +6 -0
- package/models/get-settings-response-class.ts +3 -3
- package/models/index.ts +3 -0
- package/models/set-setting-grpc-request-dto.ts +48 -0
- package/models/set-setting-request-dto.ts +6 -6
- package/models/set-tenant-setting-response-class.ts +42 -0
- package/models/set-user-setting-response-class.ts +42 -0
- package/models/tenant-settings-class.ts +6 -0
- package/package.json +2 -2
package/api/users-api.ts
CHANGED
|
@@ -343,16 +343,16 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
343
343
|
};
|
|
344
344
|
},
|
|
345
345
|
/**
|
|
346
|
-
* Returns a list of users you have previously created.
|
|
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
349
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
350
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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
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: id, email, firstName, lastName</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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
|
*/
|
|
@@ -499,16 +499,16 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
499
499
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
500
500
|
},
|
|
501
501
|
/**
|
|
502
|
-
* Returns a list of users you have previously created.
|
|
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
505
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
506
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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
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: id, email, firstName, lastName</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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
|
*/
|
|
@@ -591,16 +591,16 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
591
591
|
return localVarFp.linkUserWithPartner(code, linkUserWithPartnerRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
592
592
|
},
|
|
593
593
|
/**
|
|
594
|
-
* Returns a list of users you have previously created.
|
|
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
597
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
598
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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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
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: id, email, firstName, lastName</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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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
|
*/
|
|
@@ -785,7 +785,7 @@ export interface UsersApiListUsersRequest {
|
|
|
785
785
|
readonly pageToken?: string
|
|
786
786
|
|
|
787
787
|
/**
|
|
788
|
-
* Filter the response by one or multiple fields.
|
|
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>
|
|
789
789
|
* @type {string}
|
|
790
790
|
* @memberof UsersApiListUsers
|
|
791
791
|
*/
|
|
@@ -813,7 +813,7 @@ export interface UsersApiListUsersRequest {
|
|
|
813
813
|
readonly expand?: string
|
|
814
814
|
|
|
815
815
|
/**
|
|
816
|
-
* Filters the response by one or multiple fields.
|
|
816
|
+
* 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>
|
|
817
817
|
* @type {string}
|
|
818
818
|
* @memberof UsersApiListUsers
|
|
819
819
|
*/
|
|
@@ -895,7 +895,7 @@ export class UsersApi extends BaseAPI {
|
|
|
895
895
|
}
|
|
896
896
|
|
|
897
897
|
/**
|
|
898
|
-
* Returns a list of users you have previously created.
|
|
898
|
+
* 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\"
|
|
899
899
|
* @summary List users
|
|
900
900
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
901
901
|
* @param {*} [options] Override http request option.
|
package/api.ts
CHANGED
|
@@ -31,6 +31,7 @@ import { DataReportApi } from './api';
|
|
|
31
31
|
import { DataReportExecutorApi } from './api';
|
|
32
32
|
import { DeleteOrganizationInvitationsApi } from './api';
|
|
33
33
|
import { HealthCheckApi } from './api';
|
|
34
|
+
import { InvitationControllerRestApi } from './api';
|
|
34
35
|
import { InviteOrganizationsApi } from './api';
|
|
35
36
|
import { InviteUsersApi } from './api';
|
|
36
37
|
import { ListOrganizationInvitationsApi } from './api';
|
|
@@ -39,6 +40,7 @@ import { OrganizationsApi } from './api';
|
|
|
39
40
|
import { ReInviteAnOrganizationApi } from './api';
|
|
40
41
|
import { RolesApi } from './api';
|
|
41
42
|
import { SettingsApi } from './api';
|
|
43
|
+
import { UserControllerRestApi } from './api';
|
|
42
44
|
import { UsersApi } from './api';
|
|
43
45
|
|
|
44
46
|
|
|
@@ -49,6 +51,7 @@ export * from './api/data-report-api';
|
|
|
49
51
|
export * from './api/data-report-executor-api';
|
|
50
52
|
export * from './api/delete-organization-invitations-api';
|
|
51
53
|
export * from './api/health-check-api';
|
|
54
|
+
export * from './api/invitation-controller-rest-api';
|
|
52
55
|
export * from './api/invite-organizations-api';
|
|
53
56
|
export * from './api/invite-users-api';
|
|
54
57
|
export * from './api/list-organization-invitations-api';
|
|
@@ -57,5 +60,6 @@ export * from './api/organizations-api';
|
|
|
57
60
|
export * from './api/re-invite-an-organization-api';
|
|
58
61
|
export * from './api/roles-api';
|
|
59
62
|
export * from './api/settings-api';
|
|
63
|
+
export * from './api/user-controller-rest-api';
|
|
60
64
|
export * from './api/users-api';
|
|
61
65
|
|
package/base.ts
CHANGED
|
@@ -60,6 +60,7 @@ export enum Environment {
|
|
|
60
60
|
Staging = 'https://apiv2-staging.emil.de',
|
|
61
61
|
Development = 'https://apiv2-dev.emil.de',
|
|
62
62
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
63
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
63
64
|
}
|
|
64
65
|
|
|
65
66
|
let _retry_count = 0
|
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL Tenant Service
|
|
3
|
+
* The EMIL TenantService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { DeleteResponseClass } from '../models';
|
|
16
|
+
import { InviteOrgRequestDtoRest } from '../models';
|
|
17
|
+
import { ListOrgInvitationsResponseClass } from '../models';
|
|
18
|
+
import { OrgInvitationResponseClass } from '../models';
|
|
19
|
+
import { ReInviteOrgRequestDto } from '../models';
|
|
20
|
+
/**
|
|
21
|
+
* InvitationControllerRestApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export declare const InvitationControllerRestApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
27
|
+
* @summary Delete the organization invitation
|
|
28
|
+
* @param {number} id
|
|
29
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
30
|
+
* @param {*} [options] Override http request option.
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
deleteOrgInvitation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
+
/**
|
|
35
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
36
|
+
* @summary Invite an organization
|
|
37
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
38
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
inviteOrg: (inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
|
+
/**
|
|
44
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.organizations.view\"
|
|
45
|
+
* @summary List organization invitations
|
|
46
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
47
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
48
|
+
* @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.
|
|
49
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
50
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
51
|
+
* @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.
|
|
52
|
+
* @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.
|
|
53
|
+
* @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.
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
listOrgInvitations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
60
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
61
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
reInviteOrganization: (reInviteOrgRequestDto: ReInviteOrgRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* InvitationControllerRestApi - functional programming interface
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export declare const InvitationControllerRestApiFp: (configuration?: Configuration) => {
|
|
72
|
+
/**
|
|
73
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
74
|
+
* @summary Delete the organization invitation
|
|
75
|
+
* @param {number} id
|
|
76
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
deleteOrgInvitation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
81
|
+
/**
|
|
82
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
83
|
+
* @summary Invite an organization
|
|
84
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
85
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
inviteOrg(inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgInvitationResponseClass>>;
|
|
90
|
+
/**
|
|
91
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.organizations.view\"
|
|
92
|
+
* @summary List organization invitations
|
|
93
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
94
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
97
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
98
|
+
* @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.
|
|
99
|
+
* @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.
|
|
100
|
+
* @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.
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
listOrgInvitations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>>;
|
|
105
|
+
/**
|
|
106
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
107
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
reInviteOrganization(reInviteOrgRequestDto: ReInviteOrgRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgInvitationResponseClass>>;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* InvitationControllerRestApi - factory interface
|
|
116
|
+
* @export
|
|
117
|
+
*/
|
|
118
|
+
export declare const InvitationControllerRestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
119
|
+
/**
|
|
120
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
121
|
+
* @summary Delete the organization invitation
|
|
122
|
+
* @param {number} id
|
|
123
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
deleteOrgInvitation(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
128
|
+
/**
|
|
129
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
130
|
+
* @summary Invite an organization
|
|
131
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
132
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
inviteOrg(inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: any): AxiosPromise<OrgInvitationResponseClass>;
|
|
137
|
+
/**
|
|
138
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.organizations.view\"
|
|
139
|
+
* @summary List organization invitations
|
|
140
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
142
|
+
* @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.
|
|
143
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
144
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
145
|
+
* @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.
|
|
146
|
+
* @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.
|
|
147
|
+
* @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.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
listOrgInvitations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListOrgInvitationsResponseClass>;
|
|
152
|
+
/**
|
|
153
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
154
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
155
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
reInviteOrganization(reInviteOrgRequestDto: ReInviteOrgRequestDto, authorization?: string, options?: any): AxiosPromise<OrgInvitationResponseClass>;
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* Request parameters for deleteOrgInvitation operation in InvitationControllerRestApi.
|
|
163
|
+
* @export
|
|
164
|
+
* @interface InvitationControllerRestApiDeleteOrgInvitationRequest
|
|
165
|
+
*/
|
|
166
|
+
export interface InvitationControllerRestApiDeleteOrgInvitationRequest {
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {number}
|
|
170
|
+
* @memberof InvitationControllerRestApiDeleteOrgInvitation
|
|
171
|
+
*/
|
|
172
|
+
readonly id: number;
|
|
173
|
+
/**
|
|
174
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof InvitationControllerRestApiDeleteOrgInvitation
|
|
177
|
+
*/
|
|
178
|
+
readonly authorization?: string;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Request parameters for inviteOrg operation in InvitationControllerRestApi.
|
|
182
|
+
* @export
|
|
183
|
+
* @interface InvitationControllerRestApiInviteOrgRequest
|
|
184
|
+
*/
|
|
185
|
+
export interface InvitationControllerRestApiInviteOrgRequest {
|
|
186
|
+
/**
|
|
187
|
+
*
|
|
188
|
+
* @type {InviteOrgRequestDtoRest}
|
|
189
|
+
* @memberof InvitationControllerRestApiInviteOrg
|
|
190
|
+
*/
|
|
191
|
+
readonly inviteOrgRequestDtoRest: InviteOrgRequestDtoRest;
|
|
192
|
+
/**
|
|
193
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
|
+
* @type {string}
|
|
195
|
+
* @memberof InvitationControllerRestApiInviteOrg
|
|
196
|
+
*/
|
|
197
|
+
readonly authorization?: string;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Request parameters for listOrgInvitations operation in InvitationControllerRestApi.
|
|
201
|
+
* @export
|
|
202
|
+
* @interface InvitationControllerRestApiListOrgInvitationsRequest
|
|
203
|
+
*/
|
|
204
|
+
export interface InvitationControllerRestApiListOrgInvitationsRequest {
|
|
205
|
+
/**
|
|
206
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
209
|
+
*/
|
|
210
|
+
readonly authorization?: string;
|
|
211
|
+
/**
|
|
212
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
213
|
+
* @type {number}
|
|
214
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
215
|
+
*/
|
|
216
|
+
readonly pageSize?: number;
|
|
217
|
+
/**
|
|
218
|
+
* 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.
|
|
219
|
+
* @type {string}
|
|
220
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
221
|
+
*/
|
|
222
|
+
readonly pageToken?: string;
|
|
223
|
+
/**
|
|
224
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
227
|
+
*/
|
|
228
|
+
readonly filter?: string;
|
|
229
|
+
/**
|
|
230
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
233
|
+
*/
|
|
234
|
+
readonly search?: string;
|
|
235
|
+
/**
|
|
236
|
+
* 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.
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
239
|
+
*/
|
|
240
|
+
readonly order?: string;
|
|
241
|
+
/**
|
|
242
|
+
* 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.
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
245
|
+
*/
|
|
246
|
+
readonly expand?: string;
|
|
247
|
+
/**
|
|
248
|
+
* 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.
|
|
249
|
+
* @type {string}
|
|
250
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
251
|
+
*/
|
|
252
|
+
readonly filters?: string;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* Request parameters for reInviteOrganization operation in InvitationControllerRestApi.
|
|
256
|
+
* @export
|
|
257
|
+
* @interface InvitationControllerRestApiReInviteOrganizationRequest
|
|
258
|
+
*/
|
|
259
|
+
export interface InvitationControllerRestApiReInviteOrganizationRequest {
|
|
260
|
+
/**
|
|
261
|
+
*
|
|
262
|
+
* @type {ReInviteOrgRequestDto}
|
|
263
|
+
* @memberof InvitationControllerRestApiReInviteOrganization
|
|
264
|
+
*/
|
|
265
|
+
readonly reInviteOrgRequestDto: ReInviteOrgRequestDto;
|
|
266
|
+
/**
|
|
267
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
268
|
+
* @type {string}
|
|
269
|
+
* @memberof InvitationControllerRestApiReInviteOrganization
|
|
270
|
+
*/
|
|
271
|
+
readonly authorization?: string;
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* InvitationControllerRestApi - object-oriented interface
|
|
275
|
+
* @export
|
|
276
|
+
* @class InvitationControllerRestApi
|
|
277
|
+
* @extends {BaseAPI}
|
|
278
|
+
*/
|
|
279
|
+
export declare class InvitationControllerRestApi extends BaseAPI {
|
|
280
|
+
/**
|
|
281
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
282
|
+
* @summary Delete the organization invitation
|
|
283
|
+
* @param {InvitationControllerRestApiDeleteOrgInvitationRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
* @memberof InvitationControllerRestApi
|
|
287
|
+
*/
|
|
288
|
+
deleteOrgInvitation(requestParameters: InvitationControllerRestApiDeleteOrgInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
|
|
289
|
+
/**
|
|
290
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
291
|
+
* @summary Invite an organization
|
|
292
|
+
* @param {InvitationControllerRestApiInviteOrgRequest} requestParameters Request parameters.
|
|
293
|
+
* @param {*} [options] Override http request option.
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
* @memberof InvitationControllerRestApi
|
|
296
|
+
*/
|
|
297
|
+
inviteOrg(requestParameters: InvitationControllerRestApiInviteOrgRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgInvitationResponseClass, any, {}>>;
|
|
298
|
+
/**
|
|
299
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.organizations.view\"
|
|
300
|
+
* @summary List organization invitations
|
|
301
|
+
* @param {InvitationControllerRestApiListOrgInvitationsRequest} requestParameters Request parameters.
|
|
302
|
+
* @param {*} [options] Override http request option.
|
|
303
|
+
* @throws {RequiredError}
|
|
304
|
+
* @memberof InvitationControllerRestApi
|
|
305
|
+
*/
|
|
306
|
+
listOrgInvitations(requestParameters?: InvitationControllerRestApiListOrgInvitationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrgInvitationsResponseClass, any, {}>>;
|
|
307
|
+
/**
|
|
308
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
309
|
+
* @param {InvitationControllerRestApiReInviteOrganizationRequest} requestParameters Request parameters.
|
|
310
|
+
* @param {*} [options] Override http request option.
|
|
311
|
+
* @throws {RequiredError}
|
|
312
|
+
* @memberof InvitationControllerRestApi
|
|
313
|
+
*/
|
|
314
|
+
reInviteOrganization(requestParameters: InvitationControllerRestApiReInviteOrganizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgInvitationResponseClass, any, {}>>;
|
|
315
|
+
}
|