@thunderid/javascript 1.5.0 → 1.7.0

package/dist/api/management/secrets/updateSecret.d.ts

@@ -0,0 +1,30 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { Secret, SecretUpdateRequest } from '../../../models/variable-store';
+/**
+ * Configuration for the updateSecret request.
+ */
+export interface UpdateSecretConfig extends ManagementRequestConfig {
+    /**
+     * Name of the secret.
+     */
+    name: string;
+    /**
+     * The secret's new value.
+     */
+    payload: SecretUpdateRequest;
+}
+/**
+ * Sets or replaces a secret, creating it when it does not exist. The value is write-only: the server only
+ * says whether one is held, and the SDK never logs it.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the secret as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const secret = await updateSecret({baseUrl: 'https://localhost:8090', name: 'SMTP_HOST', payload: {value}});
+ * ```
+ */
+declare const updateSecret: ({ name, payload, ...config }: UpdateSecretConfig) => Promise<Secret>;
+export default updateSecret;
+//# sourceMappingURL=updateSecret.d.ts.map

package/dist/api/management/secrets/updateSecret.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateSecret.d.ts","sourceRoot":"","sources":["../../../../src/api/management/secrets/updateSecret.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,MAAM,EAAE,mBAAmB,EAAC,MAAM,gCAAgC,CAAC;AAG3E;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,YAAY,GAAU,8BAA4B,kBAAkB,KAAG,OAAO,CAAC,MAAM,CAQvF,CAAC;AAEL,eAAe,YAAY,CAAC"}

package/dist/api/management/server-config/getServerConfig.d.ts

@@ -0,0 +1,25 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ServerConfigLayers } from '../../../models/server-config';
+/**
+ * Configuration for the getServerConfig request.
+ */
+export interface GetServerConfigConfig extends ManagementRequestConfig {
+    /**
+     * Name of the configuration section, such as `flow`.
+     */
+    name: string;
+}
+/**
+ * Retrieves a server configuration section in its layers. `merged` is what the server applies.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the section.
+ *
+ * @example
+ * ```typescript
+ * const {merged} = await getServerConfig<{defaultEmailSenderId?: string}>({baseUrl: 'https://localhost:8090', name: 'notification'});
+ * ```
+ */
+declare const getServerConfig: <T = unknown>({ name, ...config }: GetServerConfigConfig) => Promise<ServerConfigLayers<T>>;
+export default getServerConfig;
+//# sourceMappingURL=getServerConfig.d.ts.map

package/dist/api/management/server-config/getServerConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getServerConfig.d.ts","sourceRoot":"","sources":["../../../../src/api/management/server-config/getServerConfig.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAGjE;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,eAAe,GAAU,CAAC,GAAG,OAAO,EAAE,qBAAmB,qBAAqB,KAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAOhH,CAAC;AAEL,eAAe,eAAe,CAAC"}

package/dist/api/management/server-config/getServerConfigs.d.ts

@@ -0,0 +1,19 @@
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the getServerConfigs request.
+ */
+export type GetServerConfigsConfig = ManagementRequestConfig;
+/**
+ * Retrieves the names of the server configuration sections.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the section names.
+ *
+ * @example
+ * ```typescript
+ * const sections = await getServerConfigs({baseUrl: 'https://localhost:8090'});
+ * ```
+ */
+declare const getServerConfigs: (config: GetServerConfigsConfig) => Promise<string[]>;
+export default getServerConfigs;
+//# sourceMappingURL=getServerConfigs.d.ts.map

package/dist/api/management/server-config/getServerConfigs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getServerConfigs.d.ts","sourceRoot":"","sources":["../../../../src/api/management/server-config/getServerConfigs.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,QAAA,MAAM,gBAAgB,GAAU,QAAQ,sBAAsB,KAAG,OAAO,CAAC,MAAM,EAAE,CAM7E,CAAC;AAEL,eAAe,gBAAgB,CAAC"}

package/dist/api/management/server-config/updateServerConfig.d.ts

@@ -0,0 +1,33 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ServerConfigLayers } from '../../../models/server-config';
+/**
+ * Configuration for the updateServerConfig request.
+ */
+export type UpdateServerConfigConfig<T = unknown> = ManagementRequestConfig & {
+    /**
+     * Name of the configuration section, such as `flow`.
+     */
+    name: string;
+    /**
+     * The section's new writable value.
+     */
+    payload: T;
+};
+/**
+ * Updates the writable layer of a server configuration section.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the section.
+ *
+ * @example
+ * ```typescript
+ * const {merged} = await updateServerConfig({
+ *   baseUrl: 'https://localhost:8090',
+ *   name: 'notification',
+ *   payload: {defaultEmailSenderId: connectionId},
+ * });
+ * ```
+ */
+declare const updateServerConfig: <T = unknown>({ name, payload, ...config }: UpdateServerConfigConfig<T>) => Promise<ServerConfigLayers<T>>;
+export default updateServerConfig;
+//# sourceMappingURL=updateServerConfig.d.ts.map

package/dist/api/management/server-config/updateServerConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateServerConfig.d.ts","sourceRoot":"","sources":["../../../../src/api/management/server-config/updateServerConfig.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAGjE;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,OAAO,IAAI,uBAAuB,GAAG;IAC5E;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,kBAAkB,GAAU,CAAC,GAAG,OAAO,EAAE,8BAI5C,wBAAwB,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAQ1D,CAAC;AAEL,eAAe,kBAAkB,CAAC"}

package/dist/api/management/user-types/createUserType.d.ts

@@ -0,0 +1,14 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CreateUserTypeRequest, ManagedUserTypeDetails } from '../../../models/entity-type';
+export interface CreateUserTypeConfig extends ManagementRequestConfig {
+    /**
+     * The user type to create.
+     */
+    payload: CreateUserTypeRequest;
+}
+/**
+ * Creates a user type.
+ */
+declare const createUserType: ({ payload, ...config }: CreateUserTypeConfig) => Promise<ManagedUserTypeDetails>;
+export default createUserType;
+//# sourceMappingURL=createUserType.d.ts.map

package/dist/api/management/user-types/createUserType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUserType.d.ts","sourceRoot":"","sources":["../../../../src/api/management/user-types/createUserType.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,qBAAqB,EAAE,sBAAsB,EAAC,MAAM,6BAA6B,CAAC;AAG1F,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED;;GAEG;AACH,QAAA,MAAM,cAAc,GAAU,wBAAsB,oBAAoB,KAAG,OAAO,CAAC,sBAAsB,CAOrG,CAAC;AAEL,eAAe,cAAc,CAAC"}

package/dist/api/management/user-types/deleteUserType.d.ts

@@ -0,0 +1,13 @@
+import { ManagementRequestConfig } from '../../../models/api';
+export interface DeleteUserTypeConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the user type to delete.
+     */
+    userTypeId: string;
+}
+/**
+ * Deletes a user type.
+ */
+declare const deleteUserType: ({ userTypeId, ...config }: DeleteUserTypeConfig) => Promise<void>;
+export default deleteUserType;
+//# sourceMappingURL=deleteUserType.d.ts.map

package/dist/api/management/user-types/deleteUserType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteUserType.d.ts","sourceRoot":"","sources":["../../../../src/api/management/user-types/deleteUserType.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,QAAA,MAAM,cAAc,GAAU,2BAAyB,oBAAoB,KAAG,OAAO,CAAC,IAAI,CAQzF,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/api/management/user-types/getUserType.d.ts

@@ -0,0 +1,14 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ManagedUserTypeDetails } from '../../../models/entity-type';
+export interface GetUserTypeConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the user type.
+     */
+    userTypeId: string;
+}
+/**
+ * Fetches a user type with its attribute schema.
+ */
+declare const getUserType: ({ userTypeId, ...config }: GetUserTypeConfig) => Promise<ManagedUserTypeDetails>;
+export default getUserType;
+//# sourceMappingURL=getUserType.d.ts.map

package/dist/api/management/user-types/getUserType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserType.d.ts","sourceRoot":"","sources":["../../../../src/api/management/user-types/getUserType.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,sBAAsB,EAAC,MAAM,6BAA6B,CAAC;AAGnE,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,QAAA,MAAM,WAAW,GAAU,2BAAyB,iBAAiB,KAAG,OAAO,CAAC,sBAAsB,CAQlG,CAAC;AAEL,eAAe,WAAW,CAAC"}

package/dist/api/{user-types → management/user-types}/getUserTypes.d.ts

@@ -1,5 +1,5 @@
-import { ApiFilteringParams, ManagementRequestConfig } from '../../models/api';
-import { ManagedUserTypeListResponse } from '../../models/managed-user-type';
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { ManagedUserTypeListResponse } from '../../../models/managed-user-type';
 /**
  * Configuration for the getUserTypes request.
  */

package/dist/api/management/user-types/getUserTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserTypes.d.ts","sourceRoot":"","sources":["../../../../src/api/management/user-types/getUserTypes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,2BAA2B,EAAC,MAAM,mCAAmC,CAAC;AAG9E;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC;AAExG;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,YAAY,GAAU,8BAA4B,kBAAkB,KAAG,OAAO,CAAC,2BAA2B,CAO5G,CAAC;AAEL,eAAe,YAAY,CAAC"}

package/dist/api/management/user-types/updateUserType.d.ts

@@ -0,0 +1,18 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ManagedUserTypeDetails, UpdateUserTypeRequest } from '../../../models/entity-type';
+export interface UpdateUserTypeConfig extends ManagementRequestConfig {
+    /**
+     * The user type's new state.
+     */
+    payload: UpdateUserTypeRequest;
+    /**
+     * Identifier of the user type.
+     */
+    userTypeId: string;
+}
+/**
+ * Updates a user type.
+ */
+declare const updateUserType: ({ payload, userTypeId, ...config }: UpdateUserTypeConfig) => Promise<ManagedUserTypeDetails>;
+export default updateUserType;
+//# sourceMappingURL=updateUserType.d.ts.map

package/dist/api/management/user-types/updateUserType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateUserType.d.ts","sourceRoot":"","sources":["../../../../src/api/management/user-types/updateUserType.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,sBAAsB,EAAE,qBAAqB,EAAC,MAAM,6BAA6B,CAAC;AAG1F,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,QAAA,MAAM,cAAc,GAAU,oCAI3B,oBAAoB,KAAG,OAAO,CAAC,sBAAsB,CAQpD,CAAC;AAEL,eAAe,cAAc,CAAC"}

package/dist/api/{users → management/users}/createUser.d.ts

@@ -1,5 +1,5 @@
-import { ManagementRequestConfig } from '../../models/api';
-import { CreateManagedUserRequest, ManagedUser } from '../../models/managed-user';
+import { ManagementRequestConfig } from '../../../models/api';
+import { CreateManagedUserRequest, ManagedUser } from '../../../models/managed-user';
 /**
  * Configuration for the createUser request.
  */

package/dist/api/management/users/createUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUser.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/createUser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,wBAAwB,EAAE,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAGnF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC/D;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,UAAU,GAAU,wBAAsB,gBAAgB,KAAG,OAAO,CAAC,WAAW,CAOlF,CAAC;AAEL,eAAe,UAAU,CAAC"}

package/dist/api/management/users/createUserByPath.d.ts

@@ -0,0 +1,34 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CreateUserByPathRequest, ManagedUser } from '../../../models/managed-user';
+/**
+ * Configuration for the createUserByPath request.
+ */
+export interface CreateUserByPathConfig extends ManagementRequestConfig {
+    /**
+     * Handle path of the organization unit, such as `engineering/platform`. Each handle is encoded and the
+     * slashes between them are kept.
+     */
+    path: string;
+    /**
+     * The user to create.
+     */
+    payload: CreateUserByPathRequest;
+}
+/**
+ * Creates a user in the organization unit at a handle path.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the user as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const user = await createUserByPath({
+ *   baseUrl: 'https://localhost:8090',
+ *   path: 'engineering/platform',
+ *   payload: {type: 'customer', attributes: {username: 'alice'}},
+ * });
+ * ```
+ */
+declare const createUserByPath: ({ path, payload, ...config }: CreateUserByPathConfig) => Promise<ManagedUser>;
+export default createUserByPath;
+//# sourceMappingURL=createUserByPath.d.ts.map

package/dist/api/management/users/createUserByPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUserByPath.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/createUserByPath.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,uBAAuB,EAAE,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAIlF;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACrE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAC;CAClC;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,gBAAgB,GAAU,8BAA4B,sBAAsB,KAAG,OAAO,CAAC,WAAW,CASpG,CAAC;AAEL,eAAe,gBAAgB,CAAC"}

package/dist/api/management/users/createUserSharingPolicy.d.ts

@@ -0,0 +1,33 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy, SharingPolicyRequest } from '../../../models/sharing-policy';
+/**
+ * Configuration for the createUserSharingPolicy request.
+ */
+export interface CreateUserSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * The policy to create.
+     */
+    payload: SharingPolicyRequest;
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Creates a sharing policy for a user: the organization units it reaches beyond its owner.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the policy as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const policy = await createUserSharingPolicy({
+ *   baseUrl: 'https://localhost:8090',
+ *   userId,
+ *   payload: {childUnits: {mode: 'all'}},
+ * });
+ * ```
+ */
+declare const createUserSharingPolicy: ({ payload, userId, ...config }: CreateUserSharingPolicyConfig) => Promise<SharingPolicy>;
+export default createUserSharingPolicy;
+//# sourceMappingURL=createUserSharingPolicy.d.ts.map

package/dist/api/management/users/createUserSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUserSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/createUserSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAE,oBAAoB,EAAC,MAAM,gCAAgC,CAAC;AAGnF;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,uBAAuB,GAAU,gCAIpC,6BAA6B,KAAG,OAAO,CAAC,aAAa,CASpD,CAAC;AAEL,eAAe,uBAAuB,CAAC"}

package/dist/api/management/users/deleteUser.d.ts

@@ -0,0 +1,15 @@
+import { AdministrationOptions } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+export interface DeleteUserConfig extends ManagementRequestConfig, AdministrationOptions {
+    /**
+     * Identifier of the user to delete.
+     */
+    userId: string;
+}
+/**
+ * Deletes a user. In `flow` mode the configured user deletion flow runs instead, revoking the user's
+ * grants and ending their sessions before the record goes.
+ */
+declare const deleteUser: ({ administrationMode, userId, ...config }: DeleteUserConfig) => Promise<void>;
+export default deleteUser;
+//# sourceMappingURL=deleteUser.d.ts.map

package/dist/api/management/users/deleteUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteUser.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/deleteUser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,qBAAqB,EAAC,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAI5D,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB,EAAE,qBAAqB;IACtF;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,QAAA,MAAM,UAAU,GAAU,2CAAyC,gBAAgB,KAAG,OAAO,CAAC,IAAI,CAqBjG,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/api/management/users/deleteUserSharingPolicy.d.ts

@@ -0,0 +1,28 @@
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the deleteUserSharingPolicy request.
+ */
+export interface DeleteUserSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the sharing policy.
+     */
+    policyId: string;
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Deletes a sharing policy of a user.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves once the server has made the change.
+ *
+ * @example
+ * ```typescript
+ * await deleteUserSharingPolicy({baseUrl: 'https://localhost:8090', userId, policyId});
+ * ```
+ */
+declare const deleteUserSharingPolicy: ({ policyId, userId, ...config }: DeleteUserSharingPolicyConfig) => Promise<void>;
+export default deleteUserSharingPolicy;
+//# sourceMappingURL=deleteUserSharingPolicy.d.ts.map

package/dist/api/management/users/deleteUserSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteUserSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/deleteUserSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAI5D;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,uBAAuB,GAAU,iCAA+B,6BAA6B,KAAG,OAAO,CAAC,IAAI,CASjH,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/dist/api/{users → management/users}/getUser.d.ts

@@ -1,5 +1,5 @@
-import { ManagementRequestConfig } from '../../models/api';
-import { ManagedUser } from '../../models/managed-user';
+import { ManagementRequestConfig } from '../../../models/api';
+import { ManagedUser } from '../../../models/managed-user';
 /**
  * Configuration for the getUser request.
  */

package/dist/api/management/users/getUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUser.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAGzD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,uBAAuB;IAC5D;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,OAAO,GAAU,uBAAqB,aAAa,KAAG,OAAO,CAAC,WAAW,CAQ3E,CAAC;AAEL,eAAe,OAAO,CAAC"}

package/dist/api/management/users/getUserGroups.d.ts

@@ -0,0 +1,25 @@
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { MembershipGroupListResponse } from '../../../models/group';
+/**
+ * Configuration for the getUserGroups request.
+ */
+export type GetUserGroupsConfig = ManagementRequestConfig & Pick<ApiFilteringParams, 'limit' | 'offset'> & {
+    /**
+     * Identifier of the user whose groups to list.
+     */
+    userId: string;
+};
+/**
+ * Retrieves a page of the groups a user belongs to.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the page the server returned.
+ *
+ * @example
+ * ```typescript
+ * const {groups} = await getUserGroups({baseUrl: 'https://localhost:8090', userId});
+ * ```
+ */
+declare const getUserGroups: ({ limit, offset, userId, ...config }: GetUserGroupsConfig) => Promise<MembershipGroupListResponse>;
+export default getUserGroups;
+//# sourceMappingURL=getUserGroups.d.ts.map

package/dist/api/management/users/getUserGroups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserGroups.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUserGroups.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AAGlE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GACvD,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEJ;;;;;;;;;;GAUG;AACH,QAAA,MAAM,aAAa,GAAU,sCAK1B,mBAAmB,KAAG,OAAO,CAAC,2BAA2B,CASxD,CAAC;AAEL,eAAe,aAAa,CAAC"}

package/dist/api/management/users/getUserOverlayRules.d.ts

@@ -0,0 +1,29 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ResolvedOverlay } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getUserOverlayRules request.
+ */
+export interface GetUserOverlayRulesConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the organization unit to resolve the rules for.
+     */
+    ouId: string;
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Retrieves the overlay rules that apply to a user in an organization unit.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the resolved overlay.
+ *
+ * @example
+ * ```typescript
+ * const {rules} = await getUserOverlayRules({baseUrl: 'https://localhost:8090', userId, ouId});
+ * ```
+ */
+declare const getUserOverlayRules: ({ ouId, userId, ...config }: GetUserOverlayRulesConfig) => Promise<ResolvedOverlay>;
+export default getUserOverlayRules;
+//# sourceMappingURL=getUserOverlayRules.d.ts.map

package/dist/api/management/users/getUserOverlayRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserOverlayRules.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUserOverlayRules.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAG/D;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,mBAAmB,GAAU,6BAA2B,yBAAyB,KAAG,OAAO,CAAC,eAAe,CAS7G,CAAC;AAEL,eAAe,mBAAmB,CAAC"}

package/dist/api/management/users/getUserSharingPolicies.d.ts

@@ -0,0 +1,25 @@
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicyListResponse } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getUserSharingPolicies request.
+ */
+export interface GetUserSharingPoliciesConfig extends ManagementRequestConfig, Pick<ApiFilteringParams, 'limit' | 'offset'> {
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Retrieves a page of the sharing policies of a user.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the page the server returned.
+ *
+ * @example
+ * ```typescript
+ * const {policies} = await getUserSharingPolicies({baseUrl: 'https://localhost:8090', userId});
+ * ```
+ */
+declare const getUserSharingPolicies: ({ limit, offset, userId, ...config }: GetUserSharingPoliciesConfig) => Promise<SharingPolicyListResponse>;
+export default getUserSharingPolicies;
+//# sourceMappingURL=getUserSharingPolicies.d.ts.map

package/dist/api/management/users/getUserSharingPolicies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserSharingPolicies.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUserSharingPolicies.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,yBAAyB,EAAC,MAAM,gCAAgC,CAAC;AAGzE;;GAEG;AACH,MAAM,WAAW,4BACf,SAAQ,uBAAuB,EAC7B,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,sBAAsB,GAAU,sCAKnC,4BAA4B,KAAG,OAAO,CAAC,yBAAyB,CAS/D,CAAC;AAEL,eAAe,sBAAsB,CAAC"}

package/dist/api/management/users/getUserSharingPolicy.d.ts

@@ -0,0 +1,29 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getUserSharingPolicy request.
+ */
+export interface GetUserSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the sharing policy.
+     */
+    policyId: string;
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Retrieves a sharing policy of a user.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the policy.
+ *
+ * @example
+ * ```typescript
+ * const policy = await getUserSharingPolicy({baseUrl: 'https://localhost:8090', userId, policyId});
+ * ```
+ */
+declare const getUserSharingPolicy: ({ policyId, userId, ...config }: GetUserSharingPolicyConfig) => Promise<SharingPolicy>;
+export default getUserSharingPolicy;
+//# sourceMappingURL=getUserSharingPolicy.d.ts.map

package/dist/api/management/users/getUserSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUserSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAI7D;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,oBAAoB,GAAU,iCAIjC,0BAA0B,KAAG,OAAO,CAAC,aAAa,CAQjD,CAAC;AAEL,eAAe,oBAAoB,CAAC"}

package/dist/api/management/users/getUserUsages.d.ts

@@ -0,0 +1,15 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { UserUsagesResponse } from '../../../models/managed-user';
+export interface GetUserUsagesConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Lists the resources that reference a user, such as agents that name the user as their owner, and
+ * what happens to each when the user is deleted.
+ */
+declare const getUserUsages: ({ userId, ...config }: GetUserUsagesConfig) => Promise<UserUsagesResponse>;
+export default getUserUsages;
+//# sourceMappingURL=getUserUsages.d.ts.map

package/dist/api/management/users/getUserUsages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserUsages.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUserUsages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAGhE,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,QAAA,MAAM,aAAa,GAAU,uBAAqB,mBAAmB,KAAG,OAAO,CAAC,kBAAkB,CAQ9F,CAAC;AAEL,eAAe,aAAa,CAAC"}

package/dist/api/{users → management/users}/getUsers.d.ts

@@ -1,5 +1,5 @@
-import { ApiFilteringParams, ManagementRequestConfig } from '../../models/api';
-import { ManagedUserListResponse } from '../../models/managed-user';
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { ManagedUserListResponse } from '../../../models/managed-user';
 /**
  * Configuration for the getUsers request.
  */

package/dist/api/management/users/getUsers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUsers.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUsers.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAGrE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,uBAAuB,GAAG,kBAAkB,CAAC;AAE1E;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,QAAQ,GAAU,sCAAoC,cAAc,KAAG,OAAO,CAAC,uBAAuB,CAOxG,CAAC;AAEL,eAAe,QAAQ,CAAC"}

package/dist/api/management/users/getUsersByPath.d.ts

@@ -0,0 +1,27 @@
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { ManagedUserListResponse } from '../../../models/managed-user';
+/**
+ * Configuration for the getUsersByPath request.
+ */
+export interface GetUsersByPathConfig extends ManagementRequestConfig, Pick<ApiFilteringParams, 'limit' | 'offset'> {
+    /**
+     * Handle path of the organization unit, such as `engineering/platform`. Each handle is encoded and the
+     * slashes between them are kept.
+     */
+    path: string;
+}
+/**
+ * Retrieves a page of the users in the organization unit at a handle path. Each user carries its resolved
+ * `display` value.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the page the server returned.
+ *
+ * @example
+ * ```typescript
+ * const {users} = await getUsersByPath({baseUrl: 'https://localhost:8090', path: 'engineering/platform', limit: 20});
+ * ```
+ */
+declare const getUsersByPath: ({ limit, offset, path, ...config }: GetUsersByPathConfig) => Promise<ManagedUserListResponse>;
+export default getUsersByPath;
+//# sourceMappingURL=getUsersByPath.d.ts.map

package/dist/api/management/users/getUsersByPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUsersByPath.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/getUsersByPath.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAIrE;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB,EAAE,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC;IACjH;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,cAAc,GAAU,oCAK3B,oBAAoB,KAAG,OAAO,CAAC,uBAAuB,CASrD,CAAC;AAEL,eAAe,cAAc,CAAC"}

package/dist/api/management/users/suspendUser.d.ts

@@ -0,0 +1,29 @@
+import { AccountLifecycleOptions, AccountLifecycleResult } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the suspendUser request.
+ */
+export interface SuspendUserConfig extends ManagementRequestConfig, AccountLifecycleOptions {
+    /**
+     * Identifier of the user.
+     */
+    userId: string;
+}
+/**
+ * Suspends a user, so they can no longer sign in, through the user suspension flow the server configures.
+ * The flow can end the user's sessions and notify them. There is no management API endpoint for this, so
+ * when no flow is configured the call fails with `suspendUser-NotConfiguredError-001`.
+ *
+ * @param config - Request configuration object. Running a flow needs `baseUrl`, and a token that may read
+ * the server configuration and run administration flows.
+ * @returns A promise that resolves with whether the flow's email step sent its notification, absent when
+ * the flow has no email step.
+ *
+ * @example
+ * ```typescript
+ * const {emailSent} = await suspendUser({baseUrl: 'https://localhost:8090', userId, operatorNote: 'Ticket 4521'});
+ * ```
+ */
+declare const suspendUser: ({ userId, operatorNote, ...config }: SuspendUserConfig) => Promise<AccountLifecycleResult>;
+export default suspendUser;
+//# sourceMappingURL=suspendUser.d.ts.map

package/dist/api/management/users/suspendUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suspendUser.d.ts","sourceRoot":"","sources":["../../../../src/api/management/users/suspendUser.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAE,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB,EAAE,uBAAuB;IACzF;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,WAAW,GAAU,qCAAmC,iBAAiB,KAAG,OAAO,CAAC,sBAAsB,CAO5G,CAAC;AAEL,eAAe,WAAW,CAAC"}