@extrahorizon/javascript-sdk 8.2.0 → 8.2.1-dev-48-41fd1f1

package/build/types/client.d.ts

@@ -1,136 +1,136 @@
-import { AuthHttpClient, OAuth1HttpClient, OAuth2HttpClient, ProxyInstance } from './http/types';
-import { authService, configurationsService, dataService, dispatchersService, eventsService, filesService, localizationsService, logsService, mailsService, notificationsService, paymentsService, profilesService, tasksService, templatesService, usersService } from './services';
-import { ClientParams, ParamsOauth1, ParamsOauth2, ParamsProxy } from './types';
-export interface Client<T extends ClientParams> {
-    raw: AuthHttpClient;
-    /**
-     * The template service manages templates used to build emails. It can be used to retrieve, create, update or delete templates as well as resolving them.
-     * @see https://swagger.extrahorizon.com/listing/?service=templates-service&redirectToVersion=1
-     */
-    templates: ReturnType<typeof templatesService>;
-    /**
-     * Provides mail functionality for other services.
-     * @see https://swagger.extrahorizon.com/listing/?service=mail-service&redirectToVersion=1
-     */
-    mails: ReturnType<typeof mailsService>;
-    /**
-     * A flexible data storage for structured data. Additionally, the service enables you to configure a state machine for instances of the structured data. You can couple actions that need to be triggered by the state machine, when/as the entities (instance of structured data) change their state. Thanks to these actions you can define automation rules (see later for more in depth description). These actions also make it possible to interact with other services.
-     * @see https://swagger.extrahorizon.com/listing/?service=data-service&redirectToVersion=1
-     */
-    data: ReturnType<typeof dataService>;
-    /**
-     * A service that handles file storage, metadata & file retrieval based on tokens.
-     * @see https://swagger.extrahorizon.com/listing/?service=files-service&redirectToVersion=1
-     */
-    files: ReturnType<typeof filesService>;
-    /**
-     * Start functions on demand, directly or at a future moment.
-     * @see https://swagger.extrahorizon.com/listing/?service=tasks-service&redirectToVersion=1
-     */
-    tasks: ReturnType<typeof tasksService>;
-    /**
-     * Provides storage for custom configuration objects. On different levels (general, groups, users, links between groups and users).
-     * @see https://swagger.extrahorizon.com/listing/?service=configurations-service&redirectToVersion=2
-     */
-    configurations: ReturnType<typeof configurationsService>;
-    /**
-     * Configure actions that need to be invoked when a specific event is/was triggered.
-     * @see https://swagger.extrahorizon.com/listing/?service=dispatchers-service&redirectToVersion=1
-     */
-    dispatchers: ReturnType<typeof dispatchersService>;
-    /**
-     * A service that provides payment functionality.
-     * @see https://swagger.extrahorizon.com/listing/?service=payments-service&redirectToVersion=1
-     */
-    payments: ReturnType<typeof paymentsService>;
-    /**
-     * Storage and retrieval of text snippets, translated into multiple languages.
-     * @see https://swagger.extrahorizon.com/listing/?service=localizations-service&redirectToVersion=1
-     */
-    localizations: ReturnType<typeof localizationsService>;
-    /**
-     * Storage service of profiles. A profile is a separate object on its own, comprising medical information like medication and medical history, as well as technical information, like what phone a user is using.
-     * @see https://swagger.extrahorizon.com/listing/?service=profiles-service&redirectToVersion=1
-     */
-    profiles: ReturnType<typeof profilesService>;
-    /**
-     * A service that handles push notifications.
-     * @see https://swagger.extrahorizon.com/listing/?service=notifications-service&redirectToVersion=1
-     */
-    notifications: ReturnType<typeof notificationsService>;
-    /**
-     * Service that provides event (publish/subscribe) functionality for other services.
-     * @see https://swagger.extrahorizon.com/listing/?service=events-service&redirectToVersion=1
-     */
-    events: ReturnType<typeof eventsService>;
-    /**
-     * The user service stands in for managing users themselves, as well as roles related to users and groups of users.
-     * @see https://swagger.extrahorizon.com/listing/?service=users-service&redirectToVersion=1
-     */
-    users: ReturnType<typeof usersService>;
-    /**
-     * The logs service allows an authorized party to retrieve logs of the system.
-     * @see https://swagger.extrahorizon.com/listing/?service=logs-service&redirectToVersion=1
-     */
-    logs: ReturnType<typeof logsService>;
-    /**
-     * Provides authentication functionality. The Authentication service supports both OAuth 1.0a and OAuth 2.0 standards.
-     * @see https://swagger.extrahorizon.com/listing/?service=auth-service&redirectToVersion=2
-     */
-    auth: T extends ParamsOauth1 ? ReturnType<typeof authService> & OAuth1HttpClient['extraAuthMethods'] : T extends ParamsOauth2 ? ReturnType<typeof authService> & OAuth2HttpClient['extraAuthMethods'] : ReturnType<typeof authService> & ProxyInstance['extraAuthMethods'];
-}
-/**
- * Create ExtraHorizon client.
- *
- * @example
- * const exh = createClient({
- *   host: 'xxx.extrahorizon.io',
- *   clientId: 'string',
- * });
- * await exh.auth.authenticate({
- *   username: 'string',
- *   password: 'string',
- * });
- */
-export declare function createClient<T extends ClientParams>(rawConfig: T): Client<T>;
-export declare type OAuth1Client = Client<ParamsOauth1>;
-/**
- * Create ExtraHorizon OAuth1 client.
- *
- * @example
- * const exh = createOAuth1Client({
- *   host: 'sandbox.extrahorizon.io',
- *   consumerKey: 'string',
- *   consumerSecret: 'string',
- * });
- * await exh.auth.authenticate({
- *   email: 'string',
- *   password: 'string',
- * });
- */
-export declare const createOAuth1Client: (rawConfig: ParamsOauth1) => OAuth1Client;
-export declare type OAuth2Client = Client<ParamsOauth2>;
-/**
- * Create ExtraHorizon OAuth2 client.
- *
- * @example
- * const exh = createOAuth2Client({
- *   host: 'sandbox.extrahorizon.io',
- *   clientId: 'string',
- * });
- * await exh.auth.authenticate({
- *   username: 'string',
- *   password: 'string',
- * });
- */
-export declare const createOAuth2Client: (rawConfig: ParamsOauth2) => OAuth2Client;
-export declare type ProxyClient = Client<ParamsProxy>;
-/**
- * Create ExtraHorizon Proxy client.
- *
- * @example
- * const exh = createProxyClient({
- *   host: 'apx.sandbox.extrahorizon.io',
- * });
- */
-export declare const createProxyClient: (rawConfig: ParamsProxy) => ProxyClient;
+import { AuthHttpClient, OAuth1HttpClient, OAuth2HttpClient, ProxyInstance } from './http/types';
+import { authService, configurationsService, dataService, dispatchersService, eventsService, filesService, localizationsService, logsService, mailsService, notificationsService, paymentsService, profilesService, tasksService, templatesService, usersService } from './services';
+import { ClientParams, ParamsOauth1, ParamsOauth2, ParamsProxy } from './types';
+export interface Client<T extends ClientParams> {
+    raw: AuthHttpClient;
+    /**
+     * The template service manages templates used to build emails. It can be used to retrieve, create, update or delete templates as well as resolving them.
+     * @see https://swagger.extrahorizon.com/listing/?service=templates-service&redirectToVersion=1
+     */
+    templates: ReturnType<typeof templatesService>;
+    /**
+     * Provides mail functionality for other services.
+     * @see https://swagger.extrahorizon.com/listing/?service=mail-service&redirectToVersion=1
+     */
+    mails: ReturnType<typeof mailsService>;
+    /**
+     * A flexible data storage for structured data. Additionally, the service enables you to configure a state machine for instances of the structured data. You can couple actions that need to be triggered by the state machine, when/as the entities (instance of structured data) change their state. Thanks to these actions you can define automation rules (see later for more in depth description). These actions also make it possible to interact with other services.
+     * @see https://swagger.extrahorizon.com/listing/?service=data-service&redirectToVersion=1
+     */
+    data: ReturnType<typeof dataService>;
+    /**
+     * A service that handles file storage, metadata & file retrieval based on tokens.
+     * @see https://swagger.extrahorizon.com/listing/?service=files-service&redirectToVersion=1
+     */
+    files: ReturnType<typeof filesService>;
+    /**
+     * Start functions on demand, directly or at a future moment.
+     * @see https://swagger.extrahorizon.com/listing/?service=tasks-service&redirectToVersion=1
+     */
+    tasks: ReturnType<typeof tasksService>;
+    /**
+     * Provides storage for custom configuration objects. On different levels (general, groups, users, links between groups and users).
+     * @see https://swagger.extrahorizon.com/listing/?service=configurations-service&redirectToVersion=2
+     */
+    configurations: ReturnType<typeof configurationsService>;
+    /**
+     * Configure actions that need to be invoked when a specific event is/was triggered.
+     * @see https://swagger.extrahorizon.com/listing/?service=dispatchers-service&redirectToVersion=1
+     */
+    dispatchers: ReturnType<typeof dispatchersService>;
+    /**
+     * A service that provides payment functionality.
+     * @see https://swagger.extrahorizon.com/listing/?service=payments-service&redirectToVersion=1
+     */
+    payments: ReturnType<typeof paymentsService>;
+    /**
+     * Storage and retrieval of text snippets, translated into multiple languages.
+     * @see https://swagger.extrahorizon.com/listing/?service=localizations-service&redirectToVersion=1
+     */
+    localizations: ReturnType<typeof localizationsService>;
+    /**
+     * Storage service of profiles. A profile is a separate object on its own, comprising medical information like medication and medical history, as well as technical information, like what phone a user is using.
+     * @see https://swagger.extrahorizon.com/listing/?service=profiles-service&redirectToVersion=1
+     */
+    profiles: ReturnType<typeof profilesService>;
+    /**
+     * A service that handles push notifications.
+     * @see https://swagger.extrahorizon.com/listing/?service=notifications-service&redirectToVersion=1
+     */
+    notifications: ReturnType<typeof notificationsService>;
+    /**
+     * Service that provides event (publish/subscribe) functionality for other services.
+     * @see https://swagger.extrahorizon.com/listing/?service=events-service&redirectToVersion=1
+     */
+    events: ReturnType<typeof eventsService>;
+    /**
+     * The user service stands in for managing users themselves, as well as roles related to users and groups of users.
+     * @see https://swagger.extrahorizon.com/listing/?service=users-service&redirectToVersion=1
+     */
+    users: ReturnType<typeof usersService>;
+    /**
+     * The logs service allows an authorized party to retrieve logs of the system.
+     * @see https://swagger.extrahorizon.com/listing/?service=logs-service&redirectToVersion=1
+     */
+    logs: ReturnType<typeof logsService>;
+    /**
+     * Provides authentication functionality. The Authentication service supports both OAuth 1.0a and OAuth 2.0 standards.
+     * @see https://swagger.extrahorizon.com/listing/?service=auth-service&redirectToVersion=2
+     */
+    auth: T extends ParamsOauth1 ? ReturnType<typeof authService> & OAuth1HttpClient['extraAuthMethods'] : T extends ParamsOauth2 ? ReturnType<typeof authService> & OAuth2HttpClient['extraAuthMethods'] : ReturnType<typeof authService> & ProxyInstance['extraAuthMethods'];
+}
+/**
+ * Create ExtraHorizon client.
+ *
+ * @example
+ * const exh = createClient({
+ *   host: 'xxx.extrahorizon.io',
+ *   clientId: 'string',
+ * });
+ * await exh.auth.authenticate({
+ *   username: 'string',
+ *   password: 'string',
+ * });
+ */
+export declare function createClient<T extends ClientParams>(rawConfig: T): Client<T>;
+export declare type OAuth1Client = Client<ParamsOauth1>;
+/**
+ * Create ExtraHorizon OAuth1 client.
+ *
+ * @example
+ * const exh = createOAuth1Client({
+ *   host: 'sandbox.extrahorizon.io',
+ *   consumerKey: 'string',
+ *   consumerSecret: 'string',
+ * });
+ * await exh.auth.authenticate({
+ *   email: 'string',
+ *   password: 'string',
+ * });
+ */
+export declare const createOAuth1Client: (rawConfig: ParamsOauth1) => OAuth1Client;
+export declare type OAuth2Client = Client<ParamsOauth2>;
+/**
+ * Create ExtraHorizon OAuth2 client.
+ *
+ * @example
+ * const exh = createOAuth2Client({
+ *   host: 'sandbox.extrahorizon.io',
+ *   clientId: 'string',
+ * });
+ * await exh.auth.authenticate({
+ *   username: 'string',
+ *   password: 'string',
+ * });
+ */
+export declare const createOAuth2Client: (rawConfig: ParamsOauth2) => OAuth2Client;
+export declare type ProxyClient = Client<ParamsProxy>;
+/**
+ * Create ExtraHorizon Proxy client.
+ *
+ * @example
+ * const exh = createProxyClient({
+ *   host: 'apx.sandbox.extrahorizon.io',
+ * });
+ */
+export declare const createProxyClient: (rawConfig: ParamsProxy) => ProxyClient;

package/build/types/constants.d.ts

@@ -1,15 +1,15 @@
-export declare const AUTH_BASE = "/auth/v2";
-export declare const USER_BASE = "/users/v1";
-export declare const DATA_BASE = "/data/v1";
-export declare const FILES_BASE = "/files/v1";
-export declare const TASKS_BASE = "/tasks/v1";
-export declare const CONFIGURATION_BASE = "/configurations/v2";
-export declare const TEMPLATE_BASE = "/templates/v1";
-export declare const MAIL_BASE = "/mail/v1";
-export declare const DISPATCHERS_BASE = "/dispatchers/v1";
-export declare const PAYMENTS_BASE = "/payments/v1";
-export declare const PROFILES_BASE = "/profiles/v1";
-export declare const NOTIFICATIONS_BASE = "/notifications/v1";
-export declare const LOCALIZATIONS_BASE = "/localizations/v1";
-export declare const EVENTS_BASE = "/events/v1";
-export declare const LOGS_BASE = "/logs/v1";
+export declare const AUTH_BASE = "/auth/v2";
+export declare const USER_BASE = "/users/v1";
+export declare const DATA_BASE = "/data/v1";
+export declare const FILES_BASE = "/files/v1";
+export declare const TASKS_BASE = "/tasks/v1";
+export declare const CONFIGURATION_BASE = "/configurations/v2";
+export declare const TEMPLATE_BASE = "/templates/v1";
+export declare const MAIL_BASE = "/mail/v1";
+export declare const DISPATCHERS_BASE = "/dispatchers/v1";
+export declare const PAYMENTS_BASE = "/payments/v1";
+export declare const PROFILES_BASE = "/profiles/v1";
+export declare const NOTIFICATIONS_BASE = "/notifications/v1";
+export declare const LOCALIZATIONS_BASE = "/localizations/v1";
+export declare const EVENTS_BASE = "/events/v1";
+export declare const LOGS_BASE = "/logs/v1";

package/build/types/errorHandler.d.ts

@@ -1,2 +1,2 @@
-import { HttpError } from './errors';
-export declare function typeReceivedError(error: HttpError): any;
+import { HttpError } from './errors';
+export declare function typeReceivedError(error: HttpError): any;