1.0.1 • Published 1 year ago

signy-client-sdk v1.0.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
1 year ago

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 NameDefinition
AuthApiAll Api's regarding to Authentication
UserApiAll Api's regarding to User
SignyApiAll Api's regarding to Signy
CompanyApiAll Api's regarding to Comapany
ContactApiAll Api's regarding to Contacts
DocumentApiAll Api's regarding to Documents
DocumentInputApiAll Api's regarding to Document Inputs
SignatoryApiAll Api's regarding to Signatory
SignyEmailApiAll Api's regarding to Email
SignyShareApiAll Api's regarding to Share
SubscriptionsApiAll Api's regarding to Subscriptions
ProfileApiAll Api's regarding to Profile
VerificationApiAll 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