@extrahorizon/javascript-sdk 8.2.0-test

package/build/types/services/auth/oidc/providers/types.d.ts

@@ -0,0 +1,144 @@
+import { FindAllIterator } from '../../../helpers';
+import { AffectedRecords, OptionsWithRql, PagedResultWithPager } from '../../../types';
+export interface OidcProviderService {
+    /**
+     * ## Create a new OpenID Connect Provider
+     * ### You can use this function to create a new OpenId Connect Provider to enable Single Sign On.
+     *
+     * **Global Permissions:**
+     * `CREATE_OIDC_PROVIDER` - Allows a user to create a new OpenID Connect Provider
+     *
+     * @param body {@link OidcProviderCreation}
+     * @returns OidcProvider {@link OidcProvider}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    create(body: OidcProviderCreation): Promise<OidcProvider>;
+    /**
+     * ## Retrieve a paged list of OpenID Connect providers
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of providers {@link PagedResultWithPager PagedResultWithPager<OidcProvider>}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<OidcProvider>>;
+    /**
+     * ## Retrieve a list of all OpenID Connect providers
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of providers {@link OidcProvider OidcProvider[]}
+     * @throws {@link Error} Do not pass in limit operator with findAll
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    findAll(options?: OptionsWithRql): Promise<OidcProvider[]>;
+    /**
+     * ## Retrieve a paged list of OpenID Connect providers
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried providers {@link FindAllIterator FindAllIterator<OidcProvider>}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<OidcProvider>;
+    /**
+     * ## Retrieve the first queried OpenID Connect provider
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried providers {@link OidcProvider}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    findFirst(options?: OptionsWithRql): Promise<OidcProvider>;
+    /**
+     * ## Update an OpenID Connect provider
+     * ### You can use this function to update an existing OpenId Connect Provider. Fields left undefined will not be updated.
+     *
+     * **Global Permissions:**
+     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
+     *
+     * @param providerId {@link string} - The Extra Horizon provider id
+     * @param body {@link OidcProviderUpdate} - The set of updatable fields for an existing provider
+     * @returns An affected records promise {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    update(providerId: string, body: OidcProviderUpdate): Promise<AffectedRecords>;
+    /**
+     * ## Delete an OpenID Connect provider
+     * ### You can use this function to delete an existing OpenId Connect provider.
+     *
+     * **Global Permissions:**
+     * - `DELETE_OIDC_PROVIDER` - Allows a user to delete an OpenID Connect provider
+     *
+     * @param providerId {@link string} - The Extra Horizon provider id
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     * @throws {@link IllegalStateError} when the provider is enabled (Only disabled providers can be removed) or when there are still users linked to this provider.
+     */
+    delete(providerId: string): Promise<AffectedRecords>;
+    /**
+     * ## Enable an OpenID Connect provider
+     *
+     * **Global Permissions:**
+     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
+     *
+     * @param providerId {@link string} - The Extra Horizon provider id
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     */
+    enable(providerId: string): Promise<AffectedRecords>;
+    /**
+     * ## Disable an OpenID Connect provider
+     *
+     * **Global Permissions:**
+     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
+     *
+     * @param providerId - The Extra Horizon provider id
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     */
+    disable(providerId: string): Promise<AffectedRecords>;
+}
+export interface OidcProvider {
+    /** A 24 character long hexadecimal value acting as the identifier of an OpenId Connect provider */
+    id: string;
+    /** Human friendly name of the provider, which can also be used in the oidc login url. Then name can be between 3 and 40 characters and match pattern: '/^[a-zA-Z0-9_-]+$/' */
+    name: string;
+    /** Description of the provider. With a maximum of 256 characters */
+    description: string;
+    /** Provided by the OpenID Connect provider after registration. With a maximum of 2048 characters */
+    clientId: string;
+    /** A URL of maximum 2048 charactes that acts as a unique identifier for the provider. `Issuer` in the provider's discovery document. */
+    issuerId: string;
+    /** A URL of maximum 2048 character that points to the provider’s URL for authorising the user (i.e., signing the user in). authorization_endpoint in the provider's discovery document. */
+    authorizationEndpoint: string;
+    /** A URL of maximum 2048 character that points to the provider’s OAuth 2.0 protected URL from which user information can be obtained. token_endpoint in the provider's discovery document. */
+    tokenEndpoint: string;
+    /** A URL of maximum 2048 character that points to the provider’s endpoint of the authorization server Extra Horizon can use to obtain the email address and optionally also the family name and given name. userinfo_endpoint in the provider's discovery document. */
+    userinfoEndpoint: string;
+    /** A URL of maximum 2048 character that points to the location where the authorization server sends the user once the app has been successfully authorised and granted an authorization code or access token */
+    redirectUri: string;
+    /** Indicates wether the OpenID Connect provider is active and can be used for SSO */
+    enabled: boolean;
+    /** The last four characters of the client secret */
+    clientSecretHint: string;
+    /** The creation timestamp of the OpenID Connectprovider */
+    creationTimestamp: Date;
+    /** The update timestamp of the OpenID Connect provider */
+    updateTimestamp: Date;
+}
+export interface OidcProviderCreation extends Required<Pick<OidcProvider, 'name' | 'description' | 'clientId' | 'authorizationEndpoint' | 'redirectUri' | 'tokenEndpoint' | 'userinfoEndpoint' | 'issuerId'>> {
+    /** The OAuth 2.0 Client Secret you received from your provider. Max 2048 characters */
+    clientSecret: string;
+}
+export declare type OidcProviderUpdate = Partial<OidcProviderCreation>;

package/build/types/services/auth/oidc/types.d.ts

@@ -0,0 +1,40 @@
+import { AffectedRecords } from '../../types';
+import { LoginAttemptsService } from './loginAttempts/types';
+import { OidcProviderService } from './providers/types';
+export * from './loginAttempts/types';
+export * from './providers/types';
+export interface OidcService {
+    /**
+     * ## Link the authenticated user to a provider
+     * ### You can use this function to link the currently logged-in user to a registered provider.
+     *
+     * **Default Permissions:**
+     * - Any authenticated user can execute this function.
+     *
+     * @param providerName {@link string} The name of the OpenID Connect provider to link the user to
+     * @param data {@link OidcLinkRequestBody} - The link to OpenID Connect provider data
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link IllegalStateError} when the provider is disabled. The provider must be enabled to link a user.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerName.
+     */
+    linkUserToOidcProvider(providerName: string, data: OidcLinkRequestBody): Promise<AffectedRecords>;
+    /**
+     * ## Unlink a user from OpenID Connect
+     * ### You can use this function to unlink a user from an OpenId Connect Provider.
+     *
+     * **Global Permissions:**
+     * - `UNLINK_USER_FROM_OIDC` - Allows a user to unlink users from OpenID Connect
+     *
+     * @param userId {@link string} - The Extra Horizon id of the user to be unlinked from OpenID Connect
+     * @returns An affected records response {@link AffectedRecords}
+     */
+    unlinkUserFromOidc(userId: string): Promise<AffectedRecords>;
+    providers: OidcProviderService;
+    loginAttempts: LoginAttemptsService;
+}
+export interface OidcLinkRequestBody {
+    /** ### The users Extra Horizon presence token - Obtained from {@link AuthService.confirmPresence confirmPresence} */
+    presenceToken: string;
+    /** ### Obtained from the OpenID Connect application upon successful user login. */
+    authorizationCode: string;
+}

package/build/types/services/auth/types.d.ts

@@ -0,0 +1,39 @@
+import { OptionsBase } from '../types';
+import { AuthApplicationsService } from './applications/types';
+import { AuthOauth1Service } from './oauth1/types';
+import { AuthOauth2Service } from './oauth2/types';
+import { OidcService } from './oidc/types';
+import { AuthUsersService } from './users/types';
+export * from './applications/types';
+export * from './oauth1/types';
+export * from './oauth2/types';
+export * from './oidc/types';
+export * from './users/types';
+export interface AuthService {
+    /**
+     * # Applications
+     * Applications represent mobile apps, web apps, web services or scripts that can communicate with the Extra Horizon API.
+     *
+     * ### Default applications
+     * When launching a new cluster two default applications are already created for you:
+     *
+     * **ExH Control center**: An oAuth2 app that gives our control center (available on  [app.extrahorizon.com](app.extrahorizon.com)) the ability to communicate with your cluster. You as an admin can use this app to explore and manage your cluster.
+     *
+     * **CLI**: An oAuth1.0 application that you can use when installing our CLI in order to send configurations to your cluster. Credentials are provided to your cluster manager during onboarding.
+     */
+    applications: AuthApplicationsService;
+    oauth2: AuthOauth2Service;
+    oauth1: AuthOauth1Service;
+    users: AuthUsersService;
+    oidc: OidcService;
+    confirmPresence(data: {
+        password: string;
+    }, options?: OptionsBase): Promise<Presence>;
+    health(): Promise<boolean>;
+}
+export { AuthApplicationsService };
+export interface Presence {
+    token: string;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}

package/build/types/services/auth/users/index.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import type { AuthUsersService } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => AuthUsersService;
+export default _default;

package/build/types/services/auth/users/types.d.ts

@@ -0,0 +1,121 @@
+import { AffectedRecords, OptionsBase } from '../../types';
+export interface AuthUsersService {
+    /**
+     * View the MFA settings of a user (or create the settings if they have none)
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | See your own MFA settings
+     * `VIEW_USER_MFA_SETTINGS` | global | See anyone their MFA settings
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/MFA/get_mfa_users__userId_
+     */
+    getMfaSetting(userId: string, options?: OptionsBase): Promise<MfaSetting>;
+    /**
+     * Enable MFA for a user
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Enable MFA for your own account
+     * `UPDATE_USER_MFA_SETTINGS` | global | Enable MFA for any account
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/MFA/post_mfa_users__userId__enable
+     * @throws {InvalidPresenceTokenError}
+     * @throws {NotEnoughMfaMethodsError}
+     */
+    enableMfa(userId: string, data: PresenceToken, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Disable MFA for a user
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Disable MFA for your own account
+     * `UPDATE_USER_MFA_SETTINGS` | global | Enable MFA for any account
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/MFA/post_mfa_users__userId__disable
+     * @throws {InvalidPresenceTokenError}
+     */
+    disableMfa(userId: string, data: PresenceToken, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Add a MFA method to a user
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Add a MFA method to your user
+     * `UPDATE_USER_MFA_SETTINGS` | global | Enable MFA for any account
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/MFA/post_mfa_users__userId__disable
+     * @throws {InvalidPresenceTokenError}
+     */
+    addMfaMethod<T extends RecoveryCodesMethodCreation | TotpMethodCreation>(userId: string, data: T, options?: OptionsBase): Promise<T extends RecoveryCodesMethodCreation ? RecoveryCodesMethod : TotpMethod>;
+    /**
+     * Confirm the correct functioning of a MFA method
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Confirm a MFA method for your user
+     * `UPDATE_USER_MFA_SETTINGS` | global | Confirm a MFA method for any user
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/MFA/post_mfa_users__userId__methods__methodId__verification_confirm
+     * @throws {ResourceUnknownError}
+     * @throws {IllegalArgumentError}
+     * @throws {InvalidMfaCodeError}
+     * @throws {InvalidPresenceTokenError}
+     */
+    confirmMfaMethodVerification(userId: string, methodId: string, data: MfaMethodVerification, options?: OptionsBase): Promise<{
+        description: string;
+    }>;
+    /**
+     * Remove a MFA method from a user
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Remove a MFA method for your user
+     * `UPDATE_USER_MFA_SETTINGS` | global | Enable MFA for any account
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/MFA/post_mfa_users__userId__methods__methodId__remove
+     * @throws {NotEnoughMfaMethodsError}
+     * @throws {InvalidPresenceTokenError}
+     */
+    removeMfaMethod(userId: string, methodId: string, data: PresenceToken, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface RecoveryCodesMethod {
+    id: string;
+    name: string;
+    tags: string[];
+    verified: boolean;
+    type: 'recoveryCodes';
+    codes: string[];
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}
+export interface TotpMethod {
+    id: string;
+    name: string;
+    tags: string[];
+    verified: boolean;
+    type: 'totp';
+    secret: string;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}
+export declare type MfaMethod = RecoveryCodesMethod | TotpMethod;
+export interface MfaSetting {
+    id: string;
+    methods: [MfaMethod];
+    enabled: boolean;
+    updateTimestamp: Date;
+}
+interface MfaMethodCreationBase {
+    presenceToken: string;
+    name?: string;
+    tags?: string[];
+}
+export interface RecoveryCodesMethodCreation extends MfaMethodCreationBase {
+    type: 'recoveryCodes';
+}
+export interface TotpMethodCreation extends MfaMethodCreationBase {
+    type: 'totp';
+}
+export interface MfaMethodVerification {
+    presenceToken: string;
+    code: string;
+}
+export interface PresenceToken {
+    presenceToken: string;
+}
+export {};

package/build/types/services/configurations/general.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { ConfigurationsGeneralService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsGeneralService;
+export default _default;

package/build/types/services/configurations/groups.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { ConfigurationsGroupsService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsGroupsService;
+export default _default;

package/build/types/services/configurations/index.d.ts

@@ -0,0 +1,10 @@
+import type { HttpInstance } from '../../types';
+import { ConfigurationsGeneralService, ConfigurationsGroupsService, ConfigurationsPatientsService, ConfigurationsStaffService, ConfigurationsUsersService } from './types';
+export declare type ConfigurationsService = {
+    general: ConfigurationsGeneralService;
+    groups: ConfigurationsGroupsService;
+    users: ConfigurationsUsersService;
+    patients: ConfigurationsPatientsService;
+    staff: ConfigurationsStaffService;
+};
+export declare const configurationsService: (httpWithAuth: HttpInstance) => ConfigurationsService;

package/build/types/services/configurations/patients.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { ConfigurationsPatientsService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsPatientsService;
+export default _default;

package/build/types/services/configurations/staff.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { ConfigurationsStaffService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsStaffService;
+export default _default;

package/build/types/services/configurations/types.d.ts

@@ -0,0 +1,222 @@
+import { Entity, Timestamps, ObjectId, AffectedRecords, OptionsBase, OptionsWithRql } from '../types';
+export declare type Configuration = Record<string, any>;
+export interface GeneralConfigurationInput {
+    data: Configuration;
+    staffConfiguration: Configuration;
+    patientConfiguration: Configuration;
+    groupConfiguration?: Configuration;
+    userConfiguration?: Configuration;
+}
+export declare type GeneralConfiguration = GeneralConfigurationInput & Entity & Timestamps;
+export interface GroupConfigurationInput {
+    data?: Configuration;
+    staffConfiguration?: Configuration;
+    patientConfiguration?: Configuration;
+}
+export declare type GroupConfiguration = GroupConfigurationInput & Entity & Timestamps;
+export interface UserConfigurationInput {
+    data: Configuration;
+}
+export interface UserEnlistments {
+    staffConfigurations?: Array<EnlistmentConfiguration>;
+    patientConfigurations?: Array<EnlistmentConfiguration>;
+}
+export interface EnlistmentConfiguration {
+    groupId: ObjectId;
+    data: Configuration;
+}
+export declare type UserConfiguration = UserConfigurationInput & UserEnlistments & Entity & Timestamps;
+export interface ConfigurationsGeneralService {
+    /**
+     * View the general configuration.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns GeneralConfiguration
+     */
+    get(options?: OptionsBase): Promise<GeneralConfiguration>;
+    /**
+     * Update the general configuration
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_CONFIGURATIONS` | `global` | Required for this endpoint
+     * @param requestBody GeneralConfigurationInput
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    update(requestBody: GeneralConfigurationInput, options?: OptionsWithRql): Promise<AffectedRecords>;
+    /**
+     * Delete fields from the general configuration.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_CONFIGURATIONS` | `global` | Required for this endpoint
+     * @param requestBody list of fields to remove
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    removeFields(requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsWithRql): Promise<AffectedRecords>;
+}
+export interface ConfigurationsGroupsService {
+    /**
+     * View a group configuration
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_PATIENT_CONFIGURATIONS` | `staff enlistment` | View the group its patient configuration
+     * `VIEW_STAFF_CONFIGURATIONS` | `staff enlistment` | View the group its staff configuration
+     * `VIEW_CONFIGURATIONS` | `staff enlistment` | View the group its full configuration
+     * `VIEW_CONFIGURATIONS` | `global` | View any group its full configuration
+     * @param groupId The id of the targeted group
+     * @returns GroupConfiguration
+     */
+    get(groupId: ObjectId, options?: OptionsBase): Promise<GroupConfiguration>;
+    /**
+     * Update a group configuration.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | Update the group its patient configuration
+     * `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | Update the group its staff configuration
+     * `UPDATE_CONFIGURATIONS` | `staff enlistment` | Update the group its full configuration
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any group its full configuration
+     * @param groupId The id of the targeted group
+     * @param requestBody GroupConfigurationInput
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    update(groupId: ObjectId, requestBody: GroupConfigurationInput, options?: OptionsWithRql): Promise<AffectedRecords>;
+    /**
+     * Delete fields from a group configuration.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | Update the group its patient configuration
+     * `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | Update the group its staff configuration
+     * `UPDATE_CONFIGURATIONS` | `staff enlistment` | Update the group its full configuration
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any group its full configuration
+     * @param groupId The id of the targeted group
+     * @param requestBody the list of fields to remove
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    removeFields(groupId: ObjectId, requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsWithRql): Promise<AffectedRecords>;
+}
+export interface ConfigurationsPatientsService {
+    /**
+     * Update a patient configuration for a group of a user.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
+     * @param groupId The id of the targeted group
+     * @param userId The id of the targeted user
+     * @param requestBody UserConfigurationInput
+     * @returns AffectedRecords
+     */
+    update(groupId: ObjectId, userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Delete fields from a patient configuration for a group of a user.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
+     * @param groupId The id of the targeted group
+     * @param userId The id of the targeted user
+     * @param requestBody the list of fields to remove
+     * @returns AffectedRecords
+     */
+    removeFields(groupId: ObjectId, userId: ObjectId, requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface ConfigurationsStaffService {
+    /**
+     * Update a staff configuration for a group of a user.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
+     * @param groupId The id of the targeted group
+     * @param userId The id of the targeted user
+     * @param requestBody UserConfigurationInput
+     * @returns AffectedRecords
+     */
+    update(groupId: ObjectId, userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Delete fields from a staff configuration for a group of a user.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
+     * @param groupId The id of the targeted group
+     * @param userId The id of the targeted user
+     * @param requestBody the list of fields to remove
+     * @returns AffectedRecords
+     */
+    removeFields(groupId: ObjectId, userId: ObjectId, requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export interface ConfigurationsUsersService {
+    /**
+     * Get a user configuration
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your own configuration
+     * `VIEW_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, view the patient enlistment configuration of the group
+     * `VIEW_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, view the staff enlistment configuration of the group
+     * `VIEW_CONFIGURATIONS` | `staff enlistment` | view the patient enlistment configuration of the group
+     * `VIEW_CONFIGURATIONS` | `global` | View any user its full configuration
+     * @param userId The id of the targeted user
+     * @returns UserConfiguration
+     */
+    get(userId: ObjectId, options?: OptionsBase): Promise<UserConfiguration>;
+    /**
+     * Update a user configuration
+     *
+     * Only the `data` content
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any user configuration
+     * none | | Update your own configuration
+     * @param userId The id of the targeted user
+     * @param requestBody UserConfigurationInput
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    update(userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsWithRql): Promise<AffectedRecords>;
+    /**
+     * Delete fields from a user configuration
+     *
+     * Only from the `data` field
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_CONFIGURATIONS` | `global` | Update any user configuration
+     * none | | Update your own configuration
+     * @param userId The id of the targeted user
+     * @param requestBody the list of fields to remove
+     * @param rql Add filters to the requested list
+     * @returns AffectedRecords
+     */
+    removeFields(userId: ObjectId, requestBody: {
+        fields: Array<string>;
+    }, options?: OptionsWithRql): Promise<AffectedRecords>;
+}

package/build/types/services/configurations/users.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import type { ConfigurationsUsersService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsUsersService;
+export default _default;

package/build/types/services/data/comments.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import { DataCommentsService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataCommentsService;
+export default _default;

package/build/types/services/data/documents.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import { DataDocumentsService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataDocumentsService;
+export default _default;

package/build/types/services/data/index.d.ts

@@ -0,0 +1,13 @@
+import type { HttpInstance } from '../../types';
+import infrastructure from './infrastructure';
+import { DataCommentsService, DataDocumentsService, DataIndexesService, DataPropertiesService, DataSchemasService, DataStatusesService, DataTransitionsService } from './types';
+export declare type DataService = ReturnType<typeof infrastructure> & {
+    schemas: DataSchemasService;
+    indexes: DataIndexesService;
+    statuses: DataStatusesService;
+    properties: DataPropertiesService;
+    comments: DataCommentsService;
+    documents: DataDocumentsService;
+    transitions: DataTransitionsService;
+};
+export declare const dataService: (httpWithAuth: HttpInstance) => DataService;

package/build/types/services/data/indexes.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../types';
+import { HttpClient } from '../http-client';
+import { DataIndexesService } from './types';
+declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataIndexesService;
+export default _default;