@extrahorizon/javascript-sdk 8.10.0 → 8.11.0-dev-168-bf985ec

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

@@ -32,21 +32,22 @@ export interface EventsService {
      * Permission | Scope | Effect
      * - | - | -
      * `VIEW_EVENTS` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<Event>
      */
     find(options?: OptionsWithRql): Promise<PagedResult<Event>>;
+    /**
+     * Returns a list of events
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_EVENTS` | `global` | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<Event[]>;
     /**
      * Find By Id
-     * @param id the Id to search for
-     * @param rql an optional rql string
-     * @returns the first element found
      */
     findById(id: ObjectId, options?: OptionsWithRql): Promise<Event | undefined>;
     /**
      * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
      */
     findFirst(options?: OptionsWithRql): Promise<Event | undefined>;
     /**
@@ -58,13 +59,10 @@ export interface EventsService {
      * Permission | Scope | Effect
      * - | - | -
      * `CREATE_EVENTS` | `global` | **Required** for this endpoint
-     * @param requestBody
-     * @returns Event
      */
     create(requestBody: CreateEvent, options?: CreateEventOptions): Promise<Event>;
     /**
      * Perform a health check
-     * @returns {boolean} success
      */
     health(): Promise<boolean>;
 }
@@ -75,21 +73,22 @@ export interface SubscriptionsService {
      * Permission | Scope | Effect
      * - | - | -
      * `VIEW_SUBSCRIPTIONS` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<Subscription>
      */
     find(options?: OptionsWithRql): Promise<PagedResult<Subscription>>;
+    /**
+     * Returns a list of event subscriptions
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_SUBSCRIPTIONS` | `global` | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<Subscription[]>;
     /**
      * Find By Id
-     * @param id the Id to search for
-     * @param rql an optional rql string
-     * @returns the first element found
      */
     findById(id: ObjectId, options?: OptionsWithRql): Promise<Subscription | undefined>;
     /**
      * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
      */
     findFirst(options?: OptionsWithRql): Promise<Subscription | undefined>;
     /**
@@ -100,8 +99,6 @@ export interface SubscriptionsService {
      * Permission | Scope | Effect
      * - | - | -
      * `CREATE_SUBSCRIPTIONS` | `global` | **Required** for this endpoint
-     * @param requestBody
-     * @returns Subscription
      */
     create(requestBody: CreateSubscription, options?: OptionsBase): Promise<Subscription>;
 }

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

@@ -45,21 +45,30 @@ export interface FilesService {
      * Permission | Scope | Effect
      * - | - | -
      * `VIEW_FILES` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<FileDetails>
      */
     find(options?: OptionsWithRql): Promise<PagedResult<FileDetails>>;
+    /**
+     * List all files
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FILES` | `global` | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<FileDetails[]>;
     /**
      * Find By Name
-     * @param name the name to search for
-     * @param rql an optional rql string
-     * @returns the first element found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FILES` | `global` | **Required** for this endpoint
      */
     findByName(name: string, options?: OptionsWithRql): Promise<FileDetails | undefined>;
     /**
      * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FILES` | `global` | **Required** for this endpoint
      */
     findFirst(options?: OptionsWithRql): Promise<FileDetails | undefined>;
     /**

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

@@ -2,6 +2,6 @@ import { HttpInstance, HttpRequestConfig } from '../http/types';
 import { OptionsWithRql, PagedResult, PagedResultWithPager } from './types';
 export declare type FindAllIterator<T> = AsyncGenerator<PagedResult<T>, Record<string, never>, void>;
 export declare function findAllIterator<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql): FindAllIterator<T>;
-export declare function findAllGeneric<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, level?: number): Promise<T[]>;
+export declare function findAllGeneric<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql | undefined, level?: number): Promise<T[]>;
 export declare function addPagersFn<T>(find: (options: OptionsWithRql) => PagedResult<T> | Promise<PagedResult<T>>, options: OptionsWithRql, pagedResult: PagedResult<T>): PagedResultWithPager<T>;
 export declare function setCustomKeysConfigurationInRequestConfig(httpInstance: HttpInstance, requestOptions?: HttpRequestConfig): HttpRequestConfig;

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

@@ -49,7 +49,6 @@ export interface CountriesService {
      * Permission | Scope | Effect
      * - | - | -
      * none | | Everyone can use this endpoint
-     * @returns PagedResult<string>
      */
     getCountries(options?: OptionsBase): Promise<string[]>;
     /**
@@ -58,8 +57,8 @@ export interface CountriesService {
      * Permission | Scope | Effect
      * - | - | -
      * none | | Everyone can use this endpoint
+     *
      * @param country The country code (as defined in ISO 3166-1)
-     * @returns PagedResult<string>
      * @throws {ResourceUnknownError}
      */
     getRegions(country: string, options?: OptionsBase): Promise<string[]>;
@@ -71,7 +70,6 @@ export interface LanguagesService {
      * Permission | Scope | Effect
      * - | - | -
      * none | | Everyone can use this endpoint
-     * @returns PagedResult<SupportedLanguageCodes>
      */
     getLanguages(options?: OptionsBase): Promise<string[]>;
 }
@@ -82,21 +80,30 @@ export interface LocalizationsService {
      * Permission | Scope | Effect
      * - | - | -
      * none | | Everyone can use this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<Localization>
      */
     find(options?: OptionsWithRql): Promise<PagedResult<Localization>>;
+    /**
+     * Returns all possible localizations stored in this service
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<Localization[]>;
     /**
      * Find By Key
-     * @param key the key to search for
-     * @param rql an optional rql string
-     * @returns the first element found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
      */
     findByKey(key: string, options?: OptionsWithRql): Promise<Localization | undefined>;
     /**
      * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
      */
     findFirst(options?: OptionsWithRql): Promise<Localization | undefined>;
     /**
@@ -105,8 +112,7 @@ export interface LocalizationsService {
      * Permission | Scope | Effect
      * - | - | -
      * `CREATE_LOCALIZATIONS` | global | **Required** for this endpoint
-     * @param requestBody BulkLocalization
-     * @returns BulkCreationResponse
+     *
      * @throws {DefaultLocalizationMissingError}
      */
     create(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkCreationResponse>;
@@ -116,8 +122,6 @@ export interface LocalizationsService {
      * Permission | Scope | Effect
      * - | - | -
      * `UPDATE_LOCALIZATIONS` | global | **Required** for this endpoint
-     * @param requestBody BulkLocalization
-     * @returns BulkUpdateResponse
      */
     update(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkUpdateResponse>;
     /**
@@ -126,8 +130,8 @@ export interface LocalizationsService {
      * Permission | Scope | Effect
      * - | - | -
      * `DELETE_LOCALIZATIONS` | global | **Required** for this endpoint
+     *
      * @param rql Add filters to the requested list, **required**.
-     * @returns AffectedRecords
      */
     remove(rql: RQLString, options?: OptionsBase): Promise<AffectedRecords>;
     /**
@@ -137,13 +141,10 @@ export interface LocalizationsService {
      * Permission | Scope | Effect
      * - | - | -
      * none | | Everyone can use this endpoint
-     * @param requestBody LocalizationRequest
-     * @returns Record<string, MappedText>
      */
     getByKeys(requestBody: LocalizationRequest, options?: OptionsBase): Promise<Record<string, MappedText>>;
     /**
      * Perform a health check
-     * @returns {boolean} success
      */
     health(): Promise<boolean>;
 }

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

@@ -96,21 +96,30 @@ export interface MailsService {
      * Permission | Scope | Effect
      * - | - | -
      * `VIEW_MAILS` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<Mail>
      */
-    find: (options?: OptionsWithRql) => Promise<PagedResult<Mail>>;
+    find(options?: OptionsWithRql): Promise<PagedResult<Mail>>;
+    /**
+     * Retrieve a list of mails
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_MAILS` | `global` | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<Mail[]>;
     /**
      * Find By Id
-     * @param id the Id to search for
-     * @param rql an optional rql string
-     * @returns the first element found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_MAILS` | `global` | **Required** for this endpoint
      */
-    findById: (id: ObjectId, options?: OptionsWithRql) => Promise<Mail | undefined>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Mail | undefined>;
     /**
      * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_MAILS` | `global` | **Required** for this endpoint
      */
     findFirst(options?: OptionsWithRql): Promise<Mail | undefined>;
     /**
@@ -121,8 +130,6 @@ export interface MailsService {
      * none | | Send mails to your own email address
      * none | `staff enlistment` | Send any mail to your patients or send a template mail based on pre-configured allowed templates to any email address.
      * `SEND_MAILS` | `global` | Send mails to any email address
-     * @param requestBody mail creation data
-     * @returns Mail
      * @throws {NotActivatedError}
      */
     send(requestBody: PlainMailCreation | TemplateBasedMailCreation, options?: OptionsBase): Promise<Mail>;
@@ -132,8 +139,6 @@ export interface MailsService {
      * Permission | Scope | Effect
      * - | - | -
      * none |  | Everyone can use this endpoint
-     * @param trackingHash
-     * @returns AffectedRecords
      */
     track(trackingHash: string, options?: OptionsBase): Promise<AffectedRecords>;
     /**
@@ -142,8 +147,6 @@ export interface MailsService {
      * Permission | Scope | Effect
      * - | - | -
      * `VIEW_MAILS` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<QueuedMail>
      */
     findOutbound(options?: OptionsWithRql): Promise<PagedResult<QueuedMail>>;
 }

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

@@ -8,6 +8,14 @@ export interface ActivationRequestsService {
      * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
      */
     find(options?: OptionsWithRql): Promise<PagedResult<ActivationRequest>>;
+    /**
+     * Retrieve a list of activation requests
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<ActivationRequest[]>;
     /**
      * Find an activation request
      *

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

@@ -8,6 +8,14 @@ export interface ForgotPasswordRequestsService {
      * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
      */
     find(options?: OptionsWithRql): Promise<PagedResult<ForgotPasswordRequest>>;
+    /**
+     * Retrieve a list of forgot password requests
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<ForgotPasswordRequest[]>;
     /**
      * Find a forgot password request
      *

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

@@ -506,6 +506,14 @@ export interface UsersGlobalRolesService {
      * `VIEW_ROLE` | `global` | **Required** for this endpoint
      */
     find(options?: OptionsWithRql): Promise<PagedResult<Role>>;
+    /**
+     * Retrieve a list of roles
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_ROLE` | `global` | **Required** for this endpoint
+     */
+    findAll(options?: OptionsWithRql): Promise<Role[]>;
     /**
      * Returns the first role found
      *
@@ -637,6 +645,15 @@ export interface UsersGroupRolesService {
      * `VIEW_GROUP` | `global` | View any group its roles
      */
     find(groupId: ObjectId, options?: OptionsWithRql): Promise<PagedResult<GroupRole>>;
+    /**
+     * Retrieve a list of group roles
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | `staff enlistment` | View the roles for the group
+     * `VIEW_GROUP` | `global` | View any group its roles
+     */
+    findAll(groupId: ObjectId, options?: OptionsWithRql): Promise<GroupRole[]>;
     /**
      * Returns the first group role found
      *

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.10.0";
+export declare const version = "8.11.0-dev-168-bf985ec";

package/build/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.10.0";
+export declare const version = "8.11.0-dev-168-bf985ec";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.10.0",
+  "version": "8.11.0-dev-168-bf985ec",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",
@@ -32,7 +32,7 @@
     "build"
   ],
   "dependencies": {
-    "axios": "0.31.0",
+    "axios": "0.32.0",
     "buffer": "6.0.3",
     "fflate": "0.8.2",
     "form-data": "4.0.4",