visma-sign-client

VismaSignClient - JavaScript client for visma-sign-client Swagger documentation for Visma-Sign API. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.6
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 visma-sign-client --save

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

Finally, switch to the directory you want to use your visma-sign-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('visma-sign-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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, that's to say your javascript file where you actually use this library):

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 VismaSignClient = require('visma-sign-client');

var api = new VismaSignClient.AuthenticationsApi()

var opts = { 
  'includeAllIdProviders': true // {Boolean} By default, only Finnish authentication methods are provided. By adding the GET parameter value includeAllIdProviders=true to the request, Nordic authentication methods will also be included in the response.
};
api.getAuthenticationMethods(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://www.onnistuu.fi/api/v1

Class	Method	HTTP request	Description
VismaSignClient.AuthenticationsApi	getAuthenticationMethods	GET /auth/methods	Gets authentication methods
VismaSignClient.CategoriesApi	createCategory	POST /category/	Creates new category
VismaSignClient.CategoriesApi	deleteCategory	DELETE /category/{categoryId}	Deletes category
VismaSignClient.CategoriesApi	getCategories	GET /category/	Gets categories
VismaSignClient.CategoriesApi	updateCategory	PATCH /category/{categoryId}	Updates category
VismaSignClient.DocumentsApi	cancelDocument	POST /document/{documentId}/cancel	Cancels document
VismaSignClient.DocumentsApi	createDocument	POST /document/	Creates new document
VismaSignClient.DocumentsApi	deleteDocument	DELETE /document/{documentId}	Deletes document
VismaSignClient.DocumentsApi	getDocumentStatus	GET /document/{documentId}	Finds document status
VismaSignClient.DocumentsApi	remindDocumentInvitees	POST /document/{documentId}/remind	Remaind all document invitees
VismaSignClient.DocumentsApi	searchDocuments	GET /document/	Search documents
VismaSignClient.FilesApi	addDocumentFile	POST /document/{documentId}/files	Adds file to document
VismaSignClient.FilesApi	getDocumentFile	GET /document/{documentId}/files/{fileIndex}	Finds document file
VismaSignClient.InvitationsApi	createDocumentInvitation	POST /document/{documentId}/invitations	Create invitations for document
VismaSignClient.InvitationsApi	fullfillInvitation	POST /invitation/{invitationId}/signature	Fulfills invitation
VismaSignClient.InvitationsApi	getInvitationStatus	GET /invitation/{invitationId}	Finds invitation status
VismaSignClient.InvitationsApi	remindSingleInvitee	POST /invitation/{invitationId}/remind	Reminds single invitee
VismaSignClient.InviteeGroupsApi	getInviteeGroups	GET /invitee-group/	Gets invitee groups
VismaSignClient.SavedInvitationMessagesApi	getSavedEmailMessages	GET /saved-invitation-message/email/	Gets saved email messages
VismaSignClient.SavedInvitationMessagesApi	getSavedSmsMessages	GET /saved-invitation-message/sms/	Gets saved sms messages

Documentation for Models

• VismaSignClient.Affiliate
• VismaSignClient.AuthenticationMethod
• VismaSignClient.AuthenticationMethods
• VismaSignClient.BadRequest
• VismaSignClient.Categories
• VismaSignClient.Category
• VismaSignClient.Document
• VismaSignClient.DocumentDocument
• VismaSignClient.DocumentFile
• VismaSignClient.DocumentInvitationStatus
• VismaSignClient.DocumentSearchResult
• VismaSignClient.DocumentStatus
• VismaSignClient.Forbidden
• VismaSignClient.InlineResponse200
• VismaSignClient.InternalServerError
• VismaSignClient.InvitationCreate
• VismaSignClient.InvitationCreateInviter
• VismaSignClient.InvitationCreateMessages
• VismaSignClient.InvitationCreateOrder
• VismaSignClient.InvitationCreateResponse
• VismaSignClient.InvitationFullfillment
• VismaSignClient.InvitationStatus
• VismaSignClient.InvitationStatusDocument
• VismaSignClient.InviteeGroup
• VismaSignClient.InviteeGroupEntry
• VismaSignClient.InviteeGroups
• VismaSignClient.NotFound
• VismaSignClient.NotImplemented
• VismaSignClient.SavedEmailMessage
• VismaSignClient.SavedEmailMessages
• VismaSignClient.SavedSmsMessage
• VismaSignClient.SavedSmsMessages

Documentation for Authorization

ApiKeyAuth

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