@opengov/form-builder

Emil Customer SDK

This TypeScript/JavaScript client utilizes axios. The generated Node module can be used with client-based applications (i.e. React).

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via package.json. (Reference)

Consuming

Navigate to the folder of your consuming project and run one of the following commands:

npm install @emilgroup/customer-sdk@1.54.0 --save

or

yarn add @emilgroup/customer-sdk@1.54.0

And then you can import CustomersApi.

import { CustomersApi } from '@emilgroup/customer-sdk'

const customersApi = new CustomersApi();

To use authentication protected endpoints, you have to first authorize. To do so, use the authorize function in CustomersApi:

const apiTenant = new CustomersApi();
await apiTenant.authorize('tenantUsername', 'tenantPassword');
await apiTenant.InviteByCustomer(inviteCustomerPayload);

Refresh Token

Refreshing of token is handled automatically using Cookies and LocalStorage. Instantiating the CustomersApi will automatically load the stored information from LocalStorage.

However, if your page is not already rendered (for instance NextJS), you can manually call the function customersApi.loadTokenData() in a React.useEffect().

React.useEffect(() => {
   customersApi.loadTokenData();
}, []);

To clean token data, on user logout for instance, call the function customersApi.cleanTokenData().

Migration notes

Migration 1.10.x > 1.11.x

• Some components of CustomersApi have been extracted to:
  • AuthenticationApi includes : initiate, respond, refresh-token, and rest/verify/forget password of a customer functionality
  • InvitesApi includes: invite by customer/tenant, verify and register a customer functionality.
  • InvoicesApi includes: list invoices functionality.
  • DocumentsApi includes: list documents, upload documents and Get a presigned download url for document.
  • PaymentsApi includes: initiate/complete payment setup

import { InvoicesApi } from '@emilgroup/customer-sdk'

// First, call initiateAuthorization to get challenge information
try {
  const response = await apiAuthCustomer.initiateAuthorization("username", "password", "tenantSlug");
} catch(error) {
  // process error
}

// after receiving the SMS, call the respondToAuthorizationChallenge method
try {
  const response = await apiAuthCustomer.respondToAuthorizationChallenge({
          challengeResponses: {
              "USERNAME": username,
              "SMS_MFA_CODE": smsCode,
          },
          challengeName,
          tenantSlug,
          session,
      });

  // Customer is now logged in with customersApi and refresh-token will automatically be called.
} catch(error) {
  // process error
}

List invoices

//After login

const invoiceApi = new InvoicesApi();
try {
  const listInvoices = await invoiceApi.listInvoices({customerCode: "me"});
  if ( isMounted ) {
      const { data: { items } } = listInvoices;
  }
} catch ( error ) {
  // process error
}