@formapi/formapi

FormAPI - JavaScript client for @formapi/formapi No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.0.0
• Build package: io.formapi.codegen.FormApiJavascriptClientCodegen

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 @formapi/formapi --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 @formapi/formapi from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('@formapi/formapi') 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 FormAPI = require('@formapi/formapi');

var defaultClient = FormAPI.ApiClient.instance;

// Configure HTTP basic authorization: api_token_basic
var api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME'
api_token_basic.password = 'YOUR PASSWORD'

var api = new FormAPI.PDFApi()
var templateId = tpl_000000000000000001; // {String} 
var createSubmissionData = [new FormAPI.CreateSubmissionData()]; // {[CreateSubmissionData]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchGeneratePDF(templateId, createSubmissionData, callback);

Documentation for API Endpoints

All URIs are relative to https://app.formapi.io/api/v1

Class	Method	HTTP request	Description
FormAPI.PDFApi	batchGeneratePDF	POST /templates/{template_id}/submissions/batch	Generates multiple PDFs
FormAPI.PDFApi	combineSubmissions	POST /combined_submissions	Merge generated PDFs together
FormAPI.PDFApi	expireCombinedSubmission	DELETE /combined_submissions/{combined_submission_id}	Expire a combined submission
FormAPI.PDFApi	expireSubmission	DELETE /submissions/{submission_id}	Expire a PDF submission
FormAPI.PDFApi	generatePDF	POST /templates/{template_id}/submissions	Generates a new PDF
FormAPI.PDFApi	getCombinedSubmission	GET /combined_submissions/{combined_submission_id}	Check the status of a combined submission (merged PDFs)
FormAPI.PDFApi	getSubmission	GET /submissions/{submission_id}	Check the status of a PDF
FormAPI.PDFApi	getTemplates	GET /templates	Get a list of all templates
FormAPI.PDFApi	testAuthentication	GET /authentication	Test Authentication

Documentation for Models

• FormAPI.AuthenticationError
• FormAPI.AuthenticationSuccessResponse
• FormAPI.CombinedSubmission
• FormAPI.CombinedSubmissionData
• FormAPI.CreateCombinedSubmissionResponse
• FormAPI.CreateSubmissionData
• FormAPI.CreateSubmissionResponse
• FormAPI.Error
• FormAPI.InvalidRequest
• FormAPI.Submission
• FormAPI.Template

Documentation for Authorization

api_token_basic

• Type: HTTP basic authentication