@friggframework/api-module-zoho-crm 1.0.1-canary.332f986.0

package/.env.example

@@ -0,0 +1,4 @@
+ZOHO_CRM_CLIENT_ID=
+ZOHO_CRM_CLIENT_SECRET=
+ZOHO_CRM_SCOPE=ZohoCRM.users.ALL,ZohoCRM.org.ALL,ZohoCRM.settings.roles.ALL,ZohoCRM.settings.profiles.ALL
+REDIRECT_URI=http://localhost:3000/redirect

package/LICENSE.md

@@ -0,0 +1,16 @@
+MIT License
+
+Copyright (c) 2022 Left Hook Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,269 @@
+# Zoho CRM
+
+This is the API Module for Zoho CRM that allows the [Frigg](https://friggframework.org) code to talk to the Zoho CRM API.
+
+[Link to the Zoho CRM REST API Postman collection.](https://www.postman.com/zohocrmdevelopers/workspace/zoho-crm-developers/collection/8522016-0a15778a-ccb1-4676-98b7-4cf1fe7fc940?ctx=documentation)
+
+Read more on the [Frigg documentation site](https://docs.friggframework.org/api-modules/list/zoho-crm
+
+
+## Setup a Zoho CRM developer account 
+
+In order to test this api module, you will need to populate your local `.env` file with a set of credentials (`ZOHO_CRM_CLIENT_ID` and `ZOHO_CRM_CLIENT_SECRET`).
+
+To get those, you will need to sign up for a Zoho CRM developer account and [create a new API client](https://www.zoho.com/crm/developer/docs/api/v6/register-client.html), which is explained below.
+
+If you've already done this, skip to the next section. 
+
+1. Go to https://www.zoho.com/crm/developer/ and click `Sign Up For Free`
+![alt text](images/image.jpg)
+
+
+2. Once you're in, set up your example company. Check the `Load Sample Data` box.
+![alt text](images/image-1.jpg)
+
+
+3. Go to your account's API Console at https://api-console.zoho.com/.
+
+    * You may be asked to verify your email address before accessing your API Console
+    ![alt text](images/image-2.jpg)
+
+    * You'll receive an email with a verification link
+    ![alt text](images/image-3.jpg)
+
+
+4. From your API Console, you are able to create client for your account. For our purposes, select `Server-based Applications`.
+![alt text](images/image-5.jpg)
+
+
+5. When filling in the details for your new client, make sure to use `http://localhost:3000/redirect/zoho-crm` in the `Authorized Redirect URIs` field.
+![alt text](images/image-6.jpg)
+
+
+6. After creating the client, you will be sent to the `Client Secret` tab where you can grab your Client ID and Client Secret.
+![alt text](images/image-7.jpg)
+
+
+## Set up your local `.env` file
+
+1. Make a copy of `.env.example` and name it `.env`.
+
+
+2. Grab your Client ID and Client Secret from the Zoho CRM API Console and paste them into your local `.env` file. It should look something like this:
+    ```shell
+    ZOHO_CRM_CLIENT_ID=your_client_id
+    ZOHO_CRM_CLIENT_SECRET=your_client_secret
+    ZOHO_CRM_SCOPE=ZohoCRM.users.ALL,ZohoCRM.org.ALL,ZohoCRM.settings.roles.ALL,ZohoCRM.settings.profiles.ALL
+    REDIRECT_URI=http://localhost:3000/redirect
+    ```
+
+
+## Using the api module from the terminal
+
+With your `.env` in place, you can now open a terminal to play around with the available APIs.
+
+1. Start a `node` terminal in `packages/zoho-crm`
+
+2. Paste the following code into the terminal:
+    ```js
+        require('dotenv').config();
+        const {Authenticator} = require('@friggframework/test');
+        const {Api} = require('./api.js');
+
+        api = new Api({
+            client_id: process.env.ZOHO_CRM_CLIENT_ID,
+            client_secret: process.env.ZOHO_CRM_CLIENT_SECRET,
+            scope: process.env.ZOHO_CRM_SCOPE,
+            redirect_uri: `${process.env.REDIRECT_URI}/zoho-crm`,
+        });
+
+        const url = await api.getAuthUri();
+        const response = await Authenticator.oauth2(url);
+        const baseArr = response.base.split('/');
+        response.entityType = baseArr[baseArr.length - 1];
+        delete response.base;
+
+        await api.getTokenFromCode(response.data.code);
+
+        console.log('api ready!');
+
+    ```
+
+3. Your browser will open a tab and send you to Zoho CRM to authorize the client. You may need to log in first.
+    ![alt text](images/image-9.jpg)
+
+
+4. After authorizing, the tokens are returned to your terminal where they are used to create an authenticated instance of the Zoho CRM API module in the `api` variable. From here you can call any of the existing API resources defined in the module.
+    * List existing Users:
+        ```js
+        > await api.listUsers()
+        {
+          users: [
+            {
+              country: 'HN',
+              name_format__s: 'Salutation,First Name,Last Name',
+              language: 'en_US',
+              microsoft: false,
+              '$shift_effective_from': null,
+              id: '6238474000000461001',
+              state: 'Francisco Morazan',
+              fax: null,
+              country_locale: 'en_US',
+              sandboxDeveloper: false,
+              zip: null,
+              decimal_separator: 'Period',
+              created_time: '2024-04-20T10:35:36-06:00',
+              time_format: 'hh:mm a',
+              offset: -21600000,
+              profile: [Object],
+              created_by: [Object],
+              zuid: '851289894',
+              full_name: 'Armando Alvarado',
+              phone: '32415425',
+              dob: null,
+              sort_order_preference__s: 'First Name,Last Name',
+              status: 'active',
+              role: [Object],
+              customize_info: [Object],
+              city: null,
+              signature: null,
+              locale: 'en_US',
+              personal_account: false,
+              Source__s: null,
+              Isonline: false,
+              default_tab_group: '0',
+              Modified_By: [Object],
+              street: null,
+              '$current_shift': null,
+              alias: null,
+              theme: [Object],
+              first_name: 'Armando Alvarado',
+              email: 'aaj2006@hotmail.com',
+              status_reason__s: null,
+              website: null,
+              Modified_Time: '2024-04-20T10:37:55-06:00',
+              '$next_shift': null,
+              mobile: null,
+              last_name: null,
+              time_zone: 'America/Tegucigalpa',
+              number_separator: 'Comma',
+              confirm: true,
+              date_format: 'MM-dd-yyyy',
+              category: 'regular_user'
+            }
+          ]
+        }
+        ```
+
+    * List existing Roles:
+        ```js
+        > await api.listRoles()
+        {
+          roles: [
+            {
+              display_label: 'CEO',
+              created_by__s: null,
+              modified_by__s: null,
+              forecast_manager: null,
+              share_with_peers: true,
+              modified_time__s: null,
+              name: 'CEO',
+              description: 'Users with this role have access to   the data owned by all other users.',
+              reporting_to: null,
+              id: '6238474000000026005',
+              created_time__s: null
+            },
+            {
+              display_label: 'Manager',
+              created_by__s: null,
+              modified_by__s: null,
+              forecast_manager: null,
+              share_with_peers: false,
+              modified_time__s: null,
+              name: 'Manager',
+              description: 'Users belonging to this role cannot   see data for admin users.',
+              reporting_to: [Object],
+              id: '6238474000000026008',
+              created_time__s: null
+            }
+          ]
+        }
+        ```
+
+## Using this API module in a Frigg instance
+1. Run `npm install @friggframework/api-module-zoho-crm`
+
+2. Populate your `.env` file with `ZOHO_CRM_CLIENT_ID`, `ZOHO_CRM_CLIENT_SECRET`, and `ZOHO_CRM_SCOPE`.
+
+3. Create a subclass of `IntegrationBase` from `@friggframework/core` in `src/integrations` and plug in the Zoho CRM API module. Example:
+    ```js
+    const { IntegrationBase, Options } = require('@friggframework/core');
+    const { Definition: ZohoCRMModule } = require('@friggframework/api-module-zoho-crm');
+    const _ = require('lodash');
+
+    class ZohoCRMIntegration extends IntegrationBase {
+        static Config = {
+            name: 'zoho-crm',
+            version: '1.0.0',
+            supportedVersions: ['1.0.0'],
+            events: ['GET_SOMETHING'],
+        };
+
+        static Options =
+            new Options({
+                module: ZohoCRMModule,
+                integrations: [ZohoCRMModule],
+                display: {
+                    name: 'Zoho CRM',
+                    description: 'CRM Stuff',
+                    category: 'CRM',
+                    detailsUrl: 'https://www.zoho.com/crm/',
+                    icon: 'https://static.zohocdn.com/crm/images/favicon_cbfca4856ba4bfb37be615b152f95251_.ico',
+                }
+            });
+
+        static modules = {
+            'zoho-crm': ZohoCRMModule
+        }
+
+        /**
+        * HANDLE EVENTS
+        */
+        async receiveNotification(notifier, event, object = null) {
+            if (event === 'GET_SOMETHING') {
+                return this.target.api.getProjects();
+            }
+        }
+
+        /**
+        * ALL CUSTOM/OPTIONAL METHODS FOR AN INTEGRATION
+        */
+        async getSampleData() {
+            const response = await this.target.api.listRoles();
+            const data = response.roles.map(role => ({
+                'Id': role.id,
+                'Name': role.name,
+                'Description': role.description,
+            }));
+            return {data};
+        }
+    }
+    
+    module.exports = ZohoCRMIntegration;
+    ```
+
+4. Plug your subclass into your app definition's `integrations` array. 
+![alt text](images/image-11.jpg)
+
+5. Zoho CRM should now appear in your list of available integrations
+![alt text](images/image-12.jpg)
+
+
+## Running the tests
+
+The API tests verify that the usual CRUD operations against the API resources work as expected. Because of that, you will need to have a valid set of credentials in your local `.env` file.
+
+When running `npm run test`, a browser tab will open to ask you for authorization. After you've authorized, the tests will run and produce an output similar to this:
+![alt text](images/image-10.jpg)
+
+**Note:** There is a 30-second timeout for the authorization request. You may need to try again if your browser does not open fast enough.

package/api.js

@@ -0,0 +1,169 @@
+const FormData = require('form-data');
+const {OAuth2Requester, get} = require('@friggframework/core');
+
+class Api extends OAuth2Requester {
+    constructor(params) {
+        super(params);
+        // The majority of the properties for OAuth are default loaded by OAuth2Requester.
+        // This includes the `client_id`, `client_secret`, `scopes`, and `redirect_uri`.
+        this.baseUrl = 'https://www.zohoapis.com/crm/v6';
+        this.authorizationUri = encodeURI(
+            `https://accounts.zoho.com/oauth/v2/auth?scope=${this.scope}&client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code&access_type=offline`
+        );
+        this.tokenUri = 'https://accounts.zoho.com/oauth/v2/token';
+        this.access_token = get(params, 'access_token', null);
+        this.refresh_token = get(params, 'refresh_token', null);
+
+        this.URLs = {
+            // Users
+            users: '/users',
+            user: (userId) => `/users/${userId}`,
+
+            // Roles
+            roles: '/settings/roles',
+            role: (roleId) => `/settings/roles/${roleId}`,
+
+            // Profiles
+            profiles: '/settings/profiles',
+        };
+    }
+
+    getAuthUri() {
+        return this.authorizationUri;
+    }
+
+    async getTokenFromCode(code) {
+        // I had to override OAuth2Requester.getTokenFromCode method so I could send a form-data,
+        // as described in the docs: https://www.zoho.com/crm/developer/docs/api/v6/access-refresh.html
+        const formData = new FormData();
+        formData.append('grant_type', 'authorization_code');
+        formData.append('client_id', this.client_id);
+        formData.append('client_secret', this.client_secret);
+        formData.append('redirect_uri', this.redirect_uri);
+        formData.append('scope', this.scope);
+        formData.append('code', code);
+        const options = {
+            body: formData,
+            headers: formData.getHeaders(),
+            url: this.tokenUri,
+        };
+        const response = await this._post(options, false);
+        await this.setTokens(response);
+        return response;
+    }
+
+    addJsonHeaders(options) {
+        const jsonHeaders = {
+            'content-type': 'application/json',
+            Accept: 'application/json',
+        };
+        options.headers = {
+            ...jsonHeaders,
+            ...options.headers,
+        }
+    }
+
+    async _get(options, stringify) {
+        this.addJsonHeaders(options);
+        return super._get(options, stringify);
+    }
+
+    async _post(options, stringify) {
+        this.addJsonHeaders(options);
+        return super._post(options, stringify);
+    }
+
+    async _put(options, stringify) {
+        this.addJsonHeaders(options);
+        return super._put(options, stringify);
+    }
+
+    async _delete(options) {
+        this.addJsonHeaders(options);
+        const response = await super._delete(options);
+        return await this.parsedBody(response);
+    }
+
+    // **************************   Users   **********************************
+    // https://www.zoho.com/crm/developer/docs/api/v6/get-users.html
+
+    async listUsers(queryParams = {}) {
+        return this._get({
+            url: this.baseUrl + this.URLs.users,
+            query: {...queryParams},
+        });
+    }
+
+    async getUser(userId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.user(userId),
+        });
+    }
+
+    async createUser(body = {}) {
+        return this._post({
+            url: this.baseUrl + this.URLs.users,
+            body: body
+        });
+    }
+
+    async updateUser(userId, body = {}) {
+        return this._put({
+            url: this.baseUrl + this.URLs.user(userId),
+            body: body,
+        });
+    }
+
+    async deleteUser(userId) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.user(userId),
+        });
+    }
+
+    // **************************   Roles   **********************************
+    // https://www.zoho.com/crm/developer/docs/api/v6/get-roles.html
+    
+    async listRoles() {
+        return this._get({
+            url: this.baseUrl + this.URLs.roles
+        });
+    }
+
+    async getRole(roleId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.role(roleId)
+        });
+    }
+
+    async createRole(body = {}) {
+        return this._post({
+            url: this.baseUrl + this.URLs.roles,
+            body: body
+        });
+    }
+
+    async updateRole(roleId, body = {}) {
+        return this._put({
+            url: this.baseUrl + this.URLs.role(roleId),
+            body: body,
+        });
+    }
+
+    async deleteRole(roleId, queryParams = {}) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.role(roleId),
+            query: {...queryParams},
+        });
+    }
+
+    // **************************   Profiles   **********************************
+    // https://www.zoho.com/crm/developer/docs/api/v6/get-profiles.html
+
+    async listProfiles() {
+        return this._get({
+            url: this.baseUrl + this.URLs.profiles
+        });
+    }
+}
+
+module.exports = {Api};

package/defaultConfig.json

@@ -0,0 +1,13 @@
+{
+  "name": "zoho-crm",
+  "label": "Zoho CRM",
+  "productUrl": "https://www.zoho.com/crm/",
+  "apiDocs": "https://www.zoho.com/crm/developer/docs/",
+  "logoUrl": "https://friggframework.org/assets/img/zoho-crm-512.png",
+  "categories": [
+    "Sales",
+    "Marketing",
+    "CRM"
+  ],
+  "description": "Zoho CRM acts as a single repository to bring your sales, marketing, and customer support activities together, and streamline your process, policy, and people in one platform."
+}

package/definition.js

@@ -0,0 +1,51 @@
+require('dotenv').config();
+const {Api} = require('./api');
+const {get} = require('@friggframework/core');
+const config = require('./defaultConfig.json')
+
+const Definition = {
+    API: Api,
+    getName: function() {
+        return config.name
+    },
+    moduleName: config.name,
+    requiredAuthMethods: {
+        getToken: async function(api, params) {
+            const code = get(params.data, 'code'); 
+            await api.getTokenFromCode(code);
+        },
+	    apiPropertiesToPersist: {
+            credential: ['access_token', 'refresh_token'],
+            entity: [],
+        },
+        getCredentialDetails: async function (api, userId) {
+            const response = await api.listUsers({type: 'CurrentUser'});
+            const currentUser = response.users[0];
+            return {
+                identifiers: {externalId: currentUser.id, user: userId},
+                details: {},
+            };
+        },
+        getEntityDetails: async function (api, callbackParams, tokenResponse, userId) {
+            const response = await api.listUsers({type: 'CurrentUser'});
+            const currentUser = response.users[0];
+            return {
+                identifiers: {externalId: currentUser.id, user: userId},
+                details: {
+                    name: currentUser.email
+                },
+            }
+        },
+        testAuthRequest: async function(api) {
+            return  await api.listUsers();
+        },
+    },
+    env: {
+        client_id: process.env.ZOHO_CRM_CLIENT_ID,
+        client_secret: process.env.ZOHO_CRM_CLIENT_SECRET,
+        scope: process.env.ZOHO_CRM_SCOPE,
+        redirect_uri: `${process.env.REDIRECT_URI}/zoho-crm`,
+    }
+};
+
+module.exports = {Definition};

package/index.js

@@ -0,0 +1,9 @@
+const {Api} = require('./api');
+const Config = require('./defaultConfig');
+const {Definition} = require('./definition');
+
+module.exports = {
+    Api,
+    Config,
+    Definition,
+};

package/jest-setup.js

@@ -0,0 +1,3 @@
+const {globalSetup} = require('@friggframework/test');
+require('dotenv').config();
+module.exports = globalSetup;

package/jest-teardown.js

@@ -0,0 +1,2 @@
+const {globalTeardown} = require('@friggframework/test');
+module.exports = globalTeardown;

package/jest.config.js

@@ -0,0 +1,22 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+module.exports = {
+    // preset: '@friggframework/test-environment',
+    coverageThreshold: {
+        global: {
+            statements: 13,
+            branches: 0,
+            functions: 1,
+            lines: 13,
+        },
+    },
+    // A path to a module which exports an async function that is triggered once before all test suites
+    globalSetup: './jest-setup.js',
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    globalTeardown: './jest-teardown.js',
+
+    testTimeout: 30000,
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@friggframework/api-module-zoho-crm",
+  "version": "1.0.1-canary.332f986.0",
+  "prettier": "@friggframework/prettier-config",
+  "description": "Zoho CRM API module that lets the Frigg Framework interact with Zoho CRM",
+  "main": "index.js",
+  "scripts": {
+    "lint:fix": "prettier --write --loglevel error . && eslint . --fix",
+    "test": "jest"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@friggframework/devtools": "^1.1.2",
+    "@friggframework/test": "^1.1.2",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.22.0",
+    "jest": "^28.1.3",
+    "jest-environment-jsdom": "^28.1.3",
+    "prettier": "^2.7.1"
+  },
+  "dependencies": {
+    "@friggframework/core": "^1.1.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "332f9863623e74ea29795607ac3df0120dc1bc3f"
+}

package/tests/api.test.js

@@ -0,0 +1,195 @@
+const {Authenticator} = require('@friggframework/test');
+const {Api} = require('../api');
+const config = require('../defaultConfig.json');
+const { FetchError } = require('@friggframework/core');
+
+const api = new Api({
+    client_id: process.env.ZOHO_CRM_CLIENT_ID,
+    client_secret: process.env.ZOHO_CRM_CLIENT_SECRET,
+    scope: process.env.ZOHO_CRM_SCOPE,
+    redirect_uri: `${process.env.REDIRECT_URI}/zoho-crm`,
+});
+
+beforeAll(async () => {
+    const url = api.getAuthUri();
+    const response = await Authenticator.oauth2(url);
+    const baseArr = response.base.split('/');
+    response.entityType = baseArr[baseArr.length - 1];
+    delete response.base;
+    await api.getTokenFromCode(response.data.code);
+});
+
+describe(`${config.label} API tests`, () => {
+    let existingRoleId;
+    describe('Test Role resource', () => {
+        it('should list all Roles', async () => {
+            const response = await api.listRoles();
+            expect(response).toHaveProperty('roles');
+            expect(response.roles).toBeInstanceOf(Array);
+            existingRoleId = response.roles[0].id; // needed later, to delete a Role
+        });
+
+        let newRoleId;
+        it('should create a new Role', async () => {
+            const response = await api.createRole({
+                roles: [
+                    {'name': 'Test Role 1000', 'description': 'Just testing stuff'}
+                ]
+            });
+            expect(response).toHaveProperty('roles');
+            expect(response.roles[0].code).toBe('SUCCESS');
+            expect(response.roles[0].message).toBe('Role added');
+            newRoleId = response.roles[0].details.id; // store the id of the newly created Role
+        });
+
+        it('should get the newly created Role by ID', async () => {
+            const response = await api.getRole(newRoleId);
+            expect(response).toHaveProperty('roles');
+            expect(response.roles[0].id).toBe(newRoleId);
+            expect(response.roles[0].name).toBe('Test Role 1000');
+            expect(response.roles[0].description).toBe('Just testing stuff');
+        });
+
+        let updatedName = 'Foo';
+        let updatedDescription = 'Bar';
+        it('should update the newly created Role by ID', async () => {
+            const response = await api.updateRole(
+                newRoleId,
+                {roles: [{'name': updatedName, 'description': updatedDescription}]},
+            );
+            expect(response).toHaveProperty('roles');
+            expect(response.roles[0].code).toBe('SUCCESS');
+            expect(response.roles[0].message).toBe('Role updated');
+        });
+
+        it('should receive the updated values when getting the newly created User by ID', async () => {
+            const response = await api.getRole(newRoleId);
+            expect(response).toHaveProperty('roles');
+            expect(response.roles[0].id).toBe(newRoleId);
+            expect(response.roles[0].name).toBe(updatedName);
+            expect(response.roles[0].description).toBe(updatedDescription);
+        });
+
+        it('should delete the newly created Role by ID', async () => {
+            // To delete a Role, the api requires that we send it the ID of
+            // another Role, to which all users will be transfered after the delete.
+            // We rely on one of the existing Roles, whose ID we saved earlier.
+            const response = await api.deleteRole(
+                newRoleId,
+                {'transfer_to_id': existingRoleId}
+            );
+            expect(response).toHaveProperty('roles');
+            expect(response.roles[0].code).toBe('SUCCESS');
+            expect(response.roles[0].message).toBe('Role Deleted');
+        });
+
+        it('should throw FetchError when trying to create with empty params', () => {
+            expect(async () => await api.createRole()).rejects.toThrow(FetchError)
+        });
+    });
+
+    describe('Test User resource', () => {
+        it('should list all Users', async () => {
+            const response = await api.listUsers();
+            expect(response).toHaveProperty('users');
+            expect(response.users).toBeInstanceOf(Array);
+        });
+
+        let newUserId;
+        it('should create a new User', async () => {
+            // To create a new User in Zoho CRM, we need to specify their
+            // Role and Profile by providing the relevant IDs in the request.
+            // So we first need to fetch an existing Role and Profile.
+            const rolesResponse = await api.listRoles();
+            const role = rolesResponse.roles[0];
+            const profilesResponse = await api.listProfiles();
+            const profile = profilesResponse.profiles[0];
+            
+            const response = await api.createUser({
+                users: [{
+                    first_name: 'Test User 1000',
+                    email: 'test@friggframework.org',
+                    role: role.id,
+                    profile: profile.id,
+                }]
+            });
+
+            expect(response).toHaveProperty('users');
+            expect(response.users[0].code).toBe('SUCCESS');
+            expect(response.users[0].message).toBe('User added');
+            newUserId = response.users[0].details.id; // store the id of the newly created User
+        });
+
+        it('should get the newly created User by ID', async () => {
+            const response = await api.getUser(newUserId);
+            expect(response).toHaveProperty('users');
+            expect(response.users[0].id).toBe(newUserId);
+            expect(response.users[0].first_name).toBe('Test User 1000');
+            expect(response.users[0].email).toBe('test@friggframework.org');
+        });
+
+        let updatedFirstName = 'Elon';
+        let updatedEmail = 'musk@friggframework.com';
+        it('should update the newly created User by ID', async () => {
+            const response = await api.updateUser(
+                newUserId,
+                {users: [{'first_name': updatedFirstName, 'email': updatedEmail}]},
+            );
+            expect(response).toHaveProperty('users');
+            expect(response.users[0].code).toBe('SUCCESS');
+            expect(response.users[0].message).toBe('User updated');
+        });
+
+        it('should receive the updated values when getting the newly created User by ID', async () => {
+            const response = await api.getUser(newUserId);
+            expect(response).toHaveProperty('users');
+            expect(response.users[0].id).toBe(newUserId);
+            expect(response.users[0].first_name).toBe(updatedFirstName);
+            expect(response.users[0].email).toBe(updatedEmail);
+        });
+
+        it('should delete the newly created User by ID', async () => {
+            const response = await api.deleteUser(newUserId);
+            expect(response).toHaveProperty('users');
+            expect(response.users[0].code).toBe('SUCCESS');
+            expect(response.users[0].message).toBe('User deleted');
+        });
+
+        it('should throw FetchError when trying to create with empty params', () => {
+            expect(async () => await api.createUser()).rejects.toThrow(FetchError)
+        });
+    });
+
+    describe('Test Profile resource', () => {
+        it('should list all Profiles', async () => {
+            const response = await api.listProfiles();
+            expect(response).toHaveProperty('profiles');
+            expect(response.profiles).toBeInstanceOf(Array);
+        });
+
+        it.skip('should create a new Profile', async () => {
+            // TODO
+        });
+
+        it.skip('should get the newly created Profile by ID', async () => {
+            // TODO
+        });
+
+        it.skip('should update the newly created Profile by ID', async () => {
+            // TODO
+        });
+
+        it.skip('should receive the updated values when getting the newly created Profile by ID', async () => {
+            // TODO
+        });
+
+        it.skip('should delete the newly created Profile by ID', async () => {
+            // TODO
+        });
+
+        it.skip('should throw FetchError when trying to create with empty params', () => {
+            // TODO
+        });
+    });
+
+});