1.0.1 • Published 3 years ago
signy-client-sdk v1.0.1
signy-client-sdk
Client SDK for Signy server api's
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)
Installation
First build the package then run npm i signy-client-sdk
API Modules
| Module Name | Definition |
|---|---|
| AuthApi | All Api's regarding to Authentication |
| UserApi | All Api's regarding to User |
| SignyApi | All Api's regarding to Signy |
| CompanyApi | All Api's regarding to Comapany |
| ContactApi | All Api's regarding to Contacts |
| DocumentApi | All Api's regarding to Documents |
| DocumentInputApi | All Api's regarding to Document Inputs |
| SignatoryApi | All Api's regarding to Signatory |
| SignyEmailApi | All Api's regarding to Email |
| SignyShareApi | All Api's regarding to Share |
| SubscriptionsApi | All Api's regarding to Subscriptions |
| ProfileApi | All Api's regarding to Profile |
| VerificationApi | All Api's regarding to Verification |
Example usage of Api Modules
import {UserApi,Configuration} from 'signy-client-sdk'
export class ExampleService {
private userApis: UserApi;
private config: Configuration
constructor(){
this.config.apiKey = 'apiKey';
this.config.accessToken = 'sessionToken';
}
async signOut():Promise<boolean>{
const res = await this.userApis.userControllerSignOut();
return res.data.ok
}
}Extra info
signy-client-sdk has all typings like dto's, constants, enums included in it so you can import and use them as well