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

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

@@ -1,145 +1,145 @@
-import { RQLString } from '../../rql';
-import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../types';
-export declare enum SupportedLanguageCodes {
-    EN = "EN",
-    NL = "NL",
-    DE = "DE",
-    FR = "FR",
-    DA = "DA",
-    ES = "ES",
-    IT = "IT"
-}
-declare type SupportedLanguageCodesValues = keyof typeof SupportedLanguageCodes;
-export declare type MappedText = Record<SupportedLanguageCodesValues, string>;
-export interface Localization {
-    key: string;
-    text: {
-        [K in SupportedLanguageCodesValues]?: string;
-    };
-    creationTimestamp?: Date;
-    updateTimestamp?: Date;
-}
-export interface BulkLocalization {
-    localizations?: Array<Pick<Localization, 'key' | 'text'>>;
-}
-/**
- * The 'created' field shows how many new localizations were succesfully created. The 'existing' field shows how many localizations with the given keys already existed. Eventually, the 'existing_ids' fields shows exactly which localizations already existed. Old localizations will not be overwritten by new ones.
- */
-export interface BulkCreationResponse {
-    created?: number;
-    existing?: number;
-    existingIds?: string[];
-}
-/**
- * The 'updated' field shows how many localizations were succesfully updated. The 'missing' field shows how many localizations with the given keys couldn't be found. Eventually, the 'missing_ids' fields shows exactly which localizations couldn't be found and are thus not updated.
- */
-export interface BulkUpdateResponse {
-    updated?: number;
-    missing?: number;
-    missingIds?: string[];
-}
-export interface LocalizationRequest {
-    localizationCodes: SupportedLanguageCodesValues[];
-    localizations: string[];
-}
-export interface CountriesService {
-    /**
-     * Retrieve a list of all the defined countries
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @returns PagedResult<string>
-     */
-    getCountries(options?: OptionsBase): Promise<string[]>;
-    /**
-     * Retrieve a list of all the defined regions for the specified country code
-     *
-     * 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[]>;
-}
-export interface LanguagesService {
-    /**
-     * Retrieve a list of all the defined languages
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @returns PagedResult<SupportedLanguageCodes>
-     */
-    getLanguages(options?: OptionsBase): Promise<string[]>;
-}
-export interface LocalizationsService {
-    /**
-     * Returns all possible localizations stored in this service
-     *
-     * 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>>;
-    /**
-     * Find By Key
-     * @param key the key to search for
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findByKey(key: string, options?: OptionsWithRql): Promise<Localization>;
-    /**
-     * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findFirst(options?: OptionsWithRql): Promise<Localization>;
-    /**
-     * Create new localizations
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `CREATE_LOCALIZATIONS` | global | **Required** for this endpoint
-     * @param requestBody BulkLocalization
-     * @returns BulkCreationResponse
-     * @throws {DefaultLocalizationMissingError}
-     */
-    create(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkCreationResponse>;
-    /**
-     * Update localizations
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `UPDATE_LOCALIZATIONS` | global | **Required** for this endpoint
-     * @param requestBody BulkLocalization
-     * @returns BulkUpdateResponse
-     */
-    update(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkUpdateResponse>;
-    /**
-     * Delete localizations
-     *
-     * 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>;
-    /**
-     * Request localizations of multiple keys in a specific language
-     * The default language (EN) is always included in the response as a fallback in case there is no translation available for the specified language
-     *
-     * 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>>;
-}
-export {};
+import { RQLString } from '../../rql';
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../types';
+export declare enum SupportedLanguageCodes {
+    EN = "EN",
+    NL = "NL",
+    DE = "DE",
+    FR = "FR",
+    DA = "DA",
+    ES = "ES",
+    IT = "IT"
+}
+declare type SupportedLanguageCodesValues = keyof typeof SupportedLanguageCodes;
+export declare type MappedText = Record<SupportedLanguageCodesValues, string>;
+export interface Localization {
+    key: string;
+    text: {
+        [K in SupportedLanguageCodesValues]?: string;
+    };
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+export interface BulkLocalization {
+    localizations?: Array<Pick<Localization, 'key' | 'text'>>;
+}
+/**
+ * The 'created' field shows how many new localizations were succesfully created. The 'existing' field shows how many localizations with the given keys already existed. Eventually, the 'existing_ids' fields shows exactly which localizations already existed. Old localizations will not be overwritten by new ones.
+ */
+export interface BulkCreationResponse {
+    created?: number;
+    existing?: number;
+    existingIds?: string[];
+}
+/**
+ * The 'updated' field shows how many localizations were succesfully updated. The 'missing' field shows how many localizations with the given keys couldn't be found. Eventually, the 'missing_ids' fields shows exactly which localizations couldn't be found and are thus not updated.
+ */
+export interface BulkUpdateResponse {
+    updated?: number;
+    missing?: number;
+    missingIds?: string[];
+}
+export interface LocalizationRequest {
+    localizationCodes: SupportedLanguageCodesValues[];
+    localizations: string[];
+}
+export interface CountriesService {
+    /**
+     * Retrieve a list of all the defined countries
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<string>
+     */
+    getCountries(options?: OptionsBase): Promise<string[]>;
+    /**
+     * Retrieve a list of all the defined regions for the specified country code
+     *
+     * 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[]>;
+}
+export interface LanguagesService {
+    /**
+     * Retrieve a list of all the defined languages
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<SupportedLanguageCodes>
+     */
+    getLanguages(options?: OptionsBase): Promise<string[]>;
+}
+export interface LocalizationsService {
+    /**
+     * Returns all possible localizations stored in this service
+     *
+     * 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>>;
+    /**
+     * Find By Key
+     * @param key the key to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findByKey(key: string, options?: OptionsWithRql): Promise<Localization>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Localization>;
+    /**
+     * Create new localizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_LOCALIZATIONS` | global | **Required** for this endpoint
+     * @param requestBody BulkLocalization
+     * @returns BulkCreationResponse
+     * @throws {DefaultLocalizationMissingError}
+     */
+    create(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkCreationResponse>;
+    /**
+     * Update localizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_LOCALIZATIONS` | global | **Required** for this endpoint
+     * @param requestBody BulkLocalization
+     * @returns BulkUpdateResponse
+     */
+    update(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkUpdateResponse>;
+    /**
+     * Delete localizations
+     *
+     * 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>;
+    /**
+     * Request localizations of multiple keys in a specific language
+     * The default language (EN) is always included in the response as a fallback in case there is no translation available for the specified language
+     *
+     * 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>>;
+}
+export {};

package/build/types/services/logs/access/index.d.ts

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

package/build/types/services/logs/access/types.d.ts

@@ -1,41 +1,41 @@
-import { OptionsWithRql } from '../../types';
-export interface LogsAccessService {
-    /**
-     * ## Retrieve a list of access logs
-     *
-     * **Global Permissions:**
-     * - `VIEW_ACCESS_LOGS` - Allows a user to view access logs
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An array of access logs {@link AccessLog AccessLog[]}
-     */
-    find(options?: OptionsWithRql): Promise<AccessLog[]>;
-    /**
-     * ## Retrieve the first queried access log
-     *
-     * **Global Permissions:**
-     * - `VIEW_ACCESS_LOGS` - Allows a user to view access logs
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns The first element of the queried access logs {@link AccessLog}
-     */
-    findFirst(options?: OptionsWithRql): Promise<AccessLog>;
-}
-export interface AccessLog {
-    /** The time of request receival */
-    timestamp: string;
-    /** The status code of the response for the request */
-    httpStatus: number;
-    /** The duration of the request in seconds */
-    duration: number;
-    /** The Extra Horizon id of the request initiator */
-    userId: string;
-    /** The IP address of the request's origin */
-    userAddress: string;
-    /** The domain or IP of the accessed Extra Horizon deployment */
-    host: string;
-    /** The HTTP request */
-    request: string;
-    /** The size of the response in Bytes */
-    responseBodySize: number;
-    /** The signature of the request device and software */
-    userAgent: string;
-}
+import { OptionsWithRql } from '../../types';
+export interface LogsAccessService {
+    /**
+     * ## Retrieve a list of access logs
+     *
+     * **Global Permissions:**
+     * - `VIEW_ACCESS_LOGS` - Allows a user to view access logs
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of access logs {@link AccessLog AccessLog[]}
+     */
+    find(options?: OptionsWithRql): Promise<AccessLog[]>;
+    /**
+     * ## Retrieve the first queried access log
+     *
+     * **Global Permissions:**
+     * - `VIEW_ACCESS_LOGS` - Allows a user to view access logs
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried access logs {@link AccessLog}
+     */
+    findFirst(options?: OptionsWithRql): Promise<AccessLog>;
+}
+export interface AccessLog {
+    /** The time of request receival */
+    timestamp: string;
+    /** The status code of the response for the request */
+    httpStatus: number;
+    /** The duration of the request in seconds */
+    duration: number;
+    /** The Extra Horizon id of the request initiator */
+    userId: string;
+    /** The IP address of the request's origin */
+    userAddress: string;
+    /** The domain or IP of the accessed Extra Horizon deployment */
+    host: string;
+    /** The HTTP request */
+    request: string;
+    /** The size of the response in Bytes */
+    responseBodySize: number;
+    /** The signature of the request device and software */
+    userAgent: string;
+}

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

@@ -1,3 +1,3 @@
-import { HttpInstance } from '../../http/types';
-import { LogsService } from './types';
-export declare const logsService: (httpWithAuth: HttpInstance) => LogsService;
+import { HttpInstance } from '../../http/types';
+import { LogsService } from './types';
+export declare const logsService: (httpWithAuth: HttpInstance) => LogsService;

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

@@ -1,4 +1,4 @@
-import { LogsAccessService } from './access/types';
-export interface LogsService {
-    access: LogsAccessService;
-}
+import { LogsAccessService } from './access/types';
+export interface LogsService {
+    access: LogsAccessService;
+}

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

@@ -1,3 +1,3 @@
-import type { HttpInstance } from '../../types';
-import { MailsService } from './types';
-export declare const mailsService: (httpWithAuth: HttpInstance) => MailsService;
+import type { HttpInstance } from '../../types';
+import { MailsService } from './types';
+export declare const mailsService: (httpWithAuth: HttpInstance) => MailsService;

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

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