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

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

@@ -1,202 +1,202 @@
-/// <reference types="node" />
-import { FindAllIterator } from '../../services/helpers';
-import { TypeConfiguration } from '../data/types';
-import { ObjectId, LanguageCode, TimeZone, PagedResult, AffectedRecords, OptionsWithRql, OptionsBase } from '../types';
-export interface TemplateOut {
-    id?: ObjectId;
-    name?: string;
-    description?: string;
-    schema?: TemplateObjectConfiguration;
-    fields?: Record<string, string>;
-    creationTimestamp?: Date;
-    updateTimestamp?: Date;
-}
-export interface TemplateIn {
-    name: string;
-    description: string;
-    schema: TemplateObjectConfiguration;
-    fields: Record<string, string>;
-}
-export interface TemplateObjectConfiguration {
-    type?: 'object';
-    options?: Array<ObjectOption>;
-    fields?: Record<string, TypeConfiguration>;
-}
-export declare type ObjectOption = ObjectMinBytesOption | ObjectMaxBytesOption;
-export interface ObjectMinBytesOption {
-    type?: ObjectMinBytesOptionType;
-    value: number;
-}
-export declare enum ObjectMinBytesOptionType {
-    MIN_BYTES = "min_bytes"
-}
-export interface ObjectMaxBytesOption {
-    type?: ObjectMaxBytesOptionType;
-    value: number;
-}
-export declare enum ObjectMaxBytesOptionType {
-    MAX_BYTES = "max_bytes"
-}
-export interface CreateFile {
-    /**
-     * If not present (or empty) we will first check the configured language in the users-service. If that is not present it will default to 'EN'
-     */
-    language?: LanguageCode;
-    /**
-     * If not present (or empty) we will first check the configured time_zone in the users-service. If that is not present it will default to 'Europe/Brussels'
-     */
-    timeZone?: TimeZone;
-    content: Record<string, any>;
-}
-export interface TemplatesService {
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    health(): Promise<boolean>;
-    /**
-     * Get all templates the service has to offer
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns PagedResult<TemplateOut>
-     */
-    find(options?: OptionsWithRql): Promise<PagedResult<TemplateOut>>;
-    /**
-     * Request a list of all templates
-     *
-     * Do not pass in an rql with limit operator!
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns TemplateOut[]
-     */
-    findAll(options?: OptionsWithRql): Promise<TemplateOut[]>;
-    /**
-     * Request a list of all templates
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param rql Add filters to the requested list.
-     * @returns TemplateOut[]
-     */
-    findAllIterator(options?: OptionsWithRql): FindAllIterator<TemplateOut>;
-    /**
-     * 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<TemplateOut>;
-    /**
-     * Find By Name
-     * @param name the name to search for
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findByName(name: string, options?: OptionsWithRql): Promise<TemplateOut>;
-    /**
-     * Find First
-     * @param rql an optional rql string
-     * @returns the first element found
-     */
-    findFirst(options?: OptionsWithRql): Promise<TemplateOut>;
-    /**
-     * Create a new template
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `CREATE_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param requestBody TemplateIn
-     * @returns TemplateOut
-     */
-    create(requestBody: TemplateIn, options?: OptionsBase): Promise<TemplateOut>;
-    /**
-     * Update an existing template
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `UPDATE_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param templateId Id of the targeted template
-     * @param requestBody TemplateIn
-     * @returns TemplateOut
-     * @throws {ResourceUnknownError}
-     */
-    update(templateId: string, requestBody: TemplateIn, options?: OptionsBase): Promise<TemplateOut>;
-    /**
-     * Delete a template
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * `DELETE_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param templateId Id of the targeted template
-     * @returns AffectedRecords
-     * @throws {ResourceUnknownError}
-     */
-    remove(templateId: string, options?: OptionsBase): Promise<AffectedRecords>;
-    /**
-     * Resolves a template and presents the result as a pdf file
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @param templateId Id of the targeted template
-     * @param requestBody The file data
-     * @returns Buffer
-     * @throws {LocalizationKeyMissingError}
-     * @throws {TemplateFillingError}
-     * @throws {ResourceUnknownError}
-     */
-    resolveAsPdf(templateId: string, requestBody: CreateFile, options?: OptionsBase): Promise<Buffer>;
-    /**
-     * @deprecated
-     * Resolves a template and presents the result as a pdf file
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @param templateId Id of the targeted template
-     * @param localizationCode Specifies the language the template must be resolved in
-     * @param requestBody The file data
-     * @returns Buffer
-     * @throws {LocalizationKeyMissingError}
-     * @throws {TemplateFillingError}
-     * @throws {ResourceUnknownError}
-     */
-    resolveAsPdfUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Buffer>;
-    /**
-     * Resolves a template and presents the result as a json response
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @param templateId Id of the targeted template
-     * @param requestBody CreateFile
-     * @returns Record<string, string>
-     * @throws {LocalizationKeyMissingError}
-     * @throws {TemplateFillingError}
-     * @throws {ResourceUnknownError}
-     */
-    resolveAsJson(templateId: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
-    /**
-     * @deprecated
-     * Resolves a template and presents the result as a json response
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @param templateId Id of the targeted template
-     * @param localizationCode Specifies the language the template must be resolved in
-     * @param requestBody CreateFile
-     * @returns Record<string, string>
-     * @throws {LocalizationKeyMissingError}
-     * @throws {TemplateFillingError}
-     * @throws {ResourceUnknownError}
-     */
-    resolveAsJsonUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
-}
+/// <reference types="node" />
+import { FindAllIterator } from '../../services/helpers';
+import { TypeConfiguration } from '../data/types';
+import { ObjectId, LanguageCode, TimeZone, PagedResult, AffectedRecords, OptionsWithRql, OptionsBase } from '../types';
+export interface TemplateOut {
+    id?: ObjectId;
+    name?: string;
+    description?: string;
+    schema?: TemplateObjectConfiguration;
+    fields?: Record<string, string>;
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+export interface TemplateIn {
+    name: string;
+    description: string;
+    schema: TemplateObjectConfiguration;
+    fields: Record<string, string>;
+}
+export interface TemplateObjectConfiguration {
+    type?: 'object';
+    options?: Array<ObjectOption>;
+    fields?: Record<string, TypeConfiguration>;
+}
+export declare type ObjectOption = ObjectMinBytesOption | ObjectMaxBytesOption;
+export interface ObjectMinBytesOption {
+    type?: ObjectMinBytesOptionType;
+    value: number;
+}
+export declare enum ObjectMinBytesOptionType {
+    MIN_BYTES = "min_bytes"
+}
+export interface ObjectMaxBytesOption {
+    type?: ObjectMaxBytesOptionType;
+    value: number;
+}
+export declare enum ObjectMaxBytesOptionType {
+    MAX_BYTES = "max_bytes"
+}
+export interface CreateFile {
+    /**
+     * If not present (or empty) we will first check the configured language in the users-service. If that is not present it will default to 'EN'
+     */
+    language?: LanguageCode;
+    /**
+     * If not present (or empty) we will first check the configured time_zone in the users-service. If that is not present it will default to 'Europe/Brussels'
+     */
+    timeZone?: TimeZone;
+    content: Record<string, any>;
+}
+export interface TemplatesService {
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+    /**
+     * Get all templates the service has to offer
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<TemplateOut>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<TemplateOut>>;
+    /**
+     * Request a list of all templates
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns TemplateOut[]
+     */
+    findAll(options?: OptionsWithRql): Promise<TemplateOut[]>;
+    /**
+     * Request a list of all templates
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns TemplateOut[]
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<TemplateOut>;
+    /**
+     * 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<TemplateOut>;
+    /**
+     * Find By Name
+     * @param name the name to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findByName(name: string, options?: OptionsWithRql): Promise<TemplateOut>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<TemplateOut>;
+    /**
+     * Create a new template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param requestBody TemplateIn
+     * @returns TemplateOut
+     */
+    create(requestBody: TemplateIn, options?: OptionsBase): Promise<TemplateOut>;
+    /**
+     * Update an existing template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateId Id of the targeted template
+     * @param requestBody TemplateIn
+     * @returns TemplateOut
+     * @throws {ResourceUnknownError}
+     */
+    update(templateId: string, requestBody: TemplateIn, options?: OptionsBase): Promise<TemplateOut>;
+    /**
+     * Delete a template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateId Id of the targeted template
+     * @returns AffectedRecords
+     * @throws {ResourceUnknownError}
+     */
+    remove(templateId: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Resolves a template and presents the result as a pdf file
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param requestBody The file data
+     * @returns Buffer
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsPdf(templateId: string, requestBody: CreateFile, options?: OptionsBase): Promise<Buffer>;
+    /**
+     * @deprecated
+     * Resolves a template and presents the result as a pdf file
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param localizationCode Specifies the language the template must be resolved in
+     * @param requestBody The file data
+     * @returns Buffer
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsPdfUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Buffer>;
+    /**
+     * Resolves a template and presents the result as a json response
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param requestBody CreateFile
+     * @returns Record<string, string>
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsJson(templateId: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
+    /**
+     * @deprecated
+     * Resolves a template and presents the result as a json response
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param templateId Id of the targeted template
+     * @param localizationCode Specifies the language the template must be resolved in
+     * @param requestBody CreateFile
+     * @returns Record<string, string>
+     * @throws {LocalizationKeyMissingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolveAsJsonUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
+}

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

@@ -1,77 +1,77 @@
-import { RQLString } from '../rql';
-export declare type LanguageCode = string;
-export declare type ObjectId = string;
-export interface Entity {
-    id: ObjectId;
-}
-export interface Timestamps {
-    updateTimestamp: Date;
-    creationTimestamp: Date;
-}
-export interface ErrorResponse {
-    code?: number;
-    name?: string;
-    message?: string;
-}
-export interface PagedResult<T> {
-    page: {
-        total: number;
-        offset: number;
-        limit: number;
-    };
-    data: T[];
-}
-export interface AffectedRecords {
-    affectedRecords: number;
-}
-export interface ResultResponse {
-    status: number;
-}
-export declare enum Results {
-    Success = 200
-}
-/**
- * Supported timezones from [Java.time.zoneId](https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html#of-java.lang.String-)
- */
-export declare type TimeZone = string;
-export declare type MailAddress = string;
-export declare type MailAddressList = MailAddress[];
-export interface MailRecipients {
-    to: MailAddressList;
-    cc?: MailAddressList;
-    bcc?: MailAddressList;
-}
-export declare type Headers = Record<string, string>;
-export declare type OptionsBase = {
-    /** Added to all HTTP verbs */
-    headers?: Headers;
-    /** Only passed to the GET requests. Will retry 4 times on 500 errors */
-    shouldRetry?: boolean;
-    /**
-     * @deprecated this property is only meant to be used for backwards compatibility when upgrading to v8.0.0.
-     *
-     * Key names that are not chosen by Extra Horizon where also affected by the data normalization before v8.0.0.
-     * They were converted from camel case to snake case before sending the request and the other way around before
-     * providing the response.
-     *
-     * Also fields ending with the name timestamp not chosen by extra horizon in custom properties where automatically
-     * converted to dates. Even though they could be just booleans, strings or numbers. Dates provided in such fields will
-     * now be converted to strings while all other types will stay as they are.
-     *
-     * To enable this behaviour again, set to true.
-     */
-    normalizeCustomData?: boolean;
-};
-export declare type OptionsWithRql = OptionsBase & {
-    rql?: RQLString;
-};
-export interface FileUploadOptions extends OptionsBase {
-    onUploadProgress?: (progress: {
-        loaded: number;
-        total: number;
-    }) => void;
-}
-export declare type PagedResultWithPager<T> = PagedResult<T> & {
-    previous: () => Promise<PagedResultWithPager<T>>;
-    next: () => Promise<PagedResultWithPager<T>>;
-};
+import { RQLString } from '../rql';
+export declare type LanguageCode = string;
+export declare type ObjectId = string;
+export interface Entity {
+    id: ObjectId;
+}
+export interface Timestamps {
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+}
+export interface ErrorResponse {
+    code?: number;
+    name?: string;
+    message?: string;
+}
+export interface PagedResult<T> {
+    page: {
+        total: number;
+        offset: number;
+        limit: number;
+    };
+    data: T[];
+}
+export interface AffectedRecords {
+    affectedRecords: number;
+}
+export interface ResultResponse {
+    status: number;
+}
+export declare enum Results {
+    Success = 200
+}
+/**
+ * Supported timezones from [Java.time.zoneId](https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html#of-java.lang.String-)
+ */
+export declare type TimeZone = string;
+export declare type MailAddress = string;
+export declare type MailAddressList = MailAddress[];
+export interface MailRecipients {
+    to: MailAddressList;
+    cc?: MailAddressList;
+    bcc?: MailAddressList;
+}
+export declare type Headers = Record<string, string>;
+export declare type OptionsBase = {
+    /** Added to all HTTP verbs */
+    headers?: Headers;
+    /** Only passed to the GET requests. Will retry 4 times on 500 errors */
+    shouldRetry?: boolean;
+    /**
+     * @deprecated this property is only meant to be used for backwards compatibility when upgrading to v8.0.0.
+     *
+     * Key names that are not chosen by Extra Horizon where also affected by the data normalization before v8.0.0.
+     * They were converted from camel case to snake case before sending the request and the other way around before
+     * providing the response.
+     *
+     * Also fields ending with the name timestamp not chosen by extra horizon in custom properties where automatically
+     * converted to dates. Even though they could be just booleans, strings or numbers. Dates provided in such fields will
+     * now be converted to strings while all other types will stay as they are.
+     *
+     * To enable this behaviour again, set to true.
+     */
+    normalizeCustomData?: boolean;
+};
+export declare type OptionsWithRql = OptionsBase & {
+    rql?: RQLString;
+};
+export interface FileUploadOptions extends OptionsBase {
+    onUploadProgress?: (progress: {
+        loaded: number;
+        total: number;
+    }) => void;
+}
+export declare type PagedResultWithPager<T> = PagedResult<T> & {
+    previous: () => Promise<PagedResultWithPager<T>>;
+    next: () => Promise<PagedResultWithPager<T>>;
+};

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

@@ -1,4 +1,4 @@
-import { HttpInstance } from '../../../types';
-import { HttpClient } from '../../http-client';
-import { ActivationRequestsService } from './types';
-export declare const activationRequestsService: (client: HttpClient, httpWithAuth: HttpInstance) => ActivationRequestsService;
+import { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import { ActivationRequestsService } from './types';
+export declare const activationRequestsService: (client: HttpClient, httpWithAuth: HttpInstance) => ActivationRequestsService;