@extrahorizon/javascript-sdk 8.2.0 → 8.2.1-dev-49-61b4511

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

@@ -1,40 +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;
-}
+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

@@ -1,39 +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;
-}
+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

@@ -1,5 +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;
+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

@@ -1,121 +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 {};
+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

@@ -1,5 +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;
+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

@@ -1,5 +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;
+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

@@ -1,10 +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;
+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

@@ -1,5 +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;
+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

@@ -1,5 +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;
+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;