Skip to content
This repository was archived by the owner on Apr 14, 2024. It is now read-only.
/ eZmax-SDK-javascript Public archive

The Official eZmax and eZsign Javascript SDK for interacting with the REST API.

www.ezsign.ca/

License

MIT license
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

eZmaxinc/eZmax-SDK-javascript

BranchesTags

Repository files navigation

e_zmax_api_definition

EZmaxApiDefinition - JavaScript client for e_zmax_api_definition This API expose all the functionnalities for the eZmax and eZsign applications. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.4
  • Package version: 1.1.4
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.ezmax.ca/en/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install e_zmax_api_definition --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your e_zmax_api_definition from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/ezmaxinc/ezmax-sdk-javascript then install it via:

 npm install ezmaxinc/ezmax-sdk-javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: { rules: [ { parser: { amd: false } } ] }

Getting Started

Please follow the installation instruction and execute the following JS code:

var EZmaxApiDefinition = require('e_zmax_api_definition'); var defaultClient = EZmaxApiDefinition.ApiClient.instance; // Configure API key authorization: Authorization var Authorization = defaultClient.authentications['Authorization']; Authorization.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Authorization.apiKeyPrefix['Authorization'] = "Token" var api = new EZmaxApiDefinition.GlobalCustomerApi() var pksCustomerCode = "pksCustomerCode_example"; // {String}  var opts = { 'sInfrastructureproductCode': "sInfrastructureproductCode_example" // {String} The infrastructure product Code If undefined, \"appcluster01\" is assumed }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.globalCustomerGetEndpointV1(pksCustomerCode, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Class Method HTTP request Description
EZmaxApiDefinition.GlobalCustomerApi globalCustomerGetEndpointV1 GET /1/customer/{pksCustomerCode}/endpoint Get customer endpoint
EZmaxApiDefinition.ModuleAuthenticateApi authenticateAuthenticateV2 POST /2/module/authenticate/authenticate/{eSessionType} Authenticate a user
EZmaxApiDefinition.ModuleListApi listGetListpresentationV1 GET /1/module/list/listpresentation/{sListName} Get all Listpresentation for a specific list
EZmaxApiDefinition.ModuleListApi listSaveListpresentationV1 POST /1/module/list/listpresentation/{sListName} Save all Listpresentation for a specific list
EZmaxApiDefinition.ModuleSsprApi ssprResetPasswordRequestV1 POST /1/module/sspr/resetPasswordRequest Reset Password Request
EZmaxApiDefinition.ModuleSsprApi ssprResetPasswordV1 POST /1/module/sspr/resetPassword Reset Password
EZmaxApiDefinition.ModuleSsprApi ssprSendUsernamesV1 POST /1/module/sspr/sendUsernames Send username(s)
EZmaxApiDefinition.ModuleSsprApi ssprUnlockAccountRequestV1 POST /1/module/sspr/unlockAccountRequest Unlock Account Request
EZmaxApiDefinition.ModuleSsprApi ssprUnlockAccountV1 POST /1/module/sspr/unlockAccount Unlock Account
EZmaxApiDefinition.ModuleSsprApi ssprValidateTokenV1 POST /1/module/sspr/validateToken Validate Token
EZmaxApiDefinition.ModuleUserApi userCreateEzsignuserV1 POST /1/module/user/createezsignuser Create a new User of type Ezsignuser
EZmaxApiDefinition.ObjectActivesessionApi activesessionGetCurrentV1 GET /1/object/activesession/getCurrent Get Current Activesession
EZmaxApiDefinition.ObjectApikeyApi apikeyCreateObjectV1 POST /1/object/apikey Create a new Apikey
EZmaxApiDefinition.ObjectEzsignbulksendApi ezsignbulksendGetListV1 GET /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsign Template to the Ezsigndocument.
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV2 POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate Apply an Ezsign Template to the Ezsigndocument.
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentCreateObjectV1 POST /1/object/ezsigndocument Create a new Ezsigndocument
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentDeleteObjectV1 DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentGetDownloadUrlV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentGetEzsignpagesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentGetFormDataV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentGetObjectV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
EZmaxApiDefinition.ObjectEzsigndocumentApi ezsigndocumentGetWordsPositionsV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigndocument
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderCreateObjectV1 POST /1/object/ezsignfolder Create a new Ezsignfolder
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderDeleteObjectV1 DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderGetEzsigndocumentsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderGetEzsignfoldersignerassociationsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderGetFormsDataV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderGetListV1 GET /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderGetObjectV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderSendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
EZmaxApiDefinition.ObjectEzsignfolderApi ezsignfolderUnsendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder
EZmaxApiDefinition.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateObjectV1 POST /1/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
EZmaxApiDefinition.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationDeleteObjectV1 DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Delete an existing Ezsignfoldersignerassociation
EZmaxApiDefinition.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetInPersonLoginUrlV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl Retrieve a Login Url to allow In-Person signing
EZmaxApiDefinition.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetObjectV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
EZmaxApiDefinition.ObjectEzsignfoldertypeApi ezsignfoldertypeGetAutocompleteV1 GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
EZmaxApiDefinition.ObjectEzsignfoldertypeApi ezsignfoldertypeGetListV1 GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
EZmaxApiDefinition.ObjectEzsignsignatureApi ezsignsignatureCreateObjectV1 POST /1/object/ezsignsignature Create a new Ezsignsignature
EZmaxApiDefinition.ObjectEzsignsignatureApi ezsignsignatureDeleteObjectV1 DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
EZmaxApiDefinition.ObjectEzsignsignatureApi ezsignsignatureGetObjectV1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
EZmaxApiDefinition.ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetListV1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
EZmaxApiDefinition.ObjectFranchisebrokerApi franchisebrokerGetAutocompleteV1 GET /1/object/franchisebroker/getAutocomplete/{sSelector} Retrieve Franchisebrokers and IDs
EZmaxApiDefinition.ObjectFranchiseofficeApi franchiseofficeGetAutocompleteV1 GET /1/object/franchiseoffice/getAutocomplete/{sSelector} Retrieve Franchiseoffices and IDs
EZmaxApiDefinition.ObjectFranchisereferalincomeApi franchisereferalincomeCreateObjectV1 POST /1/object/franchisereferalincome Create a new Franchisereferalincome
EZmaxApiDefinition.ObjectPeriodApi periodGetAutocompleteV1 GET /1/object/period/getAutocomplete/{sSelector} Retrieve Periods and IDs

Documentation for Models

Documentation for Authorization

Authorization

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

The Official eZmax and eZsign Javascript SDK for interacting with the REST API.

www.ezsign.ca/

Topics

accounting electronic-signatures esignatures electronic-document sdk-javascript ezmax ezsign

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

38 tags

Packages

No packages published

Languages