@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.
Files changed (75) hide show
  1. package/LICENSE.md +19 -0
  2. package/README.md +110 -0
  3. package/lib/index.d.ts +39 -0
  4. package/lib/index.js +46 -0
  5. package/lib/index.js.map +1 -0
  6. package/lib/openapi/core/CommonHttpClient.d.ts +316 -0
  7. package/lib/openapi/core/CommonHttpClient.js +639 -0
  8. package/lib/openapi/core/CommonHttpClient.js.map +1 -0
  9. package/lib/openapi/core/CommonHttpService.d.ts +26 -0
  10. package/lib/openapi/core/CommonHttpService.js +40 -0
  11. package/lib/openapi/core/CommonHttpService.js.map +1 -0
  12. package/lib/openapi/core/CommonValidationSchemaStorage.d.ts +35 -0
  13. package/lib/openapi/core/CommonValidationSchemaStorage.js +63 -0
  14. package/lib/openapi/core/CommonValidationSchemaStorage.js.map +1 -0
  15. package/lib/openapi/organizations/BaseOrganizationsApiClient.d.ts +94 -0
  16. package/lib/openapi/organizations/BaseOrganizationsApiClient.js +127 -0
  17. package/lib/openapi/organizations/BaseOrganizationsApiClient.js.map +1 -0
  18. package/lib/openapi/organizations/models/common.d.ts +222 -0
  19. package/lib/openapi/organizations/models/common.js +66 -0
  20. package/lib/openapi/organizations/models/common.js.map +1 -0
  21. package/lib/openapi/organizations/models/directory.d.ts +151 -0
  22. package/lib/openapi/organizations/models/directory.js +58 -0
  23. package/lib/openapi/organizations/models/directory.js.map +1 -0
  24. package/lib/openapi/organizations/models/domains.d.ts +52 -0
  25. package/lib/openapi/organizations/models/domains.js +35 -0
  26. package/lib/openapi/organizations/models/domains.js.map +1 -0
  27. package/lib/openapi/organizations/models/events.d.ts +280 -0
  28. package/lib/openapi/organizations/models/events.js +129 -0
  29. package/lib/openapi/organizations/models/events.js.map +1 -0
  30. package/lib/openapi/organizations/models/groups.d.ts +297 -0
  31. package/lib/openapi/organizations/models/groups.js +114 -0
  32. package/lib/openapi/organizations/models/groups.js.map +1 -0
  33. package/lib/openapi/organizations/models/orgs.d.ts +52 -0
  34. package/lib/openapi/organizations/models/orgs.js +36 -0
  35. package/lib/openapi/organizations/models/orgs.js.map +1 -0
  36. package/lib/openapi/organizations/models/policies.d.ts +169 -0
  37. package/lib/openapi/organizations/models/policies.js +101 -0
  38. package/lib/openapi/organizations/models/policies.js.map +1 -0
  39. package/lib/openapi/organizations/models/users.d.ts +477 -0
  40. package/lib/openapi/organizations/models/users.js +178 -0
  41. package/lib/openapi/organizations/models/users.js.map +1 -0
  42. package/lib/openapi/organizations/models/workspaces.d.ts +200 -0
  43. package/lib/openapi/organizations/models/workspaces.js +106 -0
  44. package/lib/openapi/organizations/models/workspaces.js.map +1 -0
  45. package/lib/openapi/organizations/services/DirectoryService.d.ts +637 -0
  46. package/lib/openapi/organizations/services/DirectoryService.js +599 -0
  47. package/lib/openapi/organizations/services/DirectoryService.js.map +1 -0
  48. package/lib/openapi/organizations/services/DomainsService.d.ts +51 -0
  49. package/lib/openapi/organizations/services/DomainsService.js +89 -0
  50. package/lib/openapi/organizations/services/DomainsService.js.map +1 -0
  51. package/lib/openapi/organizations/services/EventsService.d.ts +142 -0
  52. package/lib/openapi/organizations/services/EventsService.js +187 -0
  53. package/lib/openapi/organizations/services/EventsService.js.map +1 -0
  54. package/lib/openapi/organizations/services/GroupsService.d.ts +268 -0
  55. package/lib/openapi/organizations/services/GroupsService.js +210 -0
  56. package/lib/openapi/organizations/services/GroupsService.js.map +1 -0
  57. package/lib/openapi/organizations/services/OrgsService.d.ts +38 -0
  58. package/lib/openapi/organizations/services/OrgsService.js +79 -0
  59. package/lib/openapi/organizations/services/OrgsService.js.map +1 -0
  60. package/lib/openapi/organizations/services/PoliciesService.d.ts +172 -0
  61. package/lib/openapi/organizations/services/PoliciesService.js +272 -0
  62. package/lib/openapi/organizations/services/PoliciesService.js.map +1 -0
  63. package/lib/openapi/organizations/services/UsersService.d.ts +310 -0
  64. package/lib/openapi/organizations/services/UsersService.js +214 -0
  65. package/lib/openapi/organizations/services/UsersService.js.map +1 -0
  66. package/lib/openapi/organizations/services/ValidateService.d.ts +25 -0
  67. package/lib/openapi/organizations/services/ValidateService.js +38 -0
  68. package/lib/openapi/organizations/services/ValidateService.js.map +1 -0
  69. package/lib/openapi/organizations/services/WorkspacesService.d.ts +78 -0
  70. package/lib/openapi/organizations/services/WorkspacesService.js +63 -0
  71. package/lib/openapi/organizations/services/WorkspacesService.js.map +1 -0
  72. package/lib/openapi/organizations/validationSchemaStorage.d.ts +3 -0
  73. package/lib/openapi/organizations/validationSchemaStorage.js +134 -0
  74. package/lib/openapi/organizations/validationSchemaStorage.js.map +1 -0
  75. package/package.json +47 -0
@@ -0,0 +1,26 @@
1
+ import * as commonHttpClient from "./CommonHttpClient";
2
+ /** Base class for all services that need to make HTTP requests. */
3
+ export declare class CommonHttpService {
4
+ /**
5
+ * Map of child service instances to avoid creating multiple instances of the same
6
+ * service.
7
+ */
8
+ protected serviceInstancesMap: Map<new (getClientInstance: () => commonHttpClient.CommonHttpClient) => CommonHttpService, CommonHttpService>;
9
+ /** Get an instance of the specified service class. */
10
+ protected getServiceInstance<T extends CommonHttpService>(serviceClass: new (getClientInstance: () => commonHttpClient.CommonHttpClient) => T): T;
11
+ /** Get an instance of the HTTP client. */
12
+ protected getClientInstance: () => commonHttpClient.CommonHttpClient;
13
+ /**
14
+ * Create a new instance of the service.
15
+ *
16
+ * @internal
17
+ */
18
+ constructor(getClientInstance: () => commonHttpClient.CommonHttpClient);
19
+ /**
20
+ * Flag to indicate if the class has been initialized to avoid multiple
21
+ * initializations.
22
+ */
23
+ protected static initialized: boolean | undefined;
24
+ /** Method to initialize the class. Normally used to set up validation rules. */
25
+ protected static initialize: (() => void) | undefined;
26
+ }
@@ -0,0 +1,40 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CommonHttpService = void 0;
4
+ /** Base class for all services that need to make HTTP requests. */
5
+ class CommonHttpService {
6
+ /** Get an instance of the specified service class. */
7
+ getServiceInstance(serviceClass) {
8
+ let serviceInstance = this.serviceInstancesMap.get(serviceClass);
9
+ if (!serviceInstance) {
10
+ serviceInstance = new serviceClass(this.getClientInstance);
11
+ this.serviceInstancesMap.set(serviceClass, serviceInstance);
12
+ }
13
+ return serviceInstance;
14
+ }
15
+ /**
16
+ * Create a new instance of the service.
17
+ *
18
+ * @internal
19
+ */
20
+ constructor(getClientInstance) {
21
+ /**
22
+ * Map of child service instances to avoid creating multiple instances of the same
23
+ * service.
24
+ */
25
+ this.serviceInstancesMap = new Map();
26
+ this.getClientInstance = () => {
27
+ const classInstance = this.constructor;
28
+ if (classInstance.initialized !== true) {
29
+ classInstance.initialized = true;
30
+ if (classInstance.initialize !== undefined) {
31
+ classInstance.initialize();
32
+ }
33
+ }
34
+ this.getClientInstance = getClientInstance;
35
+ return getClientInstance();
36
+ };
37
+ }
38
+ }
39
+ exports.CommonHttpService = CommonHttpService;
40
+ //# sourceMappingURL=CommonHttpService.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CommonHttpService.js","sourceRoot":"","sources":["../../../src/openapi/core/CommonHttpService.ts"],"names":[],"mappings":";;;AAIA,mEAAmE;AACnE,MAAa,iBAAiB;IAM5B,sDAAsD;IAC5C,kBAAkB,CAA8B,YAAmF;QAC3I,IAAI,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,eAAe,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC3D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAC9D,CAAC;QACD,OAAQ,eAAqB,CAAC;IAChC,CAAC;IAGD;;;;OAIG;IACH,YAAY,iBAA0D;QArBtE;;;WAGG;QACO,wBAAmB,GAAkH,IAAI,GAAG,EAAE,CAAC;QAkBvJ,IAAI,CAAC,iBAAiB,GAAG,GAAG,EAAE;YAC5B,MAAM,aAAa,GAAI,IAAI,CAAC,WAAwC,CAAC;YACrE,IAAI,aAAa,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;gBACvC,aAAa,CAAC,WAAW,GAAG,IAAI,CAAC;gBACjC,IAAI,aAAa,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC3C,aAAa,CAAC,UAAU,EAAE,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;YAC3C,OAAO,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC;CAQF;AA1CD,8CA0CC"}
@@ -0,0 +1,35 @@
1
+ import { CommonHttpClientOptions, CommonHttpClientFetchResponse } from "./CommonHttpClient";
2
+ type CommonValidationSchemaStorageAssertDataShape<T> = <D>(schema: T, data: D) => void;
3
+ type RegisterOnceCallback<T> = (validationSchemaStorage: CommonValidationSchemaStorage<T>) => void;
4
+ type CommonValidationSchemaStorageMakeExtensible<T> = (schema: T) => T;
5
+ type CommonValidationSchemaStorageFormatErrorMessage<T> = (error: Error, schema: T) => string;
6
+ type CommonValidationSchemaStorageLazyGetter<T> = (callback: () => T) => T;
7
+ export declare class CommonValidationSchemaStorage<T> {
8
+ protected assertDataShape: CommonValidationSchemaStorageAssertDataShape<T>;
9
+ protected makeExtensible: CommonValidationSchemaStorageMakeExtensible<T>;
10
+ protected schemas: Record<string, T>;
11
+ protected registeredCallbacks: Set<RegisterOnceCallback<T>>;
12
+ protected errorClass: CommonHttpClientOptions['errorClass'];
13
+ protected formatErrorMessage: CommonValidationSchemaStorageFormatErrorMessage<T>;
14
+ protected lazyGetter: CommonValidationSchemaStorageLazyGetter<T>;
15
+ constructor({ assertDataShape, makeExtensible, formatErrorMessage, lazyGetter }: {
16
+ assertDataShape: CommonValidationSchemaStorageAssertDataShape<T>;
17
+ makeExtensible: CommonValidationSchemaStorageMakeExtensible<T>;
18
+ formatErrorMessage: CommonValidationSchemaStorageFormatErrorMessage<T>;
19
+ lazyGetter: CommonValidationSchemaStorageLazyGetter<T>;
20
+ });
21
+ register(key: string, schema: T): void;
22
+ registerExtensible(key: string, schema: T): void;
23
+ registerOnce(callbacks: RegisterOnceCallback<T>[]): void;
24
+ get(key: string): T;
25
+ lazy(key: string): T;
26
+ validator<D extends {
27
+ mediaType: string;
28
+ status: number;
29
+ body: unknown;
30
+ response: CommonHttpClientFetchResponse;
31
+ }>(key: string): (data: D) => D;
32
+ getErrorClass(): new (url: URL, request: import("./CommonHttpClient").CommonHttpClientFetchRequest | undefined, response: CommonHttpClientFetchResponse | undefined, options: CommonHttpClientOptions | undefined, message: string) => Error;
33
+ setErrorClass(errorClass: CommonHttpClientOptions['errorClass']): void;
34
+ }
35
+ export {};
@@ -0,0 +1,63 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CommonValidationSchemaStorage = 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_1 = require("./CommonHttpClient");
8
+ class CommonValidationSchemaStorage {
9
+ constructor({ assertDataShape, makeExtensible, formatErrorMessage, lazyGetter }) {
10
+ this.schemas = {};
11
+ this.registeredCallbacks = new Set();
12
+ this.errorClass = CommonHttpClient_1.CommonHttpClientError;
13
+ this.assertDataShape = assertDataShape;
14
+ this.makeExtensible = makeExtensible;
15
+ this.formatErrorMessage = formatErrorMessage;
16
+ this.lazyGetter = lazyGetter;
17
+ }
18
+ register(key, schema) {
19
+ this.schemas[key] = schema;
20
+ }
21
+ registerExtensible(key, schema) {
22
+ this.schemas[key] = this.makeExtensible(schema);
23
+ }
24
+ registerOnce(callbacks) {
25
+ for (const callback of callbacks) {
26
+ if (!this.registeredCallbacks.has(callback)) {
27
+ this.registeredCallbacks.add(callback);
28
+ callback(this);
29
+ }
30
+ }
31
+ }
32
+ get(key) {
33
+ return this.schemas[key];
34
+ }
35
+ lazy(key) {
36
+ return this.lazyGetter(() => this.schemas[key]);
37
+ }
38
+ validator(key) {
39
+ return (data) => {
40
+ const schema = this.schemas[key];
41
+ if (schema === undefined) {
42
+ throw new Error(`Schema with key "${key}" not found`);
43
+ }
44
+ if (data.mediaType !== undefined && (0, CommonHttpClient_1.isJsonMediaType)(data.mediaType)) {
45
+ try {
46
+ this.assertDataShape(schema, data);
47
+ }
48
+ catch (error) {
49
+ throw new this.errorClass(new URL(data.response.url), undefined, data.response, undefined, error instanceof Error ? this.formatErrorMessage(error, schema) : String(error));
50
+ }
51
+ }
52
+ return data;
53
+ };
54
+ }
55
+ getErrorClass() {
56
+ return this.errorClass;
57
+ }
58
+ setErrorClass(errorClass) {
59
+ this.errorClass = errorClass;
60
+ }
61
+ }
62
+ exports.CommonValidationSchemaStorage = CommonValidationSchemaStorage;
63
+ //# sourceMappingURL=CommonValidationSchemaStorage.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CommonValidationSchemaStorage.js","sourceRoot":"","sources":["../../../src/openapi/core/CommonValidationSchemaStorage.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,yDAAoI;AAMpI,MAAa,6BAA6B;IAQxC,YAAY,EACV,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,UAAU,EAMX;QAfS,YAAO,GAAsB,EAAE,CAAC;QAChC,wBAAmB,GAAG,IAAI,GAAG,EAA2B,CAAC;QACzD,eAAU,GAA0C,wCAAqB,CAAC;QAclF,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IACD,QAAQ,CAAC,GAAW,EAAE,MAAS;QAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;IAC7B,CAAC;IACD,kBAAkB,CAAC,GAAW,EAAE,MAAS;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IACD,YAAY,CAAC,SAAoC;QAC/C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACvC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;IACH,CAAC;IACD,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,CAAC,GAAW;QACd,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,SAAS,CAKN,GAAW;QACZ,OAAO,CAAC,IAAO,EAAE,EAAE;YACjB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,aAAa,CAAC,CAAC;YACxD,CAAC;YACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAA,kCAAe,EAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpE,IAAI,CAAC;oBACH,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACrC,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC9K,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IACJ,CAAC;IACD,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IACD,aAAa,CAAC,UAAiD;QAC7D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAvED,sEAuEC"}
@@ -0,0 +1,94 @@
1
+ import * as commonHttpClient from "../core/CommonHttpClient";
2
+ import { CommonHttpService } from "../core/CommonHttpService";
3
+ import type { ApplicationError, ErrorCdenPolicyValidationFailedModel, ErrorInternalErrorModel, ErrorInvalidPageCursorModel, ErrorOrgNotFoundModel, Errors, ErrorsApplicationErrorsModel, LinkPageCursor, LinkPageModel, LinkSelfCursor, LinkSelfModel, ProxyError, ResourceId, ResourceOwner, RoleIds } from "./models/common";
4
+ import type { AddGroupMembershipInput, ApiError, ApiErrorResponse, CreateGroupInput, CursorNextPageModel, GroupRoleAssignmentInput, InviteApiRequest, RoleApiRequest, RoleAssociation, UserProductAccessActivityPage, UserProductAccessModel, UserProductLastActive } from "./models/directory";
5
+ import type { Domain, DomainModel, DomainPage, ErrorDomainNotFoundModel, ErrorNoPermsModel } from "./models/domains";
6
+ import type { ErrorEventNotFoundModel, ErrorInvalidQueryCountModel, ErrorInvalidRequestSyntaxModel, ErrorInvalidSearchTimeDateModel, Event, EventActionModel, EventActions, EventActorModel, EventLocationModel, EventMessageModel, EventModel, EventObjectModel, EventPage, LinkAltModel, LinkSelfAltModel, PollingEventModel, PollingEventPage } from "./models/events";
7
+ import type { Error, GroupCounts, GroupNames, GroupsSearchPage, GroupsSearchRequest, GroupTotalCounts, GroupType, GroupTypeCounts, MultiDirectoryGroup, MultiDirectoryGroupDetails, MultiDirectoryGroupPage, MultiDirectoryGroupRoleAssignment, MultiDirectoryGroupRoleAssignmentPage, MultiDirectoryGroupStats, PublicGroup, RoleAssignment } from "./models/groups";
8
+ import type { LinkRelatedModel, Org, OrgModel, OrgPage } from "./models/orgs";
9
+ import type { AllowIfContainedRule, ErrorInvalidResourceModel, ErrorPolicyNotFoundModel, ErrorPolicyResourceNotFoundModel, Links, Meta, Policy, PolicyCreateInput, PolicyCreateModel, PolicyModel, PolicyPage, PolicyUpdateInput, PolicyUpdateModel, Resource, ResourceInput, ResourceUpdateInput } from "./models/policies";
10
+ import type { AccountStatus, AccountStatusCounts, AccountType, ClaimStatus, EmailDomains, EmailUsernames, MembershipStatus, MultiDirectoryUser, MultiDirectoryUserPage, MultiDirectoryUserRoleAssignment, MultiDirectoryUserRoleAssignmentPage, MultiDirectoryUserStats, NamesOrNicknames, PlatformRole, Product, PublicUser, RoleIdCounts, Status, User, UserCounts, UserPage, UsersSearchPage, UsersSearchRequest } from "./models/users";
11
+ import type { AndOperator, EntitlementModelV2, FeatureFilter, FeatureModelV2, FieldOperand, MetaV2, NorOperator, PageDataResponseV2, PolicyFilter, PolicyModelV2, QueryVariants, Sandbox, SearchWorkspacesOperand, SearchWorkspacesRequestV2, SortField, WorkspaceModel } from "./models/workspaces";
12
+ import { DirectoryService } from "./services/DirectoryService";
13
+ import { DomainsService } from "./services/DomainsService";
14
+ import { EventsService } from "./services/EventsService";
15
+ import { GroupsService } from "./services/GroupsService";
16
+ import { OrgsService } from "./services/OrgsService";
17
+ import { PoliciesService } from "./services/PoliciesService";
18
+ import { UsersService } from "./services/UsersService";
19
+ import { ValidateService } from "./services/ValidateService";
20
+ import { WorkspacesService } from "./services/WorkspacesService";
21
+ type BaseOrganizationsApiClientOptions = Partial<commonHttpClient.CommonHttpClientOptions>;
22
+ /**
23
+ * API for Atlassian Access
24
+ *
25
+ * @version 1.0
26
+ * @internal
27
+ */
28
+ export declare class BaseOrganizationsApiClient extends CommonHttpService {
29
+ protected client: commonHttpClient.CommonHttpClient;
30
+ protected getClient: () => commonHttpClient.CommonHttpClient;
31
+ /**
32
+ * Org Directory APIs
33
+ *
34
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory
35
+ * @category Services
36
+ */
37
+ get directory(): DirectoryService;
38
+ /**
39
+ * Domain APIs
40
+ *
41
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-domains
42
+ * @category Services
43
+ */
44
+ get domains(): DomainsService;
45
+ /**
46
+ * Events APIs
47
+ *
48
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-events
49
+ * @category Services
50
+ */
51
+ get events(): EventsService;
52
+ /**
53
+ * Orgs Groups APIs
54
+ *
55
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups
56
+ * @category Services
57
+ */
58
+ get groups(): GroupsService;
59
+ /**
60
+ * Orgs APIs
61
+ *
62
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs
63
+ * @category Services
64
+ */
65
+ get orgs(): OrgsService;
66
+ /**
67
+ * Policies APIs
68
+ *
69
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-policies
70
+ * @category Services
71
+ */
72
+ get policies(): PoliciesService;
73
+ /**
74
+ * Orgs Users APIs
75
+ *
76
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users
77
+ * @category Services
78
+ */
79
+ get users(): UsersService;
80
+ /**
81
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-validate
82
+ * @category Services
83
+ */
84
+ get validate(): ValidateService;
85
+ /**
86
+ * Org Workspaces APIs
87
+ *
88
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces
89
+ * @category Services
90
+ */
91
+ get workspaces(): WorkspacesService;
92
+ constructor(options?: BaseOrganizationsApiClientOptions);
93
+ }
94
+ export type { AccountStatus, AccountStatusCounts, AccountType, ClaimStatus, EmailDomains, EmailUsernames, MembershipStatus, MultiDirectoryUser, MultiDirectoryUserPage, MultiDirectoryUserRoleAssignment, MultiDirectoryUserRoleAssignmentPage, MultiDirectoryUserStats, NamesOrNicknames, PlatformRole, Product, PublicUser, RoleIdCounts, Status, User, UserCounts, UserPage, UsersSearchPage, UsersSearchRequest, AddGroupMembershipInput, ApiError, ApiErrorResponse, CreateGroupInput, CursorNextPageModel, GroupRoleAssignmentInput, InviteApiRequest, RoleApiRequest, RoleAssociation, UserProductAccessActivityPage, UserProductAccessModel, UserProductLastActive, AllowIfContainedRule, ErrorInvalidResourceModel, ErrorPolicyNotFoundModel, ErrorPolicyResourceNotFoundModel, Links, Meta, Policy, PolicyCreateInput, PolicyCreateModel, PolicyModel, PolicyPage, PolicyUpdateInput, PolicyUpdateModel, Resource, ResourceInput, ResourceUpdateInput, AndOperator, EntitlementModelV2, FeatureFilter, FeatureModelV2, FieldOperand, MetaV2, NorOperator, PageDataResponseV2, PolicyFilter, PolicyModelV2, QueryVariants, Sandbox, SearchWorkspacesOperand, SearchWorkspacesRequestV2, SortField, WorkspaceModel, ApplicationError, ErrorCdenPolicyValidationFailedModel, ErrorInternalErrorModel, ErrorInvalidPageCursorModel, ErrorOrgNotFoundModel, Errors, ErrorsApplicationErrorsModel, LinkPageCursor, LinkPageModel, LinkSelfCursor, LinkSelfModel, ProxyError, ResourceId, ResourceOwner, RoleIds, Domain, DomainModel, DomainPage, ErrorDomainNotFoundModel, ErrorNoPermsModel, Error, GroupCounts, GroupNames, GroupsSearchPage, GroupsSearchRequest, GroupTotalCounts, GroupType, GroupTypeCounts, MultiDirectoryGroup, MultiDirectoryGroupDetails, MultiDirectoryGroupPage, MultiDirectoryGroupRoleAssignment, MultiDirectoryGroupRoleAssignmentPage, MultiDirectoryGroupStats, PublicGroup, RoleAssignment, ErrorEventNotFoundModel, ErrorInvalidQueryCountModel, ErrorInvalidRequestSyntaxModel, ErrorInvalidSearchTimeDateModel, Event, EventActionModel, EventActions, EventActorModel, EventLocationModel, EventMessageModel, EventModel, EventObjectModel, EventPage, LinkAltModel, LinkSelfAltModel, PollingEventModel, PollingEventPage, LinkRelatedModel, Org, OrgModel, OrgPage };
@@ -0,0 +1,127 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BaseOrganizationsApiClient = 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 DirectoryService_1 = require("./services/DirectoryService");
10
+ const DomainsService_1 = require("./services/DomainsService");
11
+ const EventsService_1 = require("./services/EventsService");
12
+ const GroupsService_1 = require("./services/GroupsService");
13
+ const OrgsService_1 = require("./services/OrgsService");
14
+ const PoliciesService_1 = require("./services/PoliciesService");
15
+ const UsersService_1 = require("./services/UsersService");
16
+ const ValidateService_1 = require("./services/ValidateService");
17
+ const WorkspacesService_1 = require("./services/WorkspacesService");
18
+ const validationSchemaStorage_1 = require("./validationSchemaStorage");
19
+ /** Error class for undefined */
20
+ class BaseOrganizationsApiClientError extends commonHttpClient.CommonHttpClientError {
21
+ constructor() {
22
+ super(...arguments);
23
+ this.name = "BaseOrganizationsApiClientError";
24
+ }
25
+ }
26
+ /**
27
+ * API for Atlassian Access
28
+ *
29
+ * @version 1.0
30
+ * @internal
31
+ */
32
+ class BaseOrganizationsApiClient extends CommonHttpService_1.CommonHttpService {
33
+ /**
34
+ * Org Directory APIs
35
+ *
36
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory
37
+ * @category Services
38
+ */
39
+ get directory() {
40
+ return this.getServiceInstance(DirectoryService_1.DirectoryService);
41
+ }
42
+ /**
43
+ * Domain APIs
44
+ *
45
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-domains
46
+ * @category Services
47
+ */
48
+ get domains() {
49
+ return this.getServiceInstance(DomainsService_1.DomainsService);
50
+ }
51
+ /**
52
+ * Events APIs
53
+ *
54
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-events
55
+ * @category Services
56
+ */
57
+ get events() {
58
+ return this.getServiceInstance(EventsService_1.EventsService);
59
+ }
60
+ /**
61
+ * Orgs Groups APIs
62
+ *
63
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups
64
+ * @category Services
65
+ */
66
+ get groups() {
67
+ return this.getServiceInstance(GroupsService_1.GroupsService);
68
+ }
69
+ /**
70
+ * Orgs APIs
71
+ *
72
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-orgs
73
+ * @category Services
74
+ */
75
+ get orgs() {
76
+ return this.getServiceInstance(OrgsService_1.OrgsService);
77
+ }
78
+ /**
79
+ * Policies APIs
80
+ *
81
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-policies
82
+ * @category Services
83
+ */
84
+ get policies() {
85
+ return this.getServiceInstance(PoliciesService_1.PoliciesService);
86
+ }
87
+ /**
88
+ * Orgs Users APIs
89
+ *
90
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users
91
+ * @category Services
92
+ */
93
+ get users() {
94
+ return this.getServiceInstance(UsersService_1.UsersService);
95
+ }
96
+ /**
97
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-validate
98
+ * @category Services
99
+ */
100
+ get validate() {
101
+ return this.getServiceInstance(ValidateService_1.ValidateService);
102
+ }
103
+ /**
104
+ * Org Workspaces APIs
105
+ *
106
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces
107
+ * @category Services
108
+ */
109
+ get workspaces() {
110
+ return this.getServiceInstance(WorkspacesService_1.WorkspacesService);
111
+ }
112
+ constructor(options) {
113
+ var _a;
114
+ super(() => this.client);
115
+ this.client = new commonHttpClient.CommonHttpClient({
116
+ apiClientClassName: (_a = this.constructor.name) !== null && _a !== void 0 ? _a : "name",
117
+ baseUrl: "https://api.atlassian.com/admin",
118
+ binaryResponseType: "blob",
119
+ errorClass: BaseOrganizationsApiClientError
120
+ });
121
+ this.getClient = () => this.client;
122
+ this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));
123
+ }
124
+ }
125
+ exports.BaseOrganizationsApiClient = BaseOrganizationsApiClient;
126
+ validationSchemaStorage_1.validationSchemaStorage.setErrorClass(BaseOrganizationsApiClientError);
127
+ //# sourceMappingURL=BaseOrganizationsApiClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BaseOrganizationsApiClient.js","sourceRoot":"","sources":["../../../src/openapi/organizations/BaseOrganizationsApiClient.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6DAA6D;AAC7D,iEAA8D;AAU9D,kEAA+D;AAC/D,8DAA2D;AAC3D,4DAAyD;AACzD,4DAAyD;AACzD,wDAAqD;AACrD,gEAA6D;AAC7D,0DAAuD;AACvD,gEAA6D;AAC7D,oEAAiE;AACjE,uEAAoE;AAEpE,gCAAgC;AAChC,MAAM,+BAAgC,SAAQ,gBAAgB,CAAC,qBAAqB;IAApF;;QACE,SAAI,GAAG,iCAAiC,CAAC;IAC3C,CAAC;CAAA;AACD;;;;;GAKG;AACH,MAAa,0BAA2B,SAAQ,qCAAiB;IAQ/D;;;;;OAKG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,kBAAkB,CAAC,mCAAgB,CAAC,CAAC;IACnD,CAAC;IACD;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,kBAAkB,CAAC,+BAAc,CAAC,CAAC;IACjD,CAAC;IACD;;;;;OAKG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD;;;;;OAKG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD;;;;;OAKG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,kBAAkB,CAAC,yBAAW,CAAC,CAAC;IAC9C,CAAC;IACD;;;;;OAKG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD;;;;;OAKG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD;;;;;OAKG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,kBAAkB,CAAC,qCAAiB,CAAC,CAAC;IACpD,CAAC;IACD,YAAY,OAA2C;;QACrD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAvFjB,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YACvD,kBAAkB,EAAE,MAAA,IAAI,CAAC,WAAW,CAAC,IAAI,mCAAI,MAAM;YACnD,OAAO,EAAE,iCAAiC;YAC1C,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,+BAA+B;SAC5C,CAAC,CAAC;QACO,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAkFtC,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;CACF;AA9FD,gEA8FC;AACD,iDAAuB,CAAC,aAAa,CAAC,+BAA+B,CAAC,CAAC"}
@@ -0,0 +1,222 @@
1
+ import type { CommonValidationSchemaStorage } from "../../core/CommonValidationSchemaStorage";
2
+ import { type Error } from "./groups";
3
+ import { type ZodTypeAny } from "zod";
4
+ /** @category Models */
5
+ export interface ApplicationError extends Record<string, unknown> {
6
+ /** A unique identifier for this particular occurrence of the error. */
7
+ id?: string;
8
+ /** The HTTP status code applicable to this error. */
9
+ status?: string;
10
+ /**
11
+ * An application-specific error code:
12
+ * - `ADMIN-400-1` - Invalid page cursor
13
+ * - `ADMIN-400-2` - Invalid domain identifier
14
+ * - `ADMIN-400-3` - Invalid time date
15
+ * - `ADMIN-400-4` - Invalid resource
16
+ * - `ADMIN-400-24` - Invalid request body
17
+ * - `ADMIN-400-32` - Too many license breaches
18
+ * - `ADMIN-403-3` - Not allowed to manage the org
19
+ * - `ADMIN-403-5` - Not allowed to manage the group
20
+ * - `ADMIN-403-6` - Not allowed to delete group with default-role attribute
21
+ * - `ADMIN-403-7` - Not allowed to delete group which grants admin access to a
22
+ * product or org
23
+ * - `ADMIN-404-1` - Unknown resource
24
+ * - `ADMIN-404-2` - Organization not found
25
+ * - `ADMIN-404-3` - Domain not found
26
+ * - `ADMIN-404-4` - Event not found
27
+ * - `ADMIN-404-5` - Policy not found
28
+ * - `ADMIN-404-8` - User not found
29
+ * - `ADMIN-404-10` - Group not found
30
+ * - `ADMIN-405-1` - Method not supported
31
+ * - `ADMIN-409-3` - License limit exceeded
32
+ * - `ADMIN-409-5` - Group not empty
33
+ * - `ADMIN-429-1` - Rate limit exceeded
34
+ * - `ADMIN-500-1` - Internal error
35
+ *
36
+ * @example
37
+ * ```
38
+ * ADMIN-XXX-X
39
+ * ```
40
+ */
41
+ code?: string;
42
+ /** Human-readable summary of the error. */
43
+ title?: string;
44
+ /**
45
+ * Human-readable explanation specific to this occurrence of the error, and a
46
+ * suggested action to resolve it.
47
+ */
48
+ detail?: string;
49
+ }
50
+ /**
51
+ * CDEN policy validation failed
52
+ *
53
+ * @category Models
54
+ */
55
+ export interface ErrorCdenPolicyValidationFailedModel extends Record<string, unknown> {
56
+ errors?: (ApplicationError & ({
57
+ code?: "ADMIN-500-2";
58
+ } & {
59
+ [key: string]: unknown;
60
+ }))[];
61
+ }
62
+ /**
63
+ * Internal error
64
+ *
65
+ * @category Models
66
+ */
67
+ export interface ErrorInternalErrorModel extends Record<string, unknown> {
68
+ errors?: (ApplicationError & ({
69
+ code?: "ADMIN-500-1";
70
+ } & {
71
+ [key: string]: unknown;
72
+ }))[];
73
+ }
74
+ /**
75
+ * Invalid page cursor
76
+ *
77
+ * @category Models
78
+ */
79
+ export interface ErrorInvalidPageCursorModel extends Record<string, unknown> {
80
+ errors?: (ApplicationError & ({
81
+ code?: "ADMIN-400-1";
82
+ } & {
83
+ [key: string]: unknown;
84
+ }))[];
85
+ }
86
+ /**
87
+ * Organization not found
88
+ *
89
+ * @category Models
90
+ */
91
+ export interface ErrorOrgNotFoundModel extends Record<string, unknown> {
92
+ errors?: (ApplicationError & ({
93
+ code?: "ADMIN-404-2";
94
+ } & {
95
+ [key: string]: unknown;
96
+ }))[];
97
+ }
98
+ /** @category Models */
99
+ export interface Errors extends Record<string, unknown> {
100
+ errors?: Error[];
101
+ }
102
+ /**
103
+ * ApplicationErrors
104
+ *
105
+ * A list of application errors
106
+ *
107
+ * @category Models
108
+ */
109
+ export interface ErrorsApplicationErrorsModel extends Record<string, unknown> {
110
+ errors?: ApplicationError[];
111
+ }
112
+ /**
113
+ * Links for a paginated response, for use in a cursor parameter.
114
+ *
115
+ * @category Models
116
+ */
117
+ export interface LinkPageCursor extends Record<string, unknown> {
118
+ /**
119
+ * Cursor to fetch this page.
120
+ *
121
+ * @example
122
+ * ```
123
+ * ObSbZxpM1f1fzia2_GnuJw
124
+ * ```
125
+ */
126
+ self?: string;
127
+ /**
128
+ * Cursor to fetch the previous page.
129
+ *
130
+ * @example
131
+ * ```
132
+ * LIZFEbzCT2pCCkQhPIUgIQ
133
+ * ```
134
+ */
135
+ prev?: string;
136
+ /**
137
+ * Cursor to fetch the next page.
138
+ *
139
+ * @example
140
+ * ```
141
+ * kloHX1ZQVasDAkx_P48NYQ
142
+ * ```
143
+ */
144
+ next?: string;
145
+ }
146
+ /**
147
+ * Links for a Paginated response
148
+ *
149
+ * @category Models
150
+ */
151
+ export interface LinkPageModel extends Record<string, unknown> {
152
+ /** URL to fetch this Page */
153
+ self?: string;
154
+ /** URL to fetch the Previous Page */
155
+ prev?: string;
156
+ /** URL to fetch the Next Page */
157
+ next?: string;
158
+ }
159
+ /**
160
+ * Links for a resource with a self cursor, for use in a cursor parameter.
161
+ *
162
+ * @category Models
163
+ */
164
+ export interface LinkSelfCursor extends Record<string, unknown> {
165
+ /**
166
+ * Cursor to fetch this resource.
167
+ *
168
+ * @example
169
+ * ```
170
+ * ECg53CukK1twBo0LK1u9nw
171
+ * ```
172
+ */
173
+ self?: string;
174
+ }
175
+ /** @category Models */
176
+ export interface LinkSelfModel extends Record<string, unknown> {
177
+ /** URL to fetch this resource */
178
+ self: string;
179
+ }
180
+ /** @category Models */
181
+ export interface ProxyError extends Record<string, unknown> {
182
+ /** The HTTP status code applicable to this error. */
183
+ code?: number;
184
+ /** Human-readable explanation of the error. */
185
+ message?: string;
186
+ }
187
+ /**
188
+ * The resource ID from the role assignment relationship. The resource ID is in
189
+ * the Atlassian Resource Identifier (ARI) format.
190
+ *
191
+ * @example
192
+ * ```
193
+ * ari:cloud:jira-core::site/1
194
+ * ```
195
+ * @category Models
196
+ */
197
+ export type ResourceId = string;
198
+ /**
199
+ * The resource owner of the product.
200
+ *
201
+ * @example
202
+ * ```
203
+ * jira-core
204
+ * ```
205
+ * @category Models
206
+ */
207
+ export type ResourceOwner = string;
208
+ /**
209
+ * A list of role IDs. The Atlassian canonical roles are used to determine the
210
+ * permissions of the user against resources within the organization.
211
+ *
212
+ * @example
213
+ * ```
214
+ * [
215
+ * "atlassian/org-admin",
216
+ * "atlassian/site-admin"
217
+ * ]
218
+ * ```
219
+ * @category Models
220
+ */
221
+ export type RoleIds = string[];
222
+ export declare function registerCommonValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;