@ilb/docprocess-api

@IlbDocprocessApi - JavaScript client for @ilb/docprocess-api This SDK is automatically generated by the OpenAPI Generator project:

• API version:
• Package version: 1.21.3
• Build package: org.openapitools.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 @ilb/docprocess-api --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 @ilb/docprocess-api 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/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):

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 @IlbDocprocessApi = require('@ilb/docprocess-api');


var api = new @IlbDocprocessApi.ApiSavePassport1PhpApi()
var opts = {
  'savePassport1': new @IlbDocprocessApi.SavePassport1() // {SavePassport1} 
};
api.savePassport1(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @IlbDocprocessApi.ApiSavePassport1PhpApi | savePassport1 | POST /api.save.passport_1.php | @IlbDocprocessApi.ApiSessionCreatePhpApi | createSession | POST /api.session.create.php | @IlbDocprocessApi.ApiSessionCrmUploadPhpApi | sessionCrmUpload | POST /api.session.crm.upload.php | @IlbDocprocessApi.ApiSessionEditPhpApi | editSession | POST /api.session.edit.php | @IlbDocprocessApi.ApiSessionGetClientPhotoPhpApi | sessionGetClientPhoto | GET /api.session.getClientPhoto.php | @IlbDocprocessApi.ApiSessionGetDocumentPhpApi | sessionGetDocument | GET /api.session.getDocument.php | @IlbDocprocessApi.ApiSessionGetPhpApi | getSession | GET /api.session.get.php | @IlbDocprocessApi.ApiSessionGetTextMessagePhpApi | sessionGetTextMessage | GET /api.session.getTextMessage.php | @IlbDocprocessApi.ApiSessionResetPhpApi | sessionReset | GET /api.session.reset.php | @IlbDocprocessApi.ApiSessionSaveDocumentsPhpApi | sessionSaveDocuments | POST /api.session.save.documents.php | @IlbDocprocessApi.ApiSessionsMergePhpApi | sessionsMerge | POST /api.sessions.merge.php | @IlbDocprocessApi.ApiTaskCreatePhpApi | createTask | POST /api.task.create.php | @IlbDocprocessApi.ApiTaskGetPhpApi | getTask | GET /api.task.get.php | @IlbDocprocessApi.ApiTaskRestartPhpApi | restartTask | GET /api.task.restart.php | @IlbDocprocessApi.ApiTasksGetPhpApi | getTasks | GET /api.tasks.get.php | @IlbDocprocessApi.DocprocessCallbackApi | getDocForm | GET /docprocessCallback/docform | @IlbDocprocessApi.DocprocessCallbackApi | saveClientPhoto | POST /docprocessCallback/clientPhoto | @IlbDocprocessApi.DocprocessCallbackApi | saveDriverLicence | POST /docprocessCallback/driverLicence | @IlbDocprocessApi.DocprocessCallbackApi | savePartActivity | POST /docprocessCallback/partActivity | @IlbDocprocessApi.DocprocessCallbackApi | savePassport1CallBack | POST /docprocessCallback/passport1 | @IlbDocprocessApi.DocprocessCallbackApi | savePassportChildren | POST /docprocessCallback/passportChildren | @IlbDocprocessApi.DocprocessCallbackApi | savePassportMarry | POST /docprocessCallback/passportMarry | @IlbDocprocessApi.DocprocessCallbackApi | savePassportPrevPassport | POST /docprocessCallback/passportPrevPassport | @IlbDocprocessApi.DocprocessCallbackApi | savePassportRegistration | POST /docprocessCallback/passportRegistration | @IlbDocprocessApi.DocprocessCallbackApi | saveSessionOverall | POST /docprocessCallback/overall | @IlbDocprocessApi.DocprocessCallbackApi | saveSnils | POST /docprocessCallback/snils | @IlbDocprocessApi.DocprocessCallbackApi | searchQuestionnaires | GET /docprocessCallback/questionnairesList | @IlbDocprocessApi.FileGetByUidPhpApi | sessionGetFile | GET /file.getByUid.php | @IlbDocprocessApi.FileGetPDFPhpApi | sessionGetPDF | GET /file.getPDF.php | @IlbDocprocessApi.HeartbeatApi | heartbeat | GET /heartbeat |

Documentation for Models

• @IlbDocprocessApi.Action
• @IlbDocprocessApi.AddDocFormFields
• @IlbDocprocessApi.AnswerType
• @IlbDocprocessApi.DocFormField
• @IlbDocprocessApi.DocprocessCallbackDocFormResponse
• @IlbDocprocessApi.DocprocessCallbackQuestionnairesListResponse
• @IlbDocprocessApi.DocprocessCallbackRequestType
• @IlbDocprocessApi.DocprocessCallbackResponse
• @IlbDocprocessApi.Docspot
• @IlbDocprocessApi.DocspotResultBoxBlockType
• @IlbDocprocessApi.DocspotResultBoxMainValueType
• @IlbDocprocessApi.DocspotResultBoxType
• @IlbDocprocessApi.DocspotResultType
• @IlbDocprocessApi.DocumentType
• @IlbDocprocessApi.DocumentTypeField
• @IlbDocprocessApi.DocumentTypeFieldList
• @IlbDocprocessApi.DocumentTypesElement
• @IlbDocprocessApi.Documents
• @IlbDocprocessApi.QuestionAnswer
• @IlbDocprocessApi.QuestionnairesListDocumentType
• @IlbDocprocessApi.QuestionnairesListQuestionnaireType
• @IlbDocprocessApi.QuestionnairesListQuestionnairesType
• @IlbDocprocessApi.SaveClientPhoto
• @IlbDocprocessApi.SaveClientPhotoAllOf
• @IlbDocprocessApi.SaveDocumentType
• @IlbDocprocessApi.SaveDocumentTypeAllOf
• @IlbDocprocessApi.SaveDocuments
• @IlbDocprocessApi.SaveDriverLicence
• @IlbDocprocessApi.SaveDriverLicenceAllOf
• @IlbDocprocessApi.SavePassport1
• @IlbDocprocessApi.SavePassportChildren
• @IlbDocprocessApi.SavePassportMarry
• @IlbDocprocessApi.SavePassportPrevPassport
• @IlbDocprocessApi.SavePassportRegistration
• @IlbDocprocessApi.SaveSnils
• @IlbDocprocessApi.Session
• @IlbDocprocessApi.TaskInfo
• @IlbDocprocessApi.Tasks

Documentation for Authorization

All endpoints do not require authorization.