Client including methods to interact with Eccomix API.

1. Configuration
2. API Methods
3. Example Usage

Configuration

Import EccomixApiClient from package:

import { EccomixApiClient } from "eccomix-api-client";

Constructor requires url parameter to Eccomix API.

Example:

const client = new EccomixApiClient("https://example-api.example.com");

API Methods

Every request except sendEmail and sendSms requires valid authorization token which is acquired after successful OAuth flow using eccomix-react-auth on frontend. The EccomixApiClient class provides the following methods for interacting with the Eccomix API:

| Method | Description | Parameters | Returns | | ---------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | verifyToken | Verifies a user token and returns user information. | token: string | Promise<IUserInfo> | | getCurrentUser | Retrieves information about the current user. | token: string | Promise<IUserInfo> | | getUserOwnBusinesses | Gets businesses owned by the user. | token: string, userId: string | Promise<IBusiness[]> | | getUserAssociatedBusinesses | Gets businesses associated with the user. | token: string, userId: string | Promise<IBusiness[]> | | registerUser | Registers a new user. | userData: IRegisterUserParams | Promise<Omit<IRegisterUserParams, 'password'> & { id: string }> | | getUserNotificationsReceiver | Gets the notification receiver settings for a user. | token: string, userId: string | Promise<INotificationReceiverResponse> | | getBusinessById | Retrieves a business by its ID. | token: string, businessId: string | Promise<IBusiness> | | getBusinessApplications | Gets applications for a business. | token: string, businessId: string | Promise<IBusinessApplication[]> | | getBusinessManagement | Gets management users for a business. | token: string, businessId: string | Promise<IBusinessManagement> | | getBusinessRolePriviligedUsers | Gets users with a privileged role in a business. | token: string, businessId: string, role: string | Promise<IUserInfo[]> | | sendEmail | Sends an email notification to users. | businessId: string, data: { subject: string; body: string; emails: string[] } | Promise<void> | | sendSms | Sends an SMS notification to a user. | businessId: string, data: { number: string; body: string } | Promise<void> |

Example Usage

import { EccomixApiClient } from "eccomix-api-client";

const client = new EccomixApiClient("https://example-api.example.com");

const userInfo = await client.verifyToken("your-token-here");

const businesses = await client.getUserOwnBusinesses(
  "your-token-here",
  "user-id"
);