@openshift-migration-advisor/planner-sdk 0.9.0-a26ff9932eeb → 0.10.0-783d8b3a2dc4
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 +18 -0
- package/README.md +27 -11
- package/dist/apis/AccountApi.d.ts +390 -0
- package/dist/apis/AccountApi.js +454 -0
- package/dist/apis/AssessmentApi.d.ts +5 -13
- package/dist/apis/AssessmentApi.js +1 -1
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AccountApi.d.ts +390 -0
- package/dist/esm/apis/AccountApi.js +450 -0
- package/dist/esm/apis/AssessmentApi.d.ts +5 -13
- package/dist/esm/apis/AssessmentApi.js +2 -2
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/Group.d.ts +82 -0
- package/dist/esm/models/Group.js +76 -0
- package/dist/esm/models/GroupCreate.d.ts +64 -0
- package/dist/esm/models/GroupCreate.js +66 -0
- package/dist/esm/models/GroupUpdate.d.ts +50 -0
- package/dist/esm/models/GroupUpdate.js +47 -0
- package/dist/esm/models/Identity.d.ts +60 -0
- package/dist/esm/models/Identity.js +60 -0
- package/dist/esm/models/Member.d.ts +56 -0
- package/dist/esm/models/Member.js +57 -0
- package/dist/esm/models/MemberCreate.d.ts +38 -0
- package/dist/esm/models/MemberCreate.js +47 -0
- package/dist/esm/models/MemberUpdate.d.ts +32 -0
- package/dist/esm/models/MemberUpdate.js +41 -0
- package/dist/esm/models/MigrationEstimationRequest.d.ts +1 -1
- package/dist/esm/models/MigrationEstimationResponse.d.ts +43 -0
- package/dist/esm/models/MigrationEstimationResponse.js +50 -0
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/models/Group.d.ts +82 -0
- package/dist/models/Group.js +84 -0
- package/dist/models/GroupCreate.d.ts +64 -0
- package/dist/models/GroupCreate.js +74 -0
- package/dist/models/GroupUpdate.d.ts +50 -0
- package/dist/models/GroupUpdate.js +54 -0
- package/dist/models/Identity.d.ts +60 -0
- package/dist/models/Identity.js +68 -0
- package/dist/models/Member.d.ts +56 -0
- package/dist/models/Member.js +64 -0
- package/dist/models/MemberCreate.d.ts +38 -0
- package/dist/models/MemberCreate.js +54 -0
- package/dist/models/MemberUpdate.d.ts +32 -0
- package/dist/models/MemberUpdate.js +48 -0
- package/dist/models/MigrationEstimationRequest.d.ts +1 -1
- package/dist/models/MigrationEstimationResponse.d.ts +43 -0
- package/dist/models/MigrationEstimationResponse.js +57 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/docs/AccountApi.md +734 -0
- package/docs/AssessmentApi.md +2 -2
- package/docs/Group.md +48 -0
- package/docs/GroupCreate.md +42 -0
- package/docs/GroupUpdate.md +40 -0
- package/docs/Identity.md +40 -0
- package/docs/Member.md +42 -0
- package/docs/MemberCreate.md +36 -0
- package/docs/MemberUpdate.md +34 -0
- package/docs/MigrationEstimationResponse.md +37 -0
- package/package.json +1 -1
- package/src/apis/AccountApi.ts +834 -0
- package/src/apis/AssessmentApi.ts +8 -8
- package/src/apis/index.ts +1 -0
- package/src/models/Group.ts +139 -0
- package/src/models/GroupCreate.ts +113 -0
- package/src/models/GroupUpdate.ts +89 -0
- package/src/models/Identity.ts +104 -0
- package/src/models/Member.ts +101 -0
- package/src/models/MemberCreate.ts +75 -0
- package/src/models/MemberUpdate.ts +65 -0
- package/src/models/MigrationEstimationRequest.ts +1 -1
- package/src/models/MigrationEstimationResponse.ts +91 -0
- package/src/models/index.ts +8 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
.npmignore
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
|
+
docs/AccountApi.md
|
|
5
6
|
docs/Agent.md
|
|
6
7
|
docs/AgentProxy.md
|
|
7
8
|
docs/Assessment.md
|
|
@@ -19,9 +20,13 @@ docs/DiskSizeTierSummary.md
|
|
|
19
20
|
docs/DiskTypeSummary.md
|
|
20
21
|
docs/EstimationContext.md
|
|
21
22
|
docs/EstimationDetail.md
|
|
23
|
+
docs/Group.md
|
|
24
|
+
docs/GroupCreate.md
|
|
25
|
+
docs/GroupUpdate.md
|
|
22
26
|
docs/HealthApi.md
|
|
23
27
|
docs/Histogram.md
|
|
24
28
|
docs/Host.md
|
|
29
|
+
docs/Identity.md
|
|
25
30
|
docs/ImageApi.md
|
|
26
31
|
docs/Info.md
|
|
27
32
|
docs/InfoApi.md
|
|
@@ -34,10 +39,14 @@ docs/Job.md
|
|
|
34
39
|
docs/JobApi.md
|
|
35
40
|
docs/JobStatus.md
|
|
36
41
|
docs/Label.md
|
|
42
|
+
docs/Member.md
|
|
43
|
+
docs/MemberCreate.md
|
|
44
|
+
docs/MemberUpdate.md
|
|
37
45
|
docs/MigrationComplexityRequest.md
|
|
38
46
|
docs/MigrationComplexityResponse.md
|
|
39
47
|
docs/MigrationEstimationByComplexityResponse.md
|
|
40
48
|
docs/MigrationEstimationRequest.md
|
|
49
|
+
docs/MigrationEstimationResponse.md
|
|
41
50
|
docs/MigrationIssue.md
|
|
42
51
|
docs/ModelError.md
|
|
43
52
|
docs/Network.md
|
|
@@ -61,6 +70,7 @@ docs/VMResourceBreakdown.md
|
|
|
61
70
|
docs/VMs.md
|
|
62
71
|
docs/VmNetwork.md
|
|
63
72
|
package.json
|
|
73
|
+
src/apis/AccountApi.ts
|
|
64
74
|
src/apis/AssessmentApi.ts
|
|
65
75
|
src/apis/HealthApi.ts
|
|
66
76
|
src/apis/ImageApi.ts
|
|
@@ -85,8 +95,12 @@ src/models/DiskSizeTierSummary.ts
|
|
|
85
95
|
src/models/DiskTypeSummary.ts
|
|
86
96
|
src/models/EstimationContext.ts
|
|
87
97
|
src/models/EstimationDetail.ts
|
|
98
|
+
src/models/Group.ts
|
|
99
|
+
src/models/GroupCreate.ts
|
|
100
|
+
src/models/GroupUpdate.ts
|
|
88
101
|
src/models/Histogram.ts
|
|
89
102
|
src/models/Host.ts
|
|
103
|
+
src/models/Identity.ts
|
|
90
104
|
src/models/Info.ts
|
|
91
105
|
src/models/Infra.ts
|
|
92
106
|
src/models/Inventory.ts
|
|
@@ -96,10 +110,14 @@ src/models/Ipv4Config.ts
|
|
|
96
110
|
src/models/Job.ts
|
|
97
111
|
src/models/JobStatus.ts
|
|
98
112
|
src/models/Label.ts
|
|
113
|
+
src/models/Member.ts
|
|
114
|
+
src/models/MemberCreate.ts
|
|
115
|
+
src/models/MemberUpdate.ts
|
|
99
116
|
src/models/MigrationComplexityRequest.ts
|
|
100
117
|
src/models/MigrationComplexityResponse.ts
|
|
101
118
|
src/models/MigrationEstimationByComplexityResponse.ts
|
|
102
119
|
src/models/MigrationEstimationRequest.ts
|
|
120
|
+
src/models/MigrationEstimationResponse.ts
|
|
103
121
|
src/models/MigrationIssue.ts
|
|
104
122
|
src/models/ModelError.ts
|
|
105
123
|
src/models/Network.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @openshift-migration-advisor/planner-sdk@0.
|
|
1
|
+
# @openshift-migration-advisor/planner-sdk@0.10.0-783d8b3a2dc4
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the raw.githubusercontent.com API.
|
|
4
4
|
|
|
@@ -16,23 +16,21 @@ Next, try it out.
|
|
|
16
16
|
```ts
|
|
17
17
|
import {
|
|
18
18
|
Configuration,
|
|
19
|
-
|
|
19
|
+
AccountApi,
|
|
20
20
|
} from '@openshift-migration-advisor/planner-sdk';
|
|
21
|
-
import type {
|
|
21
|
+
import type { CreateGroupRequest } from '@openshift-migration-advisor/planner-sdk';
|
|
22
22
|
|
|
23
23
|
async function example() {
|
|
24
24
|
console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
|
|
25
|
-
const api = new
|
|
25
|
+
const api = new AccountApi();
|
|
26
26
|
|
|
27
27
|
const body = {
|
|
28
|
-
//
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
clusterRequirementsRequest: ...,
|
|
32
|
-
} satisfies CalculateAssessmentClusterRequirementsRequest;
|
|
28
|
+
// GroupCreate
|
|
29
|
+
groupCreate: ...,
|
|
30
|
+
} satisfies CreateGroupRequest;
|
|
33
31
|
|
|
34
32
|
try {
|
|
35
|
-
const data = await api.
|
|
33
|
+
const data = await api.createGroup(body);
|
|
36
34
|
console.log(data);
|
|
37
35
|
} catch (error) {
|
|
38
36
|
console.error(error);
|
|
@@ -52,6 +50,16 @@ All URIs are relative to *https://raw.githubusercontent.com*
|
|
|
52
50
|
|
|
53
51
|
| Class | Method | HTTP request | Description
|
|
54
52
|
| ----- | ------ | ------------ | -------------
|
|
53
|
+
*AccountApi* | [**createGroup**](docs/AccountApi.md#creategroup) | **POST** /api/v1/groups |
|
|
54
|
+
*AccountApi* | [**createGroupMember**](docs/AccountApi.md#creategroupmember) | **POST** /api/v1/groups/{id}/members |
|
|
55
|
+
*AccountApi* | [**deleteGroup**](docs/AccountApi.md#deletegroup) | **DELETE** /api/v1/groups/{id} |
|
|
56
|
+
*AccountApi* | [**getGroup**](docs/AccountApi.md#getgroup) | **GET** /api/v1/groups/{id} |
|
|
57
|
+
*AccountApi* | [**getIdentity**](docs/AccountApi.md#getidentity) | **GET** /api/v1/identity |
|
|
58
|
+
*AccountApi* | [**listGroupMembers**](docs/AccountApi.md#listgroupmembers) | **GET** /api/v1/groups/{id}/members |
|
|
59
|
+
*AccountApi* | [**listGroups**](docs/AccountApi.md#listgroups) | **GET** /api/v1/groups |
|
|
60
|
+
*AccountApi* | [**removeGroupMember**](docs/AccountApi.md#removegroupmember) | **DELETE** /api/v1/groups/{id}/members/{username} |
|
|
61
|
+
*AccountApi* | [**updateGroup**](docs/AccountApi.md#updategroup) | **PUT** /api/v1/groups/{id} |
|
|
62
|
+
*AccountApi* | [**updateGroupMember**](docs/AccountApi.md#updategroupmember) | **PUT** /api/v1/groups/{id}/members/{username} |
|
|
55
63
|
*AssessmentApi* | [**calculateAssessmentClusterRequirements**](docs/AssessmentApi.md#calculateassessmentclusterrequirements) | **POST** /api/v1/assessments/{id}/cluster-requirements |
|
|
56
64
|
*AssessmentApi* | [**calculateMigrationComplexity**](docs/AssessmentApi.md#calculatemigrationcomplexity) | **POST** /api/v1/assessments/{id}/complexity-estimation |
|
|
57
65
|
*AssessmentApi* | [**calculateMigrationEstimation**](docs/AssessmentApi.md#calculatemigrationestimation) | **POST** /api/v1/assessments/{id}/migration-estimation |
|
|
@@ -95,8 +103,12 @@ All URIs are relative to *https://raw.githubusercontent.com*
|
|
|
95
103
|
- [DiskTypeSummary](docs/DiskTypeSummary.md)
|
|
96
104
|
- [EstimationContext](docs/EstimationContext.md)
|
|
97
105
|
- [EstimationDetail](docs/EstimationDetail.md)
|
|
106
|
+
- [Group](docs/Group.md)
|
|
107
|
+
- [GroupCreate](docs/GroupCreate.md)
|
|
108
|
+
- [GroupUpdate](docs/GroupUpdate.md)
|
|
98
109
|
- [Histogram](docs/Histogram.md)
|
|
99
110
|
- [Host](docs/Host.md)
|
|
111
|
+
- [Identity](docs/Identity.md)
|
|
100
112
|
- [Info](docs/Info.md)
|
|
101
113
|
- [Infra](docs/Infra.md)
|
|
102
114
|
- [Inventory](docs/Inventory.md)
|
|
@@ -106,10 +118,14 @@ All URIs are relative to *https://raw.githubusercontent.com*
|
|
|
106
118
|
- [Job](docs/Job.md)
|
|
107
119
|
- [JobStatus](docs/JobStatus.md)
|
|
108
120
|
- [Label](docs/Label.md)
|
|
121
|
+
- [Member](docs/Member.md)
|
|
122
|
+
- [MemberCreate](docs/MemberCreate.md)
|
|
123
|
+
- [MemberUpdate](docs/MemberUpdate.md)
|
|
109
124
|
- [MigrationComplexityRequest](docs/MigrationComplexityRequest.md)
|
|
110
125
|
- [MigrationComplexityResponse](docs/MigrationComplexityResponse.md)
|
|
111
126
|
- [MigrationEstimationByComplexityResponse](docs/MigrationEstimationByComplexityResponse.md)
|
|
112
127
|
- [MigrationEstimationRequest](docs/MigrationEstimationRequest.md)
|
|
128
|
+
- [MigrationEstimationResponse](docs/MigrationEstimationResponse.md)
|
|
113
129
|
- [MigrationIssue](docs/MigrationIssue.md)
|
|
114
130
|
- [ModelError](docs/ModelError.md)
|
|
115
131
|
- [Network](docs/Network.md)
|
|
@@ -144,7 +160,7 @@ and is automatically generated by the
|
|
|
144
160
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
145
161
|
|
|
146
162
|
- API version: `undefined`
|
|
147
|
-
- Package version: `0.
|
|
163
|
+
- Package version: `0.10.0-783d8b3a2dc4`
|
|
148
164
|
- Generator version: `7.22.0-SNAPSHOT`
|
|
149
165
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
150
166
|
|
|
@@ -0,0 +1,390 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenShift Migration Advisor API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: undefined
|
|
6
|
+
*
|
|
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 * as runtime from '../runtime.js';
|
|
13
|
+
import type { Group, GroupCreate, GroupUpdate, Identity, Member, MemberCreate, MemberUpdate } from '../models/index.js';
|
|
14
|
+
export interface CreateGroupRequest {
|
|
15
|
+
groupCreate: GroupCreate;
|
|
16
|
+
}
|
|
17
|
+
export interface CreateGroupMemberRequest {
|
|
18
|
+
id: string;
|
|
19
|
+
memberCreate: MemberCreate;
|
|
20
|
+
}
|
|
21
|
+
export interface DeleteGroupRequest {
|
|
22
|
+
id: string;
|
|
23
|
+
}
|
|
24
|
+
export interface GetGroupRequest {
|
|
25
|
+
id: string;
|
|
26
|
+
}
|
|
27
|
+
export interface ListGroupMembersRequest {
|
|
28
|
+
id: string;
|
|
29
|
+
}
|
|
30
|
+
export interface ListGroupsRequest {
|
|
31
|
+
kind?: ListGroupsKindEnum;
|
|
32
|
+
name?: string;
|
|
33
|
+
company?: string;
|
|
34
|
+
}
|
|
35
|
+
export interface RemoveGroupMemberRequest {
|
|
36
|
+
id: string;
|
|
37
|
+
username: string;
|
|
38
|
+
}
|
|
39
|
+
export interface UpdateGroupRequest {
|
|
40
|
+
id: string;
|
|
41
|
+
groupUpdate: GroupUpdate;
|
|
42
|
+
}
|
|
43
|
+
export interface UpdateGroupMemberRequest {
|
|
44
|
+
id: string;
|
|
45
|
+
username: string;
|
|
46
|
+
memberUpdate: MemberUpdate;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* AccountApi - interface
|
|
50
|
+
*
|
|
51
|
+
* @export
|
|
52
|
+
* @interface AccountApiInterface
|
|
53
|
+
*/
|
|
54
|
+
export interface AccountApiInterface {
|
|
55
|
+
/**
|
|
56
|
+
* Creates request options for createGroup without sending the request
|
|
57
|
+
* @param {GroupCreate} groupCreate
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
* @memberof AccountApiInterface
|
|
60
|
+
*/
|
|
61
|
+
createGroupRequestOpts(requestParameters: CreateGroupRequest): Promise<runtime.RequestOpts>;
|
|
62
|
+
/**
|
|
63
|
+
* Create a group
|
|
64
|
+
* @param {GroupCreate} groupCreate
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
* @memberof AccountApiInterface
|
|
68
|
+
*/
|
|
69
|
+
createGroupRaw(requestParameters: CreateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
70
|
+
/**
|
|
71
|
+
* Create a group
|
|
72
|
+
*/
|
|
73
|
+
createGroup(requestParameters: CreateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
74
|
+
/**
|
|
75
|
+
* Creates request options for createGroupMember without sending the request
|
|
76
|
+
* @param {string} id ID of the group
|
|
77
|
+
* @param {MemberCreate} memberCreate
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
* @memberof AccountApiInterface
|
|
80
|
+
*/
|
|
81
|
+
createGroupMemberRequestOpts(requestParameters: CreateGroupMemberRequest): Promise<runtime.RequestOpts>;
|
|
82
|
+
/**
|
|
83
|
+
* Create a member in a group
|
|
84
|
+
* @param {string} id ID of the group
|
|
85
|
+
* @param {MemberCreate} memberCreate
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
* @memberof AccountApiInterface
|
|
89
|
+
*/
|
|
90
|
+
createGroupMemberRaw(requestParameters: CreateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Member>>;
|
|
91
|
+
/**
|
|
92
|
+
* Create a member in a group
|
|
93
|
+
*/
|
|
94
|
+
createGroupMember(requestParameters: CreateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Member>;
|
|
95
|
+
/**
|
|
96
|
+
* Creates request options for deleteGroup without sending the request
|
|
97
|
+
* @param {string} id ID of the group
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
* @memberof AccountApiInterface
|
|
100
|
+
*/
|
|
101
|
+
deleteGroupRequestOpts(requestParameters: DeleteGroupRequest): Promise<runtime.RequestOpts>;
|
|
102
|
+
/**
|
|
103
|
+
* Delete a group
|
|
104
|
+
* @param {string} id ID of the group
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
* @memberof AccountApiInterface
|
|
108
|
+
*/
|
|
109
|
+
deleteGroupRaw(requestParameters: DeleteGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
110
|
+
/**
|
|
111
|
+
* Delete a group
|
|
112
|
+
*/
|
|
113
|
+
deleteGroup(requestParameters: DeleteGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
114
|
+
/**
|
|
115
|
+
* Creates request options for getGroup without sending the request
|
|
116
|
+
* @param {string} id ID of the group
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
* @memberof AccountApiInterface
|
|
119
|
+
*/
|
|
120
|
+
getGroupRequestOpts(requestParameters: GetGroupRequest): Promise<runtime.RequestOpts>;
|
|
121
|
+
/**
|
|
122
|
+
* Get a group by ID
|
|
123
|
+
* @param {string} id ID of the group
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
* @memberof AccountApiInterface
|
|
127
|
+
*/
|
|
128
|
+
getGroupRaw(requestParameters: GetGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
129
|
+
/**
|
|
130
|
+
* Get a group by ID
|
|
131
|
+
*/
|
|
132
|
+
getGroup(requestParameters: GetGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
133
|
+
/**
|
|
134
|
+
* Creates request options for getIdentity without sending the request
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
* @memberof AccountApiInterface
|
|
137
|
+
*/
|
|
138
|
+
getIdentityRequestOpts(): Promise<runtime.RequestOpts>;
|
|
139
|
+
/**
|
|
140
|
+
* Returns the authenticated user\'s profile. If a local account exists, returns stored user data. Otherwise returns a synthesized regular user.
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
* @memberof AccountApiInterface
|
|
144
|
+
*/
|
|
145
|
+
getIdentityRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Identity>>;
|
|
146
|
+
/**
|
|
147
|
+
* Returns the authenticated user\'s profile. If a local account exists, returns stored user data. Otherwise returns a synthesized regular user.
|
|
148
|
+
*/
|
|
149
|
+
getIdentity(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Identity>;
|
|
150
|
+
/**
|
|
151
|
+
* Creates request options for listGroupMembers without sending the request
|
|
152
|
+
* @param {string} id ID of the group
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
* @memberof AccountApiInterface
|
|
155
|
+
*/
|
|
156
|
+
listGroupMembersRequestOpts(requestParameters: ListGroupMembersRequest): Promise<runtime.RequestOpts>;
|
|
157
|
+
/**
|
|
158
|
+
* List members in a group
|
|
159
|
+
* @param {string} id ID of the group
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
* @memberof AccountApiInterface
|
|
163
|
+
*/
|
|
164
|
+
listGroupMembersRaw(requestParameters: ListGroupMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Member>>>;
|
|
165
|
+
/**
|
|
166
|
+
* List members in a group
|
|
167
|
+
*/
|
|
168
|
+
listGroupMembers(requestParameters: ListGroupMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Member>>;
|
|
169
|
+
/**
|
|
170
|
+
* Creates request options for listGroups without sending the request
|
|
171
|
+
* @param {'partner' | 'admin'} [kind] Filter by group kind
|
|
172
|
+
* @param {string} [name] Filter by name (case-insensitive partial match)
|
|
173
|
+
* @param {string} [company] Filter by company (case-insensitive partial match)
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
* @memberof AccountApiInterface
|
|
176
|
+
*/
|
|
177
|
+
listGroupsRequestOpts(requestParameters: ListGroupsRequest): Promise<runtime.RequestOpts>;
|
|
178
|
+
/**
|
|
179
|
+
* List all groups
|
|
180
|
+
* @param {'partner' | 'admin'} [kind] Filter by group kind
|
|
181
|
+
* @param {string} [name] Filter by name (case-insensitive partial match)
|
|
182
|
+
* @param {string} [company] Filter by company (case-insensitive partial match)
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
* @memberof AccountApiInterface
|
|
186
|
+
*/
|
|
187
|
+
listGroupsRaw(requestParameters: ListGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Group>>>;
|
|
188
|
+
/**
|
|
189
|
+
* List all groups
|
|
190
|
+
*/
|
|
191
|
+
listGroups(requestParameters: ListGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Group>>;
|
|
192
|
+
/**
|
|
193
|
+
* Creates request options for removeGroupMember without sending the request
|
|
194
|
+
* @param {string} id ID of the group
|
|
195
|
+
* @param {string} username Username of the member
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
* @memberof AccountApiInterface
|
|
198
|
+
*/
|
|
199
|
+
removeGroupMemberRequestOpts(requestParameters: RemoveGroupMemberRequest): Promise<runtime.RequestOpts>;
|
|
200
|
+
/**
|
|
201
|
+
* Delete the member record from the specified group. Because a member must always belong to a group, this operation permanently deletes the member — not just the membership.
|
|
202
|
+
* @param {string} id ID of the group
|
|
203
|
+
* @param {string} username Username of the member
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
* @memberof AccountApiInterface
|
|
207
|
+
*/
|
|
208
|
+
removeGroupMemberRaw(requestParameters: RemoveGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
209
|
+
/**
|
|
210
|
+
* Delete the member record from the specified group. Because a member must always belong to a group, this operation permanently deletes the member — not just the membership.
|
|
211
|
+
*/
|
|
212
|
+
removeGroupMember(requestParameters: RemoveGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
213
|
+
/**
|
|
214
|
+
* Creates request options for updateGroup without sending the request
|
|
215
|
+
* @param {string} id ID of the group
|
|
216
|
+
* @param {GroupUpdate} groupUpdate
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
* @memberof AccountApiInterface
|
|
219
|
+
*/
|
|
220
|
+
updateGroupRequestOpts(requestParameters: UpdateGroupRequest): Promise<runtime.RequestOpts>;
|
|
221
|
+
/**
|
|
222
|
+
* Update a group
|
|
223
|
+
* @param {string} id ID of the group
|
|
224
|
+
* @param {GroupUpdate} groupUpdate
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
* @memberof AccountApiInterface
|
|
228
|
+
*/
|
|
229
|
+
updateGroupRaw(requestParameters: UpdateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
230
|
+
/**
|
|
231
|
+
* Update a group
|
|
232
|
+
*/
|
|
233
|
+
updateGroup(requestParameters: UpdateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
234
|
+
/**
|
|
235
|
+
* Creates request options for updateGroupMember without sending the request
|
|
236
|
+
* @param {string} id ID of the group
|
|
237
|
+
* @param {string} username Username of the member
|
|
238
|
+
* @param {MemberUpdate} memberUpdate
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
* @memberof AccountApiInterface
|
|
241
|
+
*/
|
|
242
|
+
updateGroupMemberRequestOpts(requestParameters: UpdateGroupMemberRequest): Promise<runtime.RequestOpts>;
|
|
243
|
+
/**
|
|
244
|
+
* Update a member in a group
|
|
245
|
+
* @param {string} id ID of the group
|
|
246
|
+
* @param {string} username Username of the member
|
|
247
|
+
* @param {MemberUpdate} memberUpdate
|
|
248
|
+
* @param {*} [options] Override http request option.
|
|
249
|
+
* @throws {RequiredError}
|
|
250
|
+
* @memberof AccountApiInterface
|
|
251
|
+
*/
|
|
252
|
+
updateGroupMemberRaw(requestParameters: UpdateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Member>>;
|
|
253
|
+
/**
|
|
254
|
+
* Update a member in a group
|
|
255
|
+
*/
|
|
256
|
+
updateGroupMember(requestParameters: UpdateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Member>;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
*
|
|
260
|
+
*/
|
|
261
|
+
export declare class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
|
|
262
|
+
/**
|
|
263
|
+
* Creates request options for createGroup without sending the request
|
|
264
|
+
*/
|
|
265
|
+
createGroupRequestOpts(requestParameters: CreateGroupRequest): Promise<runtime.RequestOpts>;
|
|
266
|
+
/**
|
|
267
|
+
* Create a group
|
|
268
|
+
*/
|
|
269
|
+
createGroupRaw(requestParameters: CreateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
270
|
+
/**
|
|
271
|
+
* Create a group
|
|
272
|
+
*/
|
|
273
|
+
createGroup(requestParameters: CreateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
274
|
+
/**
|
|
275
|
+
* Creates request options for createGroupMember without sending the request
|
|
276
|
+
*/
|
|
277
|
+
createGroupMemberRequestOpts(requestParameters: CreateGroupMemberRequest): Promise<runtime.RequestOpts>;
|
|
278
|
+
/**
|
|
279
|
+
* Create a member in a group
|
|
280
|
+
*/
|
|
281
|
+
createGroupMemberRaw(requestParameters: CreateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Member>>;
|
|
282
|
+
/**
|
|
283
|
+
* Create a member in a group
|
|
284
|
+
*/
|
|
285
|
+
createGroupMember(requestParameters: CreateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Member>;
|
|
286
|
+
/**
|
|
287
|
+
* Creates request options for deleteGroup without sending the request
|
|
288
|
+
*/
|
|
289
|
+
deleteGroupRequestOpts(requestParameters: DeleteGroupRequest): Promise<runtime.RequestOpts>;
|
|
290
|
+
/**
|
|
291
|
+
* Delete a group
|
|
292
|
+
*/
|
|
293
|
+
deleteGroupRaw(requestParameters: DeleteGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
294
|
+
/**
|
|
295
|
+
* Delete a group
|
|
296
|
+
*/
|
|
297
|
+
deleteGroup(requestParameters: DeleteGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
298
|
+
/**
|
|
299
|
+
* Creates request options for getGroup without sending the request
|
|
300
|
+
*/
|
|
301
|
+
getGroupRequestOpts(requestParameters: GetGroupRequest): Promise<runtime.RequestOpts>;
|
|
302
|
+
/**
|
|
303
|
+
* Get a group by ID
|
|
304
|
+
*/
|
|
305
|
+
getGroupRaw(requestParameters: GetGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
306
|
+
/**
|
|
307
|
+
* Get a group by ID
|
|
308
|
+
*/
|
|
309
|
+
getGroup(requestParameters: GetGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
310
|
+
/**
|
|
311
|
+
* Creates request options for getIdentity without sending the request
|
|
312
|
+
*/
|
|
313
|
+
getIdentityRequestOpts(): Promise<runtime.RequestOpts>;
|
|
314
|
+
/**
|
|
315
|
+
* Returns the authenticated user\'s profile. If a local account exists, returns stored user data. Otherwise returns a synthesized regular user.
|
|
316
|
+
*/
|
|
317
|
+
getIdentityRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Identity>>;
|
|
318
|
+
/**
|
|
319
|
+
* Returns the authenticated user\'s profile. If a local account exists, returns stored user data. Otherwise returns a synthesized regular user.
|
|
320
|
+
*/
|
|
321
|
+
getIdentity(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Identity>;
|
|
322
|
+
/**
|
|
323
|
+
* Creates request options for listGroupMembers without sending the request
|
|
324
|
+
*/
|
|
325
|
+
listGroupMembersRequestOpts(requestParameters: ListGroupMembersRequest): Promise<runtime.RequestOpts>;
|
|
326
|
+
/**
|
|
327
|
+
* List members in a group
|
|
328
|
+
*/
|
|
329
|
+
listGroupMembersRaw(requestParameters: ListGroupMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Member>>>;
|
|
330
|
+
/**
|
|
331
|
+
* List members in a group
|
|
332
|
+
*/
|
|
333
|
+
listGroupMembers(requestParameters: ListGroupMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Member>>;
|
|
334
|
+
/**
|
|
335
|
+
* Creates request options for listGroups without sending the request
|
|
336
|
+
*/
|
|
337
|
+
listGroupsRequestOpts(requestParameters: ListGroupsRequest): Promise<runtime.RequestOpts>;
|
|
338
|
+
/**
|
|
339
|
+
* List all groups
|
|
340
|
+
*/
|
|
341
|
+
listGroupsRaw(requestParameters: ListGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Group>>>;
|
|
342
|
+
/**
|
|
343
|
+
* List all groups
|
|
344
|
+
*/
|
|
345
|
+
listGroups(requestParameters?: ListGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Group>>;
|
|
346
|
+
/**
|
|
347
|
+
* Creates request options for removeGroupMember without sending the request
|
|
348
|
+
*/
|
|
349
|
+
removeGroupMemberRequestOpts(requestParameters: RemoveGroupMemberRequest): Promise<runtime.RequestOpts>;
|
|
350
|
+
/**
|
|
351
|
+
* Delete the member record from the specified group. Because a member must always belong to a group, this operation permanently deletes the member — not just the membership.
|
|
352
|
+
*/
|
|
353
|
+
removeGroupMemberRaw(requestParameters: RemoveGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
354
|
+
/**
|
|
355
|
+
* Delete the member record from the specified group. Because a member must always belong to a group, this operation permanently deletes the member — not just the membership.
|
|
356
|
+
*/
|
|
357
|
+
removeGroupMember(requestParameters: RemoveGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
358
|
+
/**
|
|
359
|
+
* Creates request options for updateGroup without sending the request
|
|
360
|
+
*/
|
|
361
|
+
updateGroupRequestOpts(requestParameters: UpdateGroupRequest): Promise<runtime.RequestOpts>;
|
|
362
|
+
/**
|
|
363
|
+
* Update a group
|
|
364
|
+
*/
|
|
365
|
+
updateGroupRaw(requestParameters: UpdateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Group>>;
|
|
366
|
+
/**
|
|
367
|
+
* Update a group
|
|
368
|
+
*/
|
|
369
|
+
updateGroup(requestParameters: UpdateGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Group>;
|
|
370
|
+
/**
|
|
371
|
+
* Creates request options for updateGroupMember without sending the request
|
|
372
|
+
*/
|
|
373
|
+
updateGroupMemberRequestOpts(requestParameters: UpdateGroupMemberRequest): Promise<runtime.RequestOpts>;
|
|
374
|
+
/**
|
|
375
|
+
* Update a member in a group
|
|
376
|
+
*/
|
|
377
|
+
updateGroupMemberRaw(requestParameters: UpdateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Member>>;
|
|
378
|
+
/**
|
|
379
|
+
* Update a member in a group
|
|
380
|
+
*/
|
|
381
|
+
updateGroupMember(requestParameters: UpdateGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Member>;
|
|
382
|
+
}
|
|
383
|
+
/**
|
|
384
|
+
* @export
|
|
385
|
+
*/
|
|
386
|
+
export declare const ListGroupsKindEnum: {
|
|
387
|
+
readonly Partner: "partner";
|
|
388
|
+
readonly Admin: "admin";
|
|
389
|
+
};
|
|
390
|
+
export type ListGroupsKindEnum = typeof ListGroupsKindEnum[keyof typeof ListGroupsKindEnum];
|