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

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

    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.

Getting Started

Please follow the installation instruction and execute the following JS code:

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 | DELETE /person/{uuid}/file/{hash} | PaperdbClient.FilesApi | getFileContent | GET /file/{hash}/content | PaperdbClient.FilesApi | getFileMetadata | GET /person/{uuid}/file/{hash} | PaperdbClient.FilesApi | listPersonFiles | POST /person/{uuid}/files | PaperdbClient.FilesApi | replaceFileMetadata | PUT /person/{uuid}/file/{hash} | PaperdbClient.FilesApi | updateFileMetadata | PATCH /person/{uuid}/file/{hash} | PaperdbClient.OrganizationsApi | addOrgMember | POST /org/{uuid}/members | PaperdbClient.OrganizationsApi | createOrg | POST /orgs | PaperdbClient.OrganizationsApi | deleteOrg | DELETE /orgs/{uuid} | PaperdbClient.OrganizationsApi | fetchOrg | GET /orgs/{uuid} | PaperdbClient.OrganizationsApi | getOrgMembers | GET /org/{uuid}/members | PaperdbClient.OrganizationsApi | listOrgs | GET /orgs | PaperdbClient.OrganizationsApi | removeOrgMember | DELETE /org/{uuid}/members | PaperdbClient.OrganizationsApi | replaceOrg | PATCH /orgs/{uuid} | PaperdbClient.OrganizationsApi | updateOrg | PUT /orgs/{uuid} | PaperdbClient.PeopleApi | createPerson | POST /persons | PaperdbClient.PeopleApi | deletePerson | DELETE /person/{uuid} | PaperdbClient.PeopleApi | fetchPerson | GET /person/{uuid} | PaperdbClient.PeopleApi | getResourceDetails | GET /person/{uuid}/resources | PaperdbClient.PeopleApi | listPersons | GET /persons | PaperdbClient.PeopleApi | personUuidPermissionsGet | GET /person/{uuid}/permissions | Get all of the person's permissions PaperdbClient.PeopleApi | personUuidPermissionsPost | POST /person/{uuid}/permissions | Grant a permission to the given person PaperdbClient.PeopleApi | replacePerson | PUT /person/{uuid} | PaperdbClient.PeopleApi | updatePerson | PATCH /person/{uuid} | PaperdbClient.PermissionsApi | personUuidPermissionsGet | GET /person/{uuid}/permissions | Get all of the person's permissions PaperdbClient.PermissionsApi | personUuidPermissionsPost | POST /person/{uuid}/permissions | Grant a permission to the given person PaperdbClient.ResourcesApi | addResource | POST /resources | PaperdbClient.ResourcesApi | fetchResource | GET /resource/{uuid} | PaperdbClient.ResourcesApi | getResourceDetails | GET /person/{uuid}/resources | PaperdbClient.ResourcesApi | listAllResources | GET /resources | PaperdbClient.ResourcesApi | resourceUuidDelete | DELETE /resource/{uuid} | PaperdbClient.ResourcesApi | resourceUuidPatch | PATCH /resource/{uuid} | PaperdbClient.ResourcesApi | resourceUuidPost | POST /resource/{uuid} | PaperdbClient.ResourcesApi | resourceUuidPut | PUT /resource/{uuid} |

Documentation for Models

• PaperdbClient.FileCreationDetails
• PaperdbClient.FileDetails
• PaperdbClient.FileDetailsDelta
• PaperdbClient.FileDetailsUploaders
• PaperdbClient.OrgCreationDetails
• PaperdbClient.OrgDetails
• PaperdbClient.OrgDetailsDelta
• PaperdbClient.ParamsError
• PaperdbClient.ParamsErrorError
• PaperdbClient.ParamsErrorErrors
• PaperdbClient.PersonCreationDetails
• PaperdbClient.PersonDetails
• PaperdbClient.PersonDetailsDelta
• PaperdbClient.ResourceCreationDetails
• PaperdbClient.ResourceDetails
• PaperdbClient.ResourceDetailsDelta

Documentation for Authorization

All endpoints do not require authorization.