# paperdb-client

> A client for communicating with a PaperDB service

Latest version **0.1.0** (published 2017-02-26) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install paperdb-client
pnpm add paperdb-client
yarn add paperdb-client
bun add paperdb-client
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2017-02-26 |
| First published | 2017-02-26 |
| 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 | samvv |

## Links

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

## Dependencies (1)

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

## Recent versions

- 0.1.0 (latest) — 2017-02-26

## README

# paperdb-client

PaperdbClient - JavaScript client for paperdb-client
PaperDB is a web service and application for storing your digital literature. This page contains the RESTfull API specification that any service implementing the PaperDB protocol should follow. Developers can also use this specification to connect their own app to PaperDB services. 
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.1.0
- Package version: 0.1.0
- Build date: 2017-02-26T14:30:53.913+01:00
- Build package: class io.swagger.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 paperdb-client --save
```

#### 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.

## Getting Started

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

```javascript
var PaperdbClient = require('paperdb-client');

var api = new PaperdbClient.FilesApi()

var uuid = "uuid_example"; // {String} 

var hash = "hash_example"; // {String} 

api.deleteFile(uuid, hash).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8880/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PaperdbClient.FilesApi* | [**deleteFile**](docs/FilesApi.md#deleteFile) | **DELETE** /person/{uuid}/file/{hash} | 
*PaperdbClient.FilesApi* | [**getFileContent**](docs/FilesApi.md#getFileContent) | **GET** /file/{hash}/content | 
*PaperdbClient.FilesApi* | [**getFileMetadata**](docs/FilesApi.md#getFileMetadata) | **GET** /person/{uuid}/file/{hash} | 
*PaperdbClient.FilesApi* | [**listPersonFiles**](docs/FilesApi.md#listPersonFiles) | **POST** /person/{uuid}/files | 
*PaperdbClient.FilesApi* | [**replaceFileMetadata**](docs/FilesApi.md#replaceFileMetadata) | **PUT** /person/{uuid}/file/{hash} | 
*PaperdbClient.FilesApi* | [**updateFileMetadata**](docs/FilesApi.md#updateFileMetadata) | **PATCH** /person/{uuid}/file/{hash} | 
*PaperdbClient.OrganizationsApi* | [**addOrgMember**](docs/OrganizationsApi.md#addOrgMember) | **POST** /org/{uuid}/members | 
*PaperdbClient.OrganizationsApi* | [**createOrg**](docs/OrganizationsApi.md#createOrg) | **POST** /orgs | 
*PaperdbClient.OrganizationsApi* | [**deleteOrg**](docs/OrganizationsApi.md#deleteOrg) | **DELETE** /orgs/{uuid} | 
*PaperdbClient.OrganizationsApi* | [**fetchOrg**](docs/OrganizationsApi.md#fetchOrg) | **GET** /orgs/{uuid} | 
*PaperdbClient.OrganizationsApi* | [**getOrgMembers**](docs/OrganizationsApi.md#getOrgMembers) | **GET** /org/{uuid}/members | 
*PaperdbClient.OrganizationsApi* | [**listOrgs**](docs/OrganizationsApi.md#listOrgs) | **GET** /orgs | 
*PaperdbClient.OrganizationsApi* | [**removeOrgMember**](docs/OrganizationsApi.md#removeOrgMember) | **DELETE** /org/{uuid}/members | 
*PaperdbClient.OrganizationsApi* | [**replaceOrg**](docs/OrganizationsApi.md#replaceOrg) | **PATCH** /orgs/{uuid} | 
*PaperdbClient.OrganizationsApi* | [**updateOrg**](docs/OrganizationsApi.md#updateOrg) | **PUT** /orgs/{uuid} | 
*PaperdbClient.PeopleApi* | [**createPerson**](docs/PeopleApi.md#createPerson) | **POST** /persons | 
*PaperdbClient.PeopleApi* | [**deletePerson**](docs/PeopleApi.md#deletePerson) | **DELETE** /person/{uuid} | 
*PaperdbClient.PeopleApi* | [**fetchPerson**](docs/PeopleApi.md#fetchPerson) | **GET** /person/{uuid} | 
*PaperdbClient.PeopleApi* | [**getResourceDetails**](docs/PeopleApi.md#getResourceDetails) | **GET** /person/{uuid}/resources | 
*PaperdbClient.PeopleApi* | [**listPersons**](docs/PeopleApi.md#listPersons) | **GET** /persons | 
*PaperdbClient.PeopleApi* | [**personUuidPermissionsGet**](docs/PeopleApi.md#personUuidPermissionsGet) | **GET** /person/{uuid}/permissions | Get all of the person&#39;s permissions
*PaperdbClient.PeopleApi* | [**personUuidPermissionsPost**](docs/PeopleApi.md#personUuidPermissionsPost) | **POST** /person/{uuid}/permissions | Grant a permission to the given person
*PaperdbClient.PeopleApi* | [**replacePerson**](docs/PeopleApi.md#replacePerson) | **PUT** /person/{uuid} | 
*PaperdbClient.PeopleApi* | [**updatePerson**](docs/PeopleApi.md#updatePerson) | **PATCH** /person/{uuid} | 
*PaperdbClient.PermissionsApi* | [**personUuidPermissionsGet**](docs/PermissionsApi.md#personUuidPermissionsGet) | **GET** /person/{uuid}/permissions | Get all of the person&#39;s permissions
*PaperdbClient.PermissionsApi* | [**personUuidPermissionsPost**](docs/PermissionsApi.md#personUuidPermissionsPost) | **POST** /person/{uuid}/permissions | Grant a permission to the given person
*PaperdbClient.ResourcesApi* | [**addResource**](docs/ResourcesApi.md#addResource) | **POST** /resources | 
*PaperdbClient.ResourcesApi* | [**fetchResource**](docs/ResourcesApi.md#fetchResource) | **GET** /resource/{uuid} | 
*PaperdbClient.ResourcesApi* | [**getResourceDetails**](docs/ResourcesApi.md#getResourceDetails) | **GET** /person/{uuid}/resources | 
*PaperdbClient.ResourcesApi* | [**listAllResources**](docs/ResourcesApi.md#listAllResources) | **GET** /resources | 
*PaperdbClient.ResourcesApi* | [**resourceUuidDelete**](docs/ResourcesApi.md#resourceUuidDelete) | **DELETE** /resource/{uuid} | 
*PaperdbClient.ResourcesApi* | [**resourceUuidPatch**](docs/ResourcesApi.md#resourceUuidPatch) | **PATCH** /resource/{uuid} | 
*PaperdbClient.ResourcesApi* | [**resourceUuidPost**](docs/ResourcesApi.md#resourceUuidPost) | **POST** /resource/{uuid} | 
*PaperdbClient.ResourcesApi* | [**resourceUuidPut**](docs/ResourcesApi.md#resourceUuidPut) | **PUT** /resource/{uuid} | 


## Documentation for Models

 - [PaperdbClient.FileCreationDetails](docs/FileCreationDetails.md)
 - [PaperdbClient.FileDetails](docs/FileDetails.md)
 - [PaperdbClient.FileDetailsDelta](docs/FileDetailsDelta.md)
 - [PaperdbClient.FileDetailsUploaders](docs/FileDetailsUploaders.md)
 - [PaperdbClient.OrgCreationDetails](docs/OrgCreationDetails.md)
 - [PaperdbClient.OrgDetails](docs/OrgDetails.md)
 - [PaperdbClient.OrgDetailsDelta](docs/OrgDetailsDelta.md)
 - [PaperdbClient.ParamsError](docs/ParamsError.md)
 - [PaperdbClient.ParamsErrorError](docs/ParamsErrorError.md)
 - [PaperdbClient.ParamsErrorErrors](docs/ParamsErrorErrors.md)
 - [PaperdbClient.PersonCreationDetails](docs/PersonCreationDetails.md)
 - [PaperdbClient.PersonDetails](docs/PersonDetails.md)
 - [PaperdbClient.PersonDetailsDelta](docs/PersonDetailsDelta.md)
 - [PaperdbClient.ResourceCreationDetails](docs/ResourceCreationDetails.md)
 - [PaperdbClient.ResourceDetails](docs/ResourceDetails.md)
 - [PaperdbClient.ResourceDetailsDelta](docs/ResourceDetailsDelta.md)


## Documentation for Authorization

 All endpoints do not require authorization.

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