@resolution/organizations-api-client 0.14.0
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/LICENSE.md +19 -0
- package/README.md +110 -0
- package/lib/index.d.ts +39 -0
- package/lib/index.js +46 -0
- package/lib/index.js.map +1 -0
- package/lib/openapi/core/CommonHttpClient.d.ts +316 -0
- package/lib/openapi/core/CommonHttpClient.js +639 -0
- package/lib/openapi/core/CommonHttpClient.js.map +1 -0
- package/lib/openapi/core/CommonHttpService.d.ts +26 -0
- package/lib/openapi/core/CommonHttpService.js +40 -0
- package/lib/openapi/core/CommonHttpService.js.map +1 -0
- package/lib/openapi/core/CommonValidationSchemaStorage.d.ts +35 -0
- package/lib/openapi/core/CommonValidationSchemaStorage.js +63 -0
- package/lib/openapi/core/CommonValidationSchemaStorage.js.map +1 -0
- package/lib/openapi/organizations/BaseOrganizationsApiClient.d.ts +94 -0
- package/lib/openapi/organizations/BaseOrganizationsApiClient.js +127 -0
- package/lib/openapi/organizations/BaseOrganizationsApiClient.js.map +1 -0
- package/lib/openapi/organizations/models/common.d.ts +222 -0
- package/lib/openapi/organizations/models/common.js +66 -0
- package/lib/openapi/organizations/models/common.js.map +1 -0
- package/lib/openapi/organizations/models/directory.d.ts +151 -0
- package/lib/openapi/organizations/models/directory.js +58 -0
- package/lib/openapi/organizations/models/directory.js.map +1 -0
- package/lib/openapi/organizations/models/domains.d.ts +52 -0
- package/lib/openapi/organizations/models/domains.js +35 -0
- package/lib/openapi/organizations/models/domains.js.map +1 -0
- package/lib/openapi/organizations/models/events.d.ts +280 -0
- package/lib/openapi/organizations/models/events.js +129 -0
- package/lib/openapi/organizations/models/events.js.map +1 -0
- package/lib/openapi/organizations/models/groups.d.ts +297 -0
- package/lib/openapi/organizations/models/groups.js +114 -0
- package/lib/openapi/organizations/models/groups.js.map +1 -0
- package/lib/openapi/organizations/models/orgs.d.ts +52 -0
- package/lib/openapi/organizations/models/orgs.js +36 -0
- package/lib/openapi/organizations/models/orgs.js.map +1 -0
- package/lib/openapi/organizations/models/policies.d.ts +169 -0
- package/lib/openapi/organizations/models/policies.js +101 -0
- package/lib/openapi/organizations/models/policies.js.map +1 -0
- package/lib/openapi/organizations/models/users.d.ts +477 -0
- package/lib/openapi/organizations/models/users.js +178 -0
- package/lib/openapi/organizations/models/users.js.map +1 -0
- package/lib/openapi/organizations/models/workspaces.d.ts +200 -0
- package/lib/openapi/organizations/models/workspaces.js +106 -0
- package/lib/openapi/organizations/models/workspaces.js.map +1 -0
- package/lib/openapi/organizations/services/DirectoryService.d.ts +637 -0
- package/lib/openapi/organizations/services/DirectoryService.js +599 -0
- package/lib/openapi/organizations/services/DirectoryService.js.map +1 -0
- package/lib/openapi/organizations/services/DomainsService.d.ts +51 -0
- package/lib/openapi/organizations/services/DomainsService.js +89 -0
- package/lib/openapi/organizations/services/DomainsService.js.map +1 -0
- package/lib/openapi/organizations/services/EventsService.d.ts +142 -0
- package/lib/openapi/organizations/services/EventsService.js +187 -0
- package/lib/openapi/organizations/services/EventsService.js.map +1 -0
- package/lib/openapi/organizations/services/GroupsService.d.ts +268 -0
- package/lib/openapi/organizations/services/GroupsService.js +210 -0
- package/lib/openapi/organizations/services/GroupsService.js.map +1 -0
- package/lib/openapi/organizations/services/OrgsService.d.ts +38 -0
- package/lib/openapi/organizations/services/OrgsService.js +79 -0
- package/lib/openapi/organizations/services/OrgsService.js.map +1 -0
- package/lib/openapi/organizations/services/PoliciesService.d.ts +172 -0
- package/lib/openapi/organizations/services/PoliciesService.js +272 -0
- package/lib/openapi/organizations/services/PoliciesService.js.map +1 -0
- package/lib/openapi/organizations/services/UsersService.d.ts +310 -0
- package/lib/openapi/organizations/services/UsersService.js +214 -0
- package/lib/openapi/organizations/services/UsersService.js.map +1 -0
- package/lib/openapi/organizations/services/ValidateService.d.ts +25 -0
- package/lib/openapi/organizations/services/ValidateService.js +38 -0
- package/lib/openapi/organizations/services/ValidateService.js.map +1 -0
- package/lib/openapi/organizations/services/WorkspacesService.d.ts +78 -0
- package/lib/openapi/organizations/services/WorkspacesService.js +63 -0
- package/lib/openapi/organizations/services/WorkspacesService.js.map +1 -0
- package/lib/openapi/organizations/validationSchemaStorage.d.ts +3 -0
- package/lib/openapi/organizations/validationSchemaStorage.js +134 -0
- package/lib/openapi/organizations/validationSchemaStorage.js.map +1 -0
- package/package.json +47 -0
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
|
+
import { type GroupsSearchRequest, type GroupsSearchPage, type MultiDirectoryGroupPage, type MultiDirectoryGroupDetails, type MultiDirectoryGroupRoleAssignmentPage, type MultiDirectoryGroupStats } from "../models/groups";
|
|
3
|
+
/**
|
|
4
|
+
* Orgs Groups APIs
|
|
5
|
+
*
|
|
6
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups
|
|
7
|
+
* @category Services
|
|
8
|
+
*/
|
|
9
|
+
export declare class GroupsService extends CommonHttpService {
|
|
10
|
+
/**
|
|
11
|
+
* Returns the details of a group.
|
|
12
|
+
*
|
|
13
|
+
* @returns Returned if the request is successful.
|
|
14
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}`
|
|
15
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-get
|
|
16
|
+
* @param params
|
|
17
|
+
*/
|
|
18
|
+
getGroup: ({ orgId, directoryId, groupId }: {
|
|
19
|
+
/**
|
|
20
|
+
* Your organization is identified by a Unique ID. You get your organization ID
|
|
21
|
+
* and Organization API key simultaneously.
|
|
22
|
+
*/
|
|
23
|
+
orgId: string;
|
|
24
|
+
/**
|
|
25
|
+
* Unique ID associated with a directory. The `-` character can be used to
|
|
26
|
+
* increase the operation scope to all directories the requestor has permission
|
|
27
|
+
* to manage.
|
|
28
|
+
*/
|
|
29
|
+
directoryId: string;
|
|
30
|
+
/** Unique ID associated with a group. */
|
|
31
|
+
groupId: string;
|
|
32
|
+
}) => Promise<MultiDirectoryGroupDetails>;
|
|
33
|
+
/**
|
|
34
|
+
* Returns a page of role assignments for a group that match the supplied
|
|
35
|
+
* parameters.
|
|
36
|
+
*
|
|
37
|
+
* @returns Returned if the request is successful.
|
|
38
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments`
|
|
39
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-role-assignments-get
|
|
40
|
+
* @param params
|
|
41
|
+
*/
|
|
42
|
+
getGroupRoleAssignments: ({ orgId, directoryId, groupId, cursor, limit, directoryIds, resourceOwners, resourceIds, roleIds }: {
|
|
43
|
+
/**
|
|
44
|
+
* Your organization is identified by a Unique ID. You get your organization ID
|
|
45
|
+
* and Organization API key simultaneously.
|
|
46
|
+
*/
|
|
47
|
+
orgId: string;
|
|
48
|
+
/**
|
|
49
|
+
* Unique ID associated with a directory. The `-` character can be used to
|
|
50
|
+
* increase the operation scope to all directories the requestor has permission
|
|
51
|
+
* to manage.
|
|
52
|
+
*/
|
|
53
|
+
directoryId: string;
|
|
54
|
+
/** Unique ID associated with a group. */
|
|
55
|
+
groupId: string;
|
|
56
|
+
/**
|
|
57
|
+
* Sets the cursor position to retrieve the next set of results. If present, all
|
|
58
|
+
* other parameters are discarded when searching.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```
|
|
62
|
+
* Qh8E1QpVV00ys/xI7pHI7Q..
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
cursor?: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* The desired number of results for the search request.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```
|
|
71
|
+
* 20
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
limit?: number | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* A list of directory IDs. The requestor must have permissions to administer
|
|
77
|
+
* resources linked to these directories.
|
|
78
|
+
*/
|
|
79
|
+
directoryIds?: string[] | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* The list of resource owners to filter the results by. Used to identify
|
|
82
|
+
* resources using their owner to which the user has at least one role assigned to.
|
|
83
|
+
*/
|
|
84
|
+
resourceOwners?: string[] | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* A list of resource IDs. The resource IDs should be specified using the
|
|
87
|
+
* Atlassian Resource Identifier (ARI) format. Example ARI:
|
|
88
|
+
* `ari:cloud:jira-core::site/1`
|
|
89
|
+
*/
|
|
90
|
+
resourceIds?: string[] | undefined;
|
|
91
|
+
/**
|
|
92
|
+
* A list of role IDs. The Atlassian canonical roles are used to determine the
|
|
93
|
+
* permissions of the user against resources within the organization. The allowed
|
|
94
|
+
* roles are:
|
|
95
|
+
* - `atlassian/user` - Can access the product, with no product admin
|
|
96
|
+
* permissions
|
|
97
|
+
* - `atlassian/admin` - Can access the product, with product admin permissions
|
|
98
|
+
* - `atlassian/guest` - Can only access one space you or space admins specify
|
|
99
|
+
* - `atlassian/customer` - (Jira Service Management) Can visit help center,
|
|
100
|
+
* submit help requests, and view articles (non-billable)
|
|
101
|
+
* - `atlassian/user-access-admin` - No product access. Can administer users
|
|
102
|
+
* and groups for this product in Atlassian Administration
|
|
103
|
+
* - `atlassian/contributor` - Can access the product to view, comment, and
|
|
104
|
+
* vote only (non-billable)
|
|
105
|
+
* - `atlassian/basic` - Can access basic product features, with no product
|
|
106
|
+
* admin permissions (non-billable)
|
|
107
|
+
* - `atlassian/stakeholder` - Can receive incident updates and has the same
|
|
108
|
+
* product access as Customer. Non-billable but available only on Premium and
|
|
109
|
+
* Enterprise plans
|
|
110
|
+
* - `atlassian/org-admin` - An organization admin is the highest level of
|
|
111
|
+
* admin and can complete any administrative task in Atlassian Administration
|
|
112
|
+
* - `atlassian/site-admin` - Site admins can access Atlassian Administration
|
|
113
|
+
* and complete tasks related to the specific site they are administering.
|
|
114
|
+
*/
|
|
115
|
+
roleIds?: ("atlassian/user" | "atlassian/user-access-admin" | "atlassian/admin" | "atlassian/guest" | "atlassian/contributor" | "atlassian/customer" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/site-admin" | "atlassian/org-admin")[] | undefined;
|
|
116
|
+
}) => Promise<MultiDirectoryGroupRoleAssignmentPage>;
|
|
117
|
+
/**
|
|
118
|
+
* Returns a page of groups in an organization that match the supplied parameters.
|
|
119
|
+
*
|
|
120
|
+
* @returns Returned if the request is successful.
|
|
121
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups`
|
|
122
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-get
|
|
123
|
+
* @param params
|
|
124
|
+
*/
|
|
125
|
+
getGroups: ({ orgId, directoryId, cursor, limit, directoryIds, accountIds, groupIds, resourceOwners, resourceIds, searchTerm, counts, sortBy }: {
|
|
126
|
+
/**
|
|
127
|
+
* Your organization is identified by a Unique ID. You get your organization ID
|
|
128
|
+
* and Organization API key simultaneously.
|
|
129
|
+
*/
|
|
130
|
+
orgId: string;
|
|
131
|
+
/**
|
|
132
|
+
* Unique ID associated with a directory. The `-` character can be used to
|
|
133
|
+
* increase the operation scope to all directories the requestor has permission
|
|
134
|
+
* to manage.
|
|
135
|
+
*/
|
|
136
|
+
directoryId: string;
|
|
137
|
+
/**
|
|
138
|
+
* Sets the cursor position to retrieve the next set of results. If present, all
|
|
139
|
+
* other parameters are discarded when searching.
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```
|
|
143
|
+
* Qh8E1QpVV00ys/xI7pHI7Q..
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
cursor?: string | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* The desired number of results for the search request.
|
|
149
|
+
*
|
|
150
|
+
* @example
|
|
151
|
+
* ```
|
|
152
|
+
* 20
|
|
153
|
+
* ```
|
|
154
|
+
*/
|
|
155
|
+
limit?: number | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* A list of directory IDs. The requestor must have permissions to administer
|
|
158
|
+
* resources linked to these directories.
|
|
159
|
+
*/
|
|
160
|
+
directoryIds?: string[] | undefined;
|
|
161
|
+
/** A list of user account IDs. */
|
|
162
|
+
accountIds?: string[] | undefined;
|
|
163
|
+
/** A list of group IDs. */
|
|
164
|
+
groupIds?: string[] | undefined;
|
|
165
|
+
/**
|
|
166
|
+
* The list of resource owners to filter the results by. Used to identify
|
|
167
|
+
* resources using their owner to which the user has at least one role assigned to.
|
|
168
|
+
*/
|
|
169
|
+
resourceOwners?: string[] | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* A list of resource IDs. The resource IDs should be specified using the
|
|
172
|
+
* Atlassian Resource Identifier (ARI) format. Example ARI:
|
|
173
|
+
* `ari:cloud:jira-core::site/1`
|
|
174
|
+
*/
|
|
175
|
+
resourceIds?: string[] | undefined;
|
|
176
|
+
/** A search term to search the `name` field. */
|
|
177
|
+
searchTerm?: string | undefined;
|
|
178
|
+
/** Whether to include counts of different objects associated with the group. */
|
|
179
|
+
counts?: ({
|
|
180
|
+
/** Whether to include the number of resources associated with the group. */
|
|
181
|
+
includeResources?: boolean | undefined;
|
|
182
|
+
/** Whether to include the number of users associated with the group. */
|
|
183
|
+
includeUsers?: boolean | undefined;
|
|
184
|
+
} & {
|
|
185
|
+
[key: string]: unknown;
|
|
186
|
+
}) | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* The field and direction to sort the results by. Currently, only a single field
|
|
189
|
+
* can be sorted by. If `null`, the default sorting will be used.
|
|
190
|
+
*/
|
|
191
|
+
sortBy?: ({
|
|
192
|
+
/** The name of the field to sort the results by. */
|
|
193
|
+
field: "name" | "description";
|
|
194
|
+
/** The direction to sort the results by. */
|
|
195
|
+
direction: "asc" | "desc";
|
|
196
|
+
} & {
|
|
197
|
+
[key: string]: unknown;
|
|
198
|
+
})[] | undefined;
|
|
199
|
+
}) => Promise<MultiDirectoryGroupPage>;
|
|
200
|
+
/**
|
|
201
|
+
* Returns group stats for the organization.
|
|
202
|
+
*
|
|
203
|
+
* @returns Returned if the request is successful.
|
|
204
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups/stats`
|
|
205
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-stats-get
|
|
206
|
+
* @param params
|
|
207
|
+
*/
|
|
208
|
+
getGroupsStats: ({ orgId, directoryId }: {
|
|
209
|
+
/**
|
|
210
|
+
* Your organization is identified by a Unique ID. You get your organization ID
|
|
211
|
+
* and Organization API key simultaneously.
|
|
212
|
+
*/
|
|
213
|
+
orgId: string;
|
|
214
|
+
/**
|
|
215
|
+
* Unique ID associated with a directory. The `-` character can be used to
|
|
216
|
+
* increase the operation scope to all directories the requestor has permission
|
|
217
|
+
* to manage.
|
|
218
|
+
*/
|
|
219
|
+
directoryId: string;
|
|
220
|
+
}) => Promise<MultiDirectoryGroupStats>;
|
|
221
|
+
/**
|
|
222
|
+
* **The API is available for customers using the new user management experience
|
|
223
|
+
* only. [How the new user management experience
|
|
224
|
+
* works](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**
|
|
225
|
+
*
|
|
226
|
+
* Returns a list of groups within an organization, offering search functionality
|
|
227
|
+
* through multiple parameters for more precise results.
|
|
228
|
+
*
|
|
229
|
+
* @returns Organization found. Response contains group search results
|
|
230
|
+
*
|
|
231
|
+
* example: " groups_search_response":
|
|
232
|
+
* ```
|
|
233
|
+
* {
|
|
234
|
+
* "data": [
|
|
235
|
+
* {
|
|
236
|
+
* "id": "123e4567-e89b-12d3-a456-426614174000",
|
|
237
|
+
* "name": "example",
|
|
238
|
+
* "description": "example description"
|
|
239
|
+
* }
|
|
240
|
+
* ],
|
|
241
|
+
* "links": {
|
|
242
|
+
* "next": "MDNlZWRmNzMtMWYwMi00NGM5LWI4NjgtZGQ1NTIwMjIwYjhj",
|
|
243
|
+
* "self": "MDI0MzkwOGEtMmYyOC00NzgzLWI5YTktMDUwZTExNzJjZDU4"
|
|
244
|
+
* }
|
|
245
|
+
* }
|
|
246
|
+
* ```
|
|
247
|
+
* @path POST `/v1/orgs/{orgId}/groups/search`
|
|
248
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-groups-search-post
|
|
249
|
+
* @param params
|
|
250
|
+
*/
|
|
251
|
+
searchGroups: ({ orgId, groupsSearchRequest }: {
|
|
252
|
+
/**
|
|
253
|
+
* Your organization is identified by a Unique ID. You get your organization ID
|
|
254
|
+
* and Organization API key simultaneously.
|
|
255
|
+
*/
|
|
256
|
+
orgId: string;
|
|
257
|
+
/**
|
|
258
|
+
* @example limit_only
|
|
259
|
+
* ```
|
|
260
|
+
* {
|
|
261
|
+
* "limit": 20
|
|
262
|
+
* }
|
|
263
|
+
* ```
|
|
264
|
+
*/
|
|
265
|
+
groupsSearchRequest: GroupsSearchRequest;
|
|
266
|
+
}) => Promise<GroupsSearchPage>;
|
|
267
|
+
protected static initialize(): void;
|
|
268
|
+
}
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.GroupsService = void 0;
|
|
4
|
+
// DO NOT EDIT!
|
|
5
|
+
// This file is generated by "api-typescript-generator".
|
|
6
|
+
// To update this file run "yarn build:openapi".
|
|
7
|
+
const commonHttpClient = require("../../core/CommonHttpClient");
|
|
8
|
+
const CommonHttpService_1 = require("../../core/CommonHttpService");
|
|
9
|
+
const groups_1 = require("../models/groups");
|
|
10
|
+
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
11
|
+
const zod_1 = require("zod");
|
|
12
|
+
/**
|
|
13
|
+
* Orgs Groups APIs
|
|
14
|
+
*
|
|
15
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups
|
|
16
|
+
* @category Services
|
|
17
|
+
*/
|
|
18
|
+
class GroupsService extends CommonHttpService_1.CommonHttpService {
|
|
19
|
+
constructor() {
|
|
20
|
+
super(...arguments);
|
|
21
|
+
/**
|
|
22
|
+
* Returns the details of a group.
|
|
23
|
+
*
|
|
24
|
+
* @returns Returned if the request is successful.
|
|
25
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}`
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-get
|
|
27
|
+
* @param params
|
|
28
|
+
*/
|
|
29
|
+
this.getGroup = ({ orgId, directoryId, groupId }) => {
|
|
30
|
+
return this.getClientInstance().request({
|
|
31
|
+
path: "/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}",
|
|
32
|
+
method: "GET",
|
|
33
|
+
pathParams: {
|
|
34
|
+
orgId,
|
|
35
|
+
directoryId,
|
|
36
|
+
groupId
|
|
37
|
+
}
|
|
38
|
+
}).then(this.getClientInstance().responseHandler({
|
|
39
|
+
200: {
|
|
40
|
+
"application/json": "json"
|
|
41
|
+
}
|
|
42
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("GroupsService.getGroup.response"))).then(commonHttpClient.getBody);
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* Returns a page of role assignments for a group that match the supplied
|
|
46
|
+
* parameters.
|
|
47
|
+
*
|
|
48
|
+
* @returns Returned if the request is successful.
|
|
49
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments`
|
|
50
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-role-assignments-get
|
|
51
|
+
* @param params
|
|
52
|
+
*/
|
|
53
|
+
this.getGroupRoleAssignments = ({ orgId, directoryId, groupId, cursor, limit, directoryIds, resourceOwners, resourceIds, roleIds }) => {
|
|
54
|
+
return this.getClientInstance().request({
|
|
55
|
+
path: "/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments",
|
|
56
|
+
method: "GET",
|
|
57
|
+
pathParams: {
|
|
58
|
+
orgId,
|
|
59
|
+
directoryId,
|
|
60
|
+
groupId
|
|
61
|
+
},
|
|
62
|
+
query: {
|
|
63
|
+
cursor,
|
|
64
|
+
limit,
|
|
65
|
+
directoryIds,
|
|
66
|
+
resourceOwners,
|
|
67
|
+
resourceIds,
|
|
68
|
+
roleIds
|
|
69
|
+
}
|
|
70
|
+
}).then(this.getClientInstance().responseHandler({
|
|
71
|
+
200: {
|
|
72
|
+
"application/json": "json"
|
|
73
|
+
}
|
|
74
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("GroupsService.getGroupRoleAssignments.response"))).then(commonHttpClient.getBody);
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* Returns a page of groups in an organization that match the supplied parameters.
|
|
78
|
+
*
|
|
79
|
+
* @returns Returned if the request is successful.
|
|
80
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups`
|
|
81
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-get
|
|
82
|
+
* @param params
|
|
83
|
+
*/
|
|
84
|
+
this.getGroups = ({ orgId, directoryId, cursor, limit, directoryIds, accountIds, groupIds, resourceOwners, resourceIds, searchTerm, counts, sortBy }) => {
|
|
85
|
+
return this.getClientInstance().request({
|
|
86
|
+
path: "/v2/orgs/{orgId}/directories/{directoryId}/groups",
|
|
87
|
+
method: "GET",
|
|
88
|
+
pathParams: {
|
|
89
|
+
orgId,
|
|
90
|
+
directoryId
|
|
91
|
+
},
|
|
92
|
+
query: {
|
|
93
|
+
cursor,
|
|
94
|
+
limit,
|
|
95
|
+
directoryIds,
|
|
96
|
+
accountIds,
|
|
97
|
+
groupIds,
|
|
98
|
+
resourceOwners,
|
|
99
|
+
resourceIds,
|
|
100
|
+
searchTerm,
|
|
101
|
+
counts,
|
|
102
|
+
sortBy
|
|
103
|
+
}
|
|
104
|
+
}).then(this.getClientInstance().responseHandler({
|
|
105
|
+
200: {
|
|
106
|
+
"application/json": "json"
|
|
107
|
+
}
|
|
108
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("GroupsService.getGroups.response"))).then(commonHttpClient.getBody);
|
|
109
|
+
};
|
|
110
|
+
/**
|
|
111
|
+
* Returns group stats for the organization.
|
|
112
|
+
*
|
|
113
|
+
* @returns Returned if the request is successful.
|
|
114
|
+
* @path GET `/v2/orgs/{orgId}/directories/{directoryId}/groups/stats`
|
|
115
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-stats-get
|
|
116
|
+
* @param params
|
|
117
|
+
*/
|
|
118
|
+
this.getGroupsStats = ({ orgId, directoryId }) => {
|
|
119
|
+
return this.getClientInstance().request({
|
|
120
|
+
path: "/v2/orgs/{orgId}/directories/{directoryId}/groups/stats",
|
|
121
|
+
method: "GET",
|
|
122
|
+
pathParams: {
|
|
123
|
+
orgId,
|
|
124
|
+
directoryId
|
|
125
|
+
}
|
|
126
|
+
}).then(this.getClientInstance().responseHandler({
|
|
127
|
+
200: {
|
|
128
|
+
"application/json": "json"
|
|
129
|
+
}
|
|
130
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("GroupsService.getGroupsStats.response"))).then(commonHttpClient.getBody);
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* **The API is available for customers using the new user management experience
|
|
134
|
+
* only. [How the new user management experience
|
|
135
|
+
* works](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**
|
|
136
|
+
*
|
|
137
|
+
* Returns a list of groups within an organization, offering search functionality
|
|
138
|
+
* through multiple parameters for more precise results.
|
|
139
|
+
*
|
|
140
|
+
* @returns Organization found. Response contains group search results
|
|
141
|
+
*
|
|
142
|
+
* example: " groups_search_response":
|
|
143
|
+
* ```
|
|
144
|
+
* {
|
|
145
|
+
* "data": [
|
|
146
|
+
* {
|
|
147
|
+
* "id": "123e4567-e89b-12d3-a456-426614174000",
|
|
148
|
+
* "name": "example",
|
|
149
|
+
* "description": "example description"
|
|
150
|
+
* }
|
|
151
|
+
* ],
|
|
152
|
+
* "links": {
|
|
153
|
+
* "next": "MDNlZWRmNzMtMWYwMi00NGM5LWI4NjgtZGQ1NTIwMjIwYjhj",
|
|
154
|
+
* "self": "MDI0MzkwOGEtMmYyOC00NzgzLWI5YTktMDUwZTExNzJjZDU4"
|
|
155
|
+
* }
|
|
156
|
+
* }
|
|
157
|
+
* ```
|
|
158
|
+
* @path POST `/v1/orgs/{orgId}/groups/search`
|
|
159
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-groups-search-post
|
|
160
|
+
* @param params
|
|
161
|
+
*/
|
|
162
|
+
this.searchGroups = ({ orgId, groupsSearchRequest }) => {
|
|
163
|
+
return this.getClientInstance().request({
|
|
164
|
+
path: "/v1/orgs/{orgId}/groups/search",
|
|
165
|
+
method: "POST",
|
|
166
|
+
pathParams: {
|
|
167
|
+
orgId
|
|
168
|
+
},
|
|
169
|
+
headers: {
|
|
170
|
+
"Content-Type": "application/json"
|
|
171
|
+
},
|
|
172
|
+
body: groupsSearchRequest
|
|
173
|
+
}).then(this.getClientInstance().responseHandler({
|
|
174
|
+
200: {
|
|
175
|
+
"application/json": "json"
|
|
176
|
+
}
|
|
177
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("GroupsService.searchGroups.response"))).then(commonHttpClient.getBody);
|
|
178
|
+
};
|
|
179
|
+
}
|
|
180
|
+
static initialize() {
|
|
181
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupsService.searchGroups.response", zod_1.z.object({
|
|
182
|
+
status: zod_1.z.literal(200),
|
|
183
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
184
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("GroupsSearchPage")
|
|
185
|
+
}).describe("GroupsService.searchGroups.response"));
|
|
186
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupsService.getGroups.response", zod_1.z.object({
|
|
187
|
+
status: zod_1.z.literal(200),
|
|
188
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
189
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiDirectoryGroupPage")
|
|
190
|
+
}).describe("GroupsService.getGroups.response"));
|
|
191
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupsService.getGroup.response", zod_1.z.object({
|
|
192
|
+
status: zod_1.z.literal(200),
|
|
193
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
194
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiDirectoryGroupDetails")
|
|
195
|
+
}).describe("GroupsService.getGroup.response"));
|
|
196
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupsService.getGroupRoleAssignments.response", zod_1.z.object({
|
|
197
|
+
status: zod_1.z.literal(200),
|
|
198
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
199
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiDirectoryGroupRoleAssignmentPage")
|
|
200
|
+
}).describe("GroupsService.getGroupRoleAssignments.response"));
|
|
201
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupsService.getGroupsStats.response", zod_1.z.object({
|
|
202
|
+
status: zod_1.z.literal(200),
|
|
203
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
204
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiDirectoryGroupStats")
|
|
205
|
+
}).describe("GroupsService.getGroupsStats.response"));
|
|
206
|
+
validationSchemaStorage_1.validationSchemaStorage.registerOnce([groups_1.registerGroupsValidationSchemas]);
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
exports.GroupsService = GroupsService;
|
|
210
|
+
//# sourceMappingURL=GroupsService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"GroupsService.js","sourceRoot":"","sources":["../../../../src/openapi/organizations/services/GroupsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAA8P;AAC9P,wEAAqE;AACrE,6BAAwB;AACxB;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,qCAAiB;IAApD;;QACE;;;;;;;WAOG;QACH,aAAQ,GAAG,CAAC,EACV,KAAK,EACL,WAAW,EACX,OAAO,EAeR,EAAuC,EAAE;YACxC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6DAA6D;gBACnE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,KAAK;oBACL,WAAW;oBACX,OAAO;iBACR;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvJ,CAAC,CAAC;QACF;;;;;;;;WAQG;QACH,4BAAuB,GAAG,CAAC,EACzB,KAAK,EACL,WAAW,EACX,OAAO,EACP,MAAM,EACN,KAAK,EACL,YAAY,EACZ,cAAc,EACd,WAAW,EACX,OAAO,EA2ER,EAAkD,EAAE;YACnD,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,8EAA8E;gBACpF,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,KAAK;oBACL,WAAW;oBACX,OAAO;iBACR;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;oBACL,YAAY;oBACZ,cAAc;oBACd,WAAW;oBACX,OAAO;iBACR;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,gDAAgD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtK,CAAC,CAAC;QACF;;;;;;;WAOG;QACH,cAAS,GAAG,CAAC,EACX,KAAK,EACL,WAAW,EACX,MAAM,EACN,KAAK,EACL,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,WAAW,EACX,UAAU,EACV,MAAM,EACN,MAAM,EA2EP,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mDAAmD;gBACzD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,KAAK;oBACL,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;oBACL,YAAY;oBACZ,UAAU;oBACV,QAAQ;oBACR,cAAc;oBACd,WAAW;oBACX,UAAU;oBACV,MAAM;oBACN,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACxJ,CAAC,CAAC;QACF;;;;;;;WAOG;QACH,mBAAc,GAAG,CAAC,EAChB,KAAK,EACL,WAAW,EAaZ,EAAqC,EAAE;YACtC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,yDAAyD;gBAC/D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,KAAK;oBACL,WAAW;iBACZ;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC7J,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,iBAAY,GAAG,CAAC,EACd,KAAK,EACL,mBAAmB,EAgBpB,EAA6B,EAAE;YAC9B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,gCAAgC;gBACtC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,KAAK;iBACN;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,mBAAmB;aAC1B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3J,CAAC,CAAC;IA6BJ,CAAC;IA5BW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,qCAAqC,EAAE,OAAC,CAAC,MAAM,CAAC;YACzF,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC,CAAC,CAAC;QACpD,iDAAuB,CAAC,kBAAkB,CAAC,kCAAkC,EAAE,OAAC,CAAC,MAAM,CAAC;YACtF,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,yBAAyB,CAAC;SAC9D,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC,CAAC,CAAC;QACjD,iDAAuB,CAAC,kBAAkB,CAAC,iCAAiC,EAAE,OAAC,CAAC,MAAM,CAAC;YACrF,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,4BAA4B,CAAC;SACjE,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CAAC,CAAC;QAChD,iDAAuB,CAAC,kBAAkB,CAAC,gDAAgD,EAAE,OAAC,CAAC,MAAM,CAAC;YACpG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,uCAAuC,CAAC;SAC5E,CAAC,CAAC,QAAQ,CAAC,gDAAgD,CAAC,CAAC,CAAC;QAC/D,iDAAuB,CAAC,kBAAkB,CAAC,uCAAuC,EAAE,OAAC,CAAC,MAAM,CAAC;YAC3F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,0BAA0B,CAAC;SAC/D,CAAC,CAAC,QAAQ,CAAC,uCAAuC,CAAC,CAAC,CAAC;QACtD,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA7aD,sCA6aC"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
|
+
import { type OrgPage, type Org } from "../models/orgs";
|
|
3
|
+
/**
|
|
4
|
+
* Orgs APIs
|
|
5
|
+
*
|
|
6
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs
|
|
7
|
+
* @category Services
|
|
8
|
+
*/
|
|
9
|
+
export declare class OrgsService extends CommonHttpService {
|
|
10
|
+
/**
|
|
11
|
+
* Returns information about a single organization by ID
|
|
12
|
+
*
|
|
13
|
+
* @returns Successful operation
|
|
14
|
+
* @path GET `/v1/orgs/{orgId}`
|
|
15
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs#api-v1-orgs-orgid-get
|
|
16
|
+
* @param params
|
|
17
|
+
*/
|
|
18
|
+
getOrgById: ({ orgId }: {
|
|
19
|
+
/**
|
|
20
|
+
* Your organization is identified by a Unique ID. You get your organization ID
|
|
21
|
+
* and Organization API key simultaneously.
|
|
22
|
+
*/
|
|
23
|
+
orgId: string;
|
|
24
|
+
}) => Promise<Org>;
|
|
25
|
+
/**
|
|
26
|
+
* Returns a list of your organizations (based on your API key).
|
|
27
|
+
*
|
|
28
|
+
* @returns Successful operation
|
|
29
|
+
* @path GET `/v1/orgs`
|
|
30
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs#api-v1-orgs-get
|
|
31
|
+
* @param params
|
|
32
|
+
*/
|
|
33
|
+
getOrgs: ({ cursor }?: {
|
|
34
|
+
/** Sets the starting point for the page of results to return. */
|
|
35
|
+
cursor?: string | undefined;
|
|
36
|
+
}) => Promise<OrgPage>;
|
|
37
|
+
protected static initialize(): void;
|
|
38
|
+
}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OrgsService = void 0;
|
|
4
|
+
// DO NOT EDIT!
|
|
5
|
+
// This file is generated by "api-typescript-generator".
|
|
6
|
+
// To update this file run "yarn build:openapi".
|
|
7
|
+
const commonHttpClient = require("../../core/CommonHttpClient");
|
|
8
|
+
const CommonHttpService_1 = require("../../core/CommonHttpService");
|
|
9
|
+
const orgs_1 = require("../models/orgs");
|
|
10
|
+
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
11
|
+
const zod_1 = require("zod");
|
|
12
|
+
/**
|
|
13
|
+
* Orgs APIs
|
|
14
|
+
*
|
|
15
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs
|
|
16
|
+
* @category Services
|
|
17
|
+
*/
|
|
18
|
+
class OrgsService extends CommonHttpService_1.CommonHttpService {
|
|
19
|
+
constructor() {
|
|
20
|
+
super(...arguments);
|
|
21
|
+
/**
|
|
22
|
+
* Returns information about a single organization by ID
|
|
23
|
+
*
|
|
24
|
+
* @returns Successful operation
|
|
25
|
+
* @path GET `/v1/orgs/{orgId}`
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs#api-v1-orgs-orgid-get
|
|
27
|
+
* @param params
|
|
28
|
+
*/
|
|
29
|
+
this.getOrgById = ({ orgId }) => {
|
|
30
|
+
return this.getClientInstance().request({
|
|
31
|
+
path: "/v1/orgs/{orgId}",
|
|
32
|
+
method: "GET",
|
|
33
|
+
pathParams: {
|
|
34
|
+
orgId
|
|
35
|
+
}
|
|
36
|
+
}).then(this.getClientInstance().responseHandler({
|
|
37
|
+
200: {
|
|
38
|
+
"application/json": "json"
|
|
39
|
+
}
|
|
40
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("OrgsService.getOrgById.response"))).then(commonHttpClient.getBody);
|
|
41
|
+
};
|
|
42
|
+
/**
|
|
43
|
+
* Returns a list of your organizations (based on your API key).
|
|
44
|
+
*
|
|
45
|
+
* @returns Successful operation
|
|
46
|
+
* @path GET `/v1/orgs`
|
|
47
|
+
* @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs#api-v1-orgs-get
|
|
48
|
+
* @param params
|
|
49
|
+
*/
|
|
50
|
+
this.getOrgs = ({ cursor } = {}) => {
|
|
51
|
+
return this.getClientInstance().request({
|
|
52
|
+
path: "/v1/orgs",
|
|
53
|
+
method: "GET",
|
|
54
|
+
query: {
|
|
55
|
+
cursor
|
|
56
|
+
}
|
|
57
|
+
}).then(this.getClientInstance().responseHandler({
|
|
58
|
+
200: {
|
|
59
|
+
"application/json": "json"
|
|
60
|
+
}
|
|
61
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("OrgsService.getOrgs.response"))).then(commonHttpClient.getBody);
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
static initialize() {
|
|
65
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("OrgsService.getOrgs.response", zod_1.z.object({
|
|
66
|
+
status: zod_1.z.literal(200),
|
|
67
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
68
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("OrgPage")
|
|
69
|
+
}).describe("OrgsService.getOrgs.response"));
|
|
70
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("OrgsService.getOrgById.response", zod_1.z.object({
|
|
71
|
+
status: zod_1.z.literal(200),
|
|
72
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
73
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("Org")
|
|
74
|
+
}).describe("OrgsService.getOrgById.response"));
|
|
75
|
+
validationSchemaStorage_1.validationSchemaStorage.registerOnce([orgs_1.registerOrgsValidationSchemas]);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
exports.OrgsService = OrgsService;
|
|
79
|
+
//# sourceMappingURL=OrgsService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OrgsService.js","sourceRoot":"","sources":["../../../../src/openapi/organizations/services/OrgsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,yCAAuF;AACvF,wEAAqE;AACrE,6BAAwB;AACxB;;;;;GAKG;AACH,MAAa,WAAY,SAAQ,qCAAiB;IAAlD;;QACE;;;;;;;WAOG;QACH,eAAU,GAAG,CAAC,EACZ,KAAK,EAON,EAAgB,EAAE;YACjB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,kBAAkB;gBACxB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,KAAK;iBACN;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvJ,CAAC,CAAC;QACF;;;;;;;WAOG;QACH,YAAO,GAAG,CAAC,EACT,MAAM,KAIJ,EAAE,EAAoB,EAAE;YAC1B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpJ,CAAC,CAAC;IAcJ,CAAC;IAbW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,8BAA8B,EAAE,OAAC,CAAC,MAAM,CAAC;YAClF,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC;SAC9C,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,CAAC;QAC7C,iDAAuB,CAAC,kBAAkB,CAAC,iCAAiC,EAAE,OAAC,CAAC,MAAM,CAAC;YACrF,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,KAAK,CAAC;SAC1C,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CAAC,CAAC;QAChD,iDAAuB,CAAC,YAAY,CAAC,CAAC,oCAA6B,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AA7ED,kCA6EC"}
|