# synactaclient

> WebApi

Latest version **1.0.0** (published 2016-11-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install synactaclient
pnpm add synactaclient
yarn add synactaclient
bun add synactaclient
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-11-04 |
| First published | 2016-11-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | dzeller |

## Links

- npm: https://www.npmjs.com/package/synactaclient
- npm.io page: https://npm.io/package/synactaclient

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 1.7.1

## Recent versions

- 1.0.0 (latest) — 2016-11-04

## README

# synactaclient

Synactaclient - JavaScript client for synactaclient
WebApi
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: v1
- Package version: v1
- Build date: 2016-11-04T14:51:52.715Z
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
For more information, please visit [http://www.agile-is.de/](http://www.agile-is.de/)

## 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 synactaclient --save
```

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

```shell
    npm install YOUR_USERNAME/synactaclient --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.

## Getting Started

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

```javascript
var Synactaclient = require('synactaclient');

var api = new Synactaclient.AuthorizationApi()

var id = "id_example"; // {String} The principal identifier.

var authorization = "authorization_example"; // {String} access token


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

```

## Documentation for API Endpoints

All URIs are relative to *https://localhost/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Synactaclient.AuthorizationApi* | [**apiAuthorizationPrincipalsByIdGet**](docs/AuthorizationApi.md#apiAuthorizationPrincipalsByIdGet) | **GET** /_api/authorization/Principals/{id} | Provides a principal by his identifier.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationPrincipalsGet**](docs/AuthorizationApi.md#apiAuthorizationPrincipalsGet) | **GET** /_api/authorization/Principals | Gets the principals.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRightsGet**](docs/AuthorizationApi.md#apiAuthorizationRightsGet) | **GET** /_api/authorization/Rights | Gets the rights.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRolesAddGet**](docs/AuthorizationApi.md#apiAuthorizationRolesAddGet) | **GET** /_api/authorization/Roles/Add | Gets the role container.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRolesAddPut**](docs/AuthorizationApi.md#apiAuthorizationRolesAddPut) | **PUT** /_api/authorization/Roles/Add | Adds the role.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRolesByIdDelete**](docs/AuthorizationApi.md#apiAuthorizationRolesByIdDelete) | **DELETE** /_api/authorization/Roles/{id} | Deletes the role.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRolesByIdGet**](docs/AuthorizationApi.md#apiAuthorizationRolesByIdGet) | **GET** /_api/authorization/Roles/{id} | Gets the role.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRolesByIdPost**](docs/AuthorizationApi.md#apiAuthorizationRolesByIdPost) | **POST** /_api/authorization/Roles/{id} | Updates the role.
*Synactaclient.AuthorizationApi* | [**apiAuthorizationRolesGet**](docs/AuthorizationApi.md#apiAuthorizationRolesGet) | **GET** /_api/authorization/Roles | Gets the roles.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdAddByNewContainerTypeGet**](docs/BaseApi.md#apiBaseByTypeByIdAddByNewContainerTypeGet) | **GET** /_api/base/{type}/{id}/Add/{newContainerType} | Gets the empty container.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdAddPut**](docs/BaseApi.md#apiBaseByTypeByIdAddPut) | **PUT** /_api/base/{type}/{id}/Add | Saves the new container.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdCheckinPut**](docs/BaseApi.md#apiBaseByTypeByIdCheckinPut) | **PUT** /_api/base/{type}/{id}/Checkin | Checkins the specified .
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdCheckoutPut**](docs/BaseApi.md#apiBaseByTypeByIdCheckoutPut) | **PUT** /_api/base/{type}/{id}/Checkout | Checkouts the specified .
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdChildrenGet**](docs/BaseApi.md#apiBaseByTypeByIdChildrenGet) | **GET** /_api/base/{type}/{id}/Children | Gets the children of container.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdChildrenTypesGet**](docs/BaseApi.md#apiBaseByTypeByIdChildrenTypesGet) | **GET** /_api/base/{type}/{id}/Children/Types | Gets the container types.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdDelete**](docs/BaseApi.md#apiBaseByTypeByIdDelete) | **DELETE** /_api/base/{type}/{id} | Deletes the container.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdDocumentsGet**](docs/BaseApi.md#apiBaseByTypeByIdDocumentsGet) | **GET** /_api/base/{type}/{id}/Documents | Gets the documents.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdDocumentsTypesGet**](docs/BaseApi.md#apiBaseByTypeByIdDocumentsTypesGet) | **GET** /_api/base/{type}/{id}/Documents/Types | Gets the documents types.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdGet**](docs/BaseApi.md#apiBaseByTypeByIdGet) | **GET** /_api/base/{type}/{id} | Gets the container by identifier.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdGetFileGet**](docs/BaseApi.md#apiBaseByTypeByIdGetFileGet) | **GET** /_api/base/{type}/{id}/GetFile | Gets the file.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdLookupListByLookupListNameGet**](docs/BaseApi.md#apiBaseByTypeByIdLookupListByLookupListNameGet) | **GET** /_api/base/{type}/{id}/LookupList/{lookupListName} | Gets the lookup list entries.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdMovePost**](docs/BaseApi.md#apiBaseByTypeByIdMovePost) | **POST** /_api/base/{type}/{id}/Move | Moves the object.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdPost**](docs/BaseApi.md#apiBaseByTypeByIdPost) | **POST** /_api/base/{type}/{id} | Updates the container.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdUploadFilePost**](docs/BaseApi.md#apiBaseByTypeByIdUploadFilePost) | **POST** /_api/base/{type}/{id}/UploadFile | Uploads the file.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdVersionsByVersionIdGet**](docs/BaseApi.md#apiBaseByTypeByIdVersionsByVersionIdGet) | **GET** /_api/base/{type}/{id}/Versions/{versionId} | Gets the version by identifier.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdVersionsByVersionIdGetFileGet**](docs/BaseApi.md#apiBaseByTypeByIdVersionsByVersionIdGetFileGet) | **GET** /_api/base/{type}/{id}/Versions/{versionId}/GetFile | Gets the file for version.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdVersionsByVersionIdRestorePost**](docs/BaseApi.md#apiBaseByTypeByIdVersionsByVersionIdRestorePost) | **POST** /_api/base/{type}/{id}/Versions/{versionId}/Restore | Restores the version.
*Synactaclient.BaseApi* | [**apiBaseByTypeByIdVersionsGet**](docs/BaseApi.md#apiBaseByTypeByIdVersionsGet) | **GET** /_api/base/{type}/{id}/Versions | Gets the versions.
*Synactaclient.BaseApi* | [**apiBaseByTypeGet**](docs/BaseApi.md#apiBaseByTypeGet) | **GET** /_api/base/{type} | Gets containers by a type.
*Synactaclient.BaseApi* | [**apiBaseRootGet**](docs/BaseApi.md#apiBaseRootGet) | **GET** /_api/base/Root | Gets the root.
*Synactaclient.BaseApi* | [**apiBaseTypesGet**](docs/BaseApi.md#apiBaseTypesGet) | **GET** /_api/base/Types | Gets the container types.
*Synactaclient.LoggingApi* | [**apiLogAddGet**](docs/LoggingApi.md#apiLogAddGet) | **GET** /_api/log/Add | Gets the log container.
*Synactaclient.LoggingApi* | [**apiLogAddPut**](docs/LoggingApi.md#apiLogAddPut) | **PUT** /_api/log/Add | Adds the log.
*Synactaclient.LoggingApi* | [**apiLogGet**](docs/LoggingApi.md#apiLogGet) | **GET** /_api/log | Gets all logs.
*Synactaclient.OrganisationApi* | [**apiOrgByIdAddGet**](docs/OrganisationApi.md#apiOrgByIdAddGet) | **GET** /_api/org/{id}/Add | Gets the new organisation.
*Synactaclient.OrganisationApi* | [**apiOrgByIdAddPut**](docs/OrganisationApi.md#apiOrgByIdAddPut) | **PUT** /_api/org/{id}/Add | Saves the new organisation.
*Synactaclient.OrganisationApi* | [**apiOrgByIdByTypeGet**](docs/OrganisationApi.md#apiOrgByIdByTypeGet) | **GET** /_api/org/{id}/{type} | Gets all containers.
*Synactaclient.OrganisationApi* | [**apiOrgByIdChildrenGet**](docs/OrganisationApi.md#apiOrgByIdChildrenGet) | **GET** /_api/org/{id}/Children | Gets the child organisations.
*Synactaclient.OrganisationApi* | [**apiOrgByIdDelete**](docs/OrganisationApi.md#apiOrgByIdDelete) | **DELETE** /_api/org/{id} | Deletes the organisation.
*Synactaclient.OrganisationApi* | [**apiOrgByIdGet**](docs/OrganisationApi.md#apiOrgByIdGet) | **GET** /_api/org/{id} | Gets the organisation.
*Synactaclient.OrganisationApi* | [**apiOrgByIdMovePost**](docs/OrganisationApi.md#apiOrgByIdMovePost) | **POST** /_api/org/{id}/Move | Moves the organisation.
*Synactaclient.OrganisationApi* | [**apiOrgByIdPost**](docs/OrganisationApi.md#apiOrgByIdPost) | **POST** /_api/org/{id} | Updates the organisation.
*Synactaclient.OrganisationApi* | [**apiOrgByIdRecycleBinByRecycleBinIdGet**](docs/OrganisationApi.md#apiOrgByIdRecycleBinByRecycleBinIdGet) | **GET** /_api/org/{id}/RecycleBin/{recycleBinId} | Gets the recycle bin entry.
*Synactaclient.OrganisationApi* | [**apiOrgByIdRecycleBinByRecycleBinIdRestorePost**](docs/OrganisationApi.md#apiOrgByIdRecycleBinByRecycleBinIdRestorePost) | **POST** /_api/org/{id}/RecycleBin/{recycleBinId}/Restore | Restores the recycle bin entry.
*Synactaclient.OrganisationApi* | [**apiOrgByIdRecycleBinGet**](docs/OrganisationApi.md#apiOrgByIdRecycleBinGet) | **GET** /_api/org/{id}/RecycleBin | Gets the recycle bin.
*Synactaclient.OrganisationApi* | [**apiOrgGet**](docs/OrganisationApi.md#apiOrgGet) | **GET** /_api/org | Gets all organisations.
*Synactaclient.OrganisationApi* | [**apiOrgOrgTreeGet**](docs/OrganisationApi.md#apiOrgOrgTreeGet) | **GET** /_api/org/OrgTree | Gets all organisations with childs.
*Synactaclient.SearchApi* | [**apiSearchGet**](docs/SearchApi.md#apiSearchGet) | **GET** /_api/search | Executes the search.


## Documentation for Models

 - [Synactaclient.Container](docs/Container.md)
 - [Synactaclient.DocumentVersion](docs/DocumentVersion.md)
 - [Synactaclient.KeyValuePairStringString](docs/KeyValuePairStringString.md)
 - [Synactaclient.Log](docs/Log.md)
 - [Synactaclient.Organisation](docs/Organisation.md)
 - [Synactaclient.PrincipalSearchResult](docs/PrincipalSearchResult.md)
 - [Synactaclient.RecycleBinEntry](docs/RecycleBinEntry.md)
 - [Synactaclient.Right](docs/Right.md)
 - [Synactaclient.Role](docs/Role.md)


## Documentation for Authorization

 All endpoints do not require authorization.

---
_Source: https://npm.io/package/synactaclient · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._