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

package/build/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/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/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/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/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/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/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/mockType.d.ts

@@ -37,6 +37,7 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             add: MockFn;
             update: MockFn;
@@ -54,6 +55,7 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             create: MockFn;
             remove: MockFn;
@@ -68,6 +70,7 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByUserId: MockFn;
+            findAll: MockFn;
             remove: MockFn;
         };
         forgotPasswordRequests: {
@@ -75,6 +78,7 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByUserId: MockFn;
+            findAll: MockFn;
             remove: MockFn;
         };
         settings: {
@@ -152,6 +156,7 @@ export declare type MockClientOAuth1<MockFn> = {
         find: MockFn;
         findByName: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         createFromText: MockFn;
         create: MockFn;
         remove: MockFn;
@@ -247,6 +252,7 @@ export declare type MockClientOAuth1<MockFn> = {
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         send: MockFn;
         track: MockFn;
         findOutbound: MockFn;
@@ -393,6 +399,7 @@ export declare type MockClientOAuth1<MockFn> = {
         find: MockFn;
         findByKey: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         create: MockFn;
         update: MockFn;
         remove: MockFn;
@@ -471,12 +478,14 @@ export declare type MockClientOAuth1<MockFn> = {
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         create: MockFn;
         health: MockFn;
         subscriptions: {
             find: MockFn;
             findById: MockFn;
             findFirst: MockFn;
+            findAll: MockFn;
             create: MockFn;
         };
     };
@@ -493,6 +502,7 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             update: MockFn;
             remove: MockFn;
@@ -504,6 +514,7 @@ export declare type MockClientOAuth1<MockFn> = {
                 find: MockFn;
                 findFirst: MockFn;
                 findById: MockFn;
+                findAll: MockFn;
                 remove: MockFn;
             };
             createAuthorization: MockFn;
@@ -515,6 +526,7 @@ export declare type MockClientOAuth1<MockFn> = {
                 find: MockFn;
                 findFirst: MockFn;
                 findById: MockFn;
+                findAll: MockFn;
                 remove: MockFn;
             };
             generateSsoToken: MockFn;
@@ -612,6 +624,7 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             add: MockFn;
             update: MockFn;
@@ -629,6 +642,7 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             create: MockFn;
             remove: MockFn;
@@ -643,6 +657,7 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByUserId: MockFn;
+            findAll: MockFn;
             remove: MockFn;
         };
         forgotPasswordRequests: {
@@ -650,6 +665,7 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByUserId: MockFn;
+            findAll: MockFn;
             remove: MockFn;
         };
         settings: {
@@ -727,6 +743,7 @@ export declare type MockClientOAuth2<MockFn> = {
         find: MockFn;
         findByName: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         createFromText: MockFn;
         create: MockFn;
         remove: MockFn;
@@ -822,6 +839,7 @@ export declare type MockClientOAuth2<MockFn> = {
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         send: MockFn;
         track: MockFn;
         findOutbound: MockFn;
@@ -968,6 +986,7 @@ export declare type MockClientOAuth2<MockFn> = {
         find: MockFn;
         findByKey: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         create: MockFn;
         update: MockFn;
         remove: MockFn;
@@ -1046,12 +1065,14 @@ export declare type MockClientOAuth2<MockFn> = {
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         create: MockFn;
         health: MockFn;
         subscriptions: {
             find: MockFn;
             findById: MockFn;
             findFirst: MockFn;
+            findAll: MockFn;
             create: MockFn;
         };
     };
@@ -1068,6 +1089,7 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             update: MockFn;
             remove: MockFn;
@@ -1079,6 +1101,7 @@ export declare type MockClientOAuth2<MockFn> = {
                 find: MockFn;
                 findFirst: MockFn;
                 findById: MockFn;
+                findAll: MockFn;
                 remove: MockFn;
             };
             createAuthorization: MockFn;
@@ -1090,6 +1113,7 @@ export declare type MockClientOAuth2<MockFn> = {
                 find: MockFn;
                 findFirst: MockFn;
                 findById: MockFn;
+                findAll: MockFn;
                 remove: MockFn;
             };
             generateSsoToken: MockFn;
@@ -1187,6 +1211,7 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             add: MockFn;
             update: MockFn;
@@ -1204,6 +1229,7 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             create: MockFn;
             remove: MockFn;
@@ -1218,6 +1244,7 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByUserId: MockFn;
+            findAll: MockFn;
             remove: MockFn;
         };
         forgotPasswordRequests: {
@@ -1225,6 +1252,7 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByUserId: MockFn;
+            findAll: MockFn;
             remove: MockFn;
         };
         settings: {
@@ -1302,6 +1330,7 @@ export declare type MockClientProxy<MockFn> = {
         find: MockFn;
         findByName: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         createFromText: MockFn;
         create: MockFn;
         remove: MockFn;
@@ -1397,6 +1426,7 @@ export declare type MockClientProxy<MockFn> = {
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         send: MockFn;
         track: MockFn;
         findOutbound: MockFn;
@@ -1543,6 +1573,7 @@ export declare type MockClientProxy<MockFn> = {
         find: MockFn;
         findByKey: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         create: MockFn;
         update: MockFn;
         remove: MockFn;
@@ -1621,12 +1652,14 @@ export declare type MockClientProxy<MockFn> = {
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
+        findAll: MockFn;
         create: MockFn;
         health: MockFn;
         subscriptions: {
             find: MockFn;
             findById: MockFn;
             findFirst: MockFn;
+            findAll: MockFn;
             create: MockFn;
         };
     };
@@ -1643,6 +1676,7 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
             findById: MockFn;
             findByName: MockFn;
+            findAll: MockFn;
             get: MockFn;
             update: MockFn;
             remove: MockFn;
@@ -1654,6 +1688,7 @@ export declare type MockClientProxy<MockFn> = {
                 find: MockFn;
                 findFirst: MockFn;
                 findById: MockFn;
+                findAll: MockFn;
                 remove: MockFn;
             };
             createAuthorization: MockFn;
@@ -1665,6 +1700,7 @@ export declare type MockClientProxy<MockFn> = {
                 find: MockFn;
                 findFirst: MockFn;
                 findById: MockFn;
+                findAll: MockFn;
                 remove: MockFn;
             };
             generateSsoToken: MockFn;

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

@@ -32,6 +32,23 @@ export interface AuthApplicationsService {
      * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
      * */
     find(options?: OptionsWithRql): Promise<PagedResult<OAuth1Application | OAuth2Application>>;
+    /**
+     * ## Get a list of applications
+     * Provides a list of applications currently registered in the cluster.
+     *
+     * Every logged-in user is able to retrieve a limited set of fields (only `name`, `description`, `logo` and `type`).
+     *
+     * #### Global Permissions
+     * `VIEW_APPLICATIONS` - Returns all applications fields
+     *
+     * #### Function details
+     * @param options {@link OptionsWithRql} additional options with rql that can be set for your request to the cluster.
+     *
+     * @returns Provides a list of applications currently registered in the cluster.
+     *
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * */
+    findAll(options?: OptionsWithRql): Promise<(OAuth1Application | OAuth2Application)[]>;
     /**
      * ## Get the first application found
      * Gets the first application from the paginated list of applications currently registered in the cluster.

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

@@ -54,6 +54,15 @@ export interface AuthOauth1TokenService {
      * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth1 tokens for any account
      */
     find(options?: OptionsWithRql): Promise<PagedResult<OAuth1Token>>;
+    /**
+     * Get a list of OAuth1 tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth1 tokens for this account
+     * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth1 tokens for any account
+     */
+    findAll(options?: OptionsWithRql): Promise<OAuth1Token[]>;
     /**
      * Get the first OAuth1 token found
      *

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

@@ -43,6 +43,15 @@ export interface AuthOauth2TokenService {
      * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 tokens for any account
      */
     find(options?: OptionsWithRql): Promise<PagedResult<OAuth2Token>>;
+    /**
+     * Get a list of OAuth2 tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth2 tokens for this account
+     * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 tokens for any account
+     */
+    findAll(options?: OptionsWithRql): Promise<OAuth2Token[]>;
     /**
      * Get the first OAuth2 token found
      *