npm package: @ilb/docprocess-api
Description: Client library of @ilb/docprocess-api
Latest version: 1.21.4

# @ilb/docprocess-api

@IlbDocprocessApi - JavaScript client for @ilb/docprocess-api
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 
- Package version: 1.21.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @ilb/docprocess-api --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

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


## Documentation for Models

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


## Documentation for Authorization

All endpoints do not require authorization.