# PaperdbClient.OrganizationsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addOrgMember**](OrganizationsApi.md#addOrgMember) | **POST** /org/{uuid}/members | 
[**createOrg**](OrganizationsApi.md#createOrg) | **POST** /orgs | 
[**deleteOrg**](OrganizationsApi.md#deleteOrg) | **DELETE** /orgs/{uuid} | 
[**fetchOrg**](OrganizationsApi.md#fetchOrg) | **GET** /orgs/{uuid} | 
[**getOrgMembers**](OrganizationsApi.md#getOrgMembers) | **GET** /org/{uuid}/members | 
[**listOrgs**](OrganizationsApi.md#listOrgs) | **GET** /orgs | 
[**removeOrgMember**](OrganizationsApi.md#removeOrgMember) | **DELETE** /org/{uuid}/members | 
[**replaceOrg**](OrganizationsApi.md#replaceOrg) | **PATCH** /orgs/{uuid} | 
[**updateOrg**](OrganizationsApi.md#updateOrg) | **PUT** /orgs/{uuid} | 


<a name="addOrgMember"></a>
# **addOrgMember**
> addOrgMember(uuid)



Add a member to the organization

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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

apiInstance.addOrgMember(uuid).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createOrg"></a>
# **createOrg**
> OrgDetails createOrg(org)



Create a new organization

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

var apiInstance = new PaperdbClient.OrganizationsApi();

var org = new PaperdbClient.OrgCreationDetails(); // OrgCreationDetails | 

apiInstance.createOrg(org).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **org** | [**OrgCreationDetails**](OrgCreationDetails.md)|  | 

### Return type

[**OrgDetails**](OrgDetails.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="deleteOrg"></a>
# **deleteOrg**
> deleteOrg(uuid)



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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

apiInstance.deleteOrg(uuid).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="fetchOrg"></a>
# **fetchOrg**
> OrgDetails fetchOrg(uuid)



Get details of a specific organization

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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

apiInstance.fetchOrg(uuid).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 

### Return type

[**OrgDetails**](OrgDetails.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="getOrgMembers"></a>
# **getOrgMembers**
> [&#39;String&#39;] getOrgMembers(uuid)



List members of organization

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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

apiInstance.getOrgMembers(uuid).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 

### Return type

**[&#39;String&#39;]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="listOrgs"></a>
# **listOrgs**
> [OrgDetails] listOrgs()



List all organisations registered in this repository

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

var apiInstance = new PaperdbClient.OrganizationsApi();
apiInstance.listOrgs().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[OrgDetails]**](OrgDetails.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="removeOrgMember"></a>
# **removeOrgMember**
> removeOrgMember(uuid, members)



Remove one or more members from the organization

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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

var members = [new PaperdbClient.[String]()]; // [String] | 

apiInstance.removeOrgMember(uuid, members).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 
 **members** | **[String]**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="replaceOrg"></a>
# **replaceOrg**
> replaceOrg(uuid)



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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

apiInstance.replaceOrg(uuid).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="updateOrg"></a>
# **updateOrg**
> updateOrg(uuid, org)



Replace an organization with another one

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

var apiInstance = new PaperdbClient.OrganizationsApi();

var uuid = "uuid_example"; // String | 

var org = new PaperdbClient.OrgDetailsDelta(); // OrgDetailsDelta | 

apiInstance.updateOrg(uuid, org).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 
 **org** | [**OrgDetailsDelta**](OrgDetailsDelta.md)|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

