# RainbowEnduserPortal.CompaniesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**createCompany**](CompaniesApi.md#createCompany) | **POST** /api/rainbow/enduser/v1.0/companies | Create a company
[**getCompanies**](CompaniesApi.md#getCompanies) | **GET** /api/rainbow/enduser/v1.0/companies | Get all companies
[**getCompanyAdministrators**](CompaniesApi.md#getCompanyAdministrators) | **GET** /api/rainbow/enduser/v1.0/companies/{companyId}/administrators | Get company administrators
[**getCompanyById**](CompaniesApi.md#getCompanyById) | **GET** /api/rainbow/enduser/v1.0/companies/{companyId} | Get a company data



## createCompany

> CreateCompanySuccess createCompany(body)

Create a company

A user belonging to the 'Default' company is able to create his own company.    Then he is automatically moved to it and becomes the 'company_admin' of it.       **The company's name is checked and must be unique.    The logged in user musn't have already an admin or superadmin role**      The company is created with visibility='public' and userSelfRegisterEnabled=false. The user, promoted to 'company_admin', can then update these values if we want using API [PUT /api/rainbow/admin/v1.0/companies/:companyId][0].       User's XMPP vCard is also updated.    Like after a user profile update, a presence stanza is sent to user's resources and users being in user's roster. This allows clients to be notified that company of this user has been updated:        ```html <presence from='3ae059e2a91c40d9bdd7df0eedc911ca@openrainbow.com'>        <x xmlns='vcard-temp:x:update'>            <data/>        </x>        <actor xmlns='jabber:iq:configuration'/x>    </presence> ```  [0]: /admin/#api-companies-PutCompanies

### Example

```javascript
var RainbowEnduserPortal = require('rainbow_enduser_portal');
var defaultClient = RainbowEnduserPortal.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new RainbowEnduserPortal.CompaniesApi();
var body = new RainbowEnduserPortal.CreateCompany(); // CreateCompany | 
apiInstance.createCompany(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateCompany**](CreateCompany.md)|  | 

### Return type

[**CreateCompanySuccess**](CreateCompanySuccess.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

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


## getCompanies

> GetCompaniesSuccess getCompanies(accept, opts)

Get all companies

This API allows users to get all companies.       Users with `user` role can only retrieve their own company and companies they can see (companies with `visibility`=`public`, companies having user's companyId in `visibleBy` field, companies being in user's company organization and having `visibility`=`organization`, BP company of user's company).       Users with `analytics` can retrieve all companies, but only the following fields are returned: `id`, `creationDate`, `status`, `statusUpdatedDate`, `visibility`, `visibleBy`, `organisationId`   Example: GET https://openrainbow.com/api/rainbow/enduser/v1.0/companies?name=My com&format=medium&limit=100&offset=0&sortField=name&sortOrder=-1

### Example

```javascript
var RainbowEnduserPortal = require('rainbow_enduser_portal');
var defaultClient = RainbowEnduserPortal.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new RainbowEnduserPortal.CompaniesApi();
var accept = "accept_example"; // String | application/json
var opts = {
  'format': "format_example", // String | Allows to retrieve more or less company details in response. > - `small`: id, name > - `medium`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape > - `full`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape
  'sortField': "sortField_example", // String | Sort items list based on the given field
  'limit': 3.4, // Number | Allow to specify the number of items to retrieve.
  'offset': 3.4, // Number | Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned.
  'sortOrder': 3.4, // Number | Specify order when sorting items list.
  'name': "name_example", // String | Allows to filter companies list on the given keyword(s) on field name.       The filtering is case insensitive and on partial name match: all companies **containing** the provided name value will be returned (whatever the position of the match).    Ex: if filtering is done on _comp_, companies with the following names are match the filter 'My company', 'Company', 'A comp 1', 'Comp of comps', ...
  'status': "status_example", // String | Allows to filter companies list on the provided status(es)
  'visibility': "visibility_example", // String | Allows to filter companies list on the provided visibility(ies)
  'organisationId': "organisationId_example", // String | Allows to filter companies list on the organisationIds provided in this option.       This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin`
  'isBP': true, // Boolean | Allows to filter companies list on isBP field:   * true returns only Business Partner companies, * false return only companies which are not Business Partner.     This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin`.
  'hasBP': true, // Boolean | Allows to filter companies list on companies being linked or not to a BP:   * true returns only companies linked to a BP (BP IR companies are also returned), * false return only companies which are not linked to a BP.     This filter can only be used if user has role(s) `superadmin`, `support` or `bp_admin`.    Users with role `bp_admin` can only use this filter with value `false`.
  'bpType': "bpType_example" // String | Allows to filter companies list on bpType field.    This filter allow to get all the Business Partner companies from a given bpType.       Only users with role `superadmin`, `support` or `bp_admin` can use this filter.
};
apiInstance.getCompanies(accept, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **accept** | **String**| application/json | 
 **format** | **String**| Allows to retrieve more or less company details in response. > - `small`: id, name > - `medium`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape > - `full`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape | [optional] 
 **sortField** | **String**| Sort items list based on the given field | [optional] 
 **limit** | **Number**| Allow to specify the number of items to retrieve. | [optional] 
 **offset** | **Number**| Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned. | [optional] 
 **sortOrder** | **Number**| Specify order when sorting items list. | [optional] 
 **name** | **String**| Allows to filter companies list on the given keyword(s) on field name.       The filtering is case insensitive and on partial name match: all companies **containing** the provided name value will be returned (whatever the position of the match).    Ex: if filtering is done on _comp_, companies with the following names are match the filter 'My company', 'Company', 'A comp 1', 'Comp of comps', ... | [optional] 
 **status** | **String**| Allows to filter companies list on the provided status(es) | [optional] 
 **visibility** | **String**| Allows to filter companies list on the provided visibility(ies) | [optional] 
 **organisationId** | **String**| Allows to filter companies list on the organisationIds provided in this option.       This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin` | [optional] 
 **isBP** | **Boolean**| Allows to filter companies list on isBP field:   * true returns only Business Partner companies, * false return only companies which are not Business Partner.     This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin`. | [optional] 
 **hasBP** | **Boolean**| Allows to filter companies list on companies being linked or not to a BP:   * true returns only companies linked to a BP (BP IR companies are also returned), * false return only companies which are not linked to a BP.     This filter can only be used if user has role(s) `superadmin`, `support` or `bp_admin`.    Users with role `bp_admin` can only use this filter with value `false`. | [optional] 
 **bpType** | **String**| Allows to filter companies list on bpType field.    This filter allow to get all the Business Partner companies from a given bpType.       Only users with role `superadmin`, `support` or `bp_admin` can use this filter. | [optional] 

### Return type

[**GetCompaniesSuccess**](GetCompaniesSuccess.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

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


## getCompanyAdministrators

> GetCompanyAdministratorsSuccess getCompanyAdministrators(companyId, accept, opts)

Get company administrators

This API allows users to list users being administrator of a company.       **Users can only retrieve administrators of their own company and administrators of companies visible by their own company** (companies being in user's company organisation and having `visibility`=`organization`, and companies having user's companyId in `visibleBy`).       This API implement pagination, using limit and offset options in query string arguments (default is limit on 100 users). Result sorting can also be done using sort and order options (default is sort on displayName on ascending order).       Examples:   * basic: GET https://openrainbow.com/api/rainbow/admin/v1.0/companies/5749aa51245015fe0d36e968/administrators * with pagination options: GET https://openrainbow.com/api/rainbow/admin/v1.0/companies/5749aa51245015fe0d36e968/administrators?limit=10&offset=20&sortField=firstName&sortOrder=-1  

### Example

```javascript
var RainbowEnduserPortal = require('rainbow_enduser_portal');
var defaultClient = RainbowEnduserPortal.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new RainbowEnduserPortal.CompaniesApi();
var companyId = "companyId_example"; // String | Company for which list of administrators is requested
var accept = "accept_example"; // String | application/json
var opts = {
  'format': "format_example" // String | Allows to retrieve more or less user details in response.    - `small`: id, firstName, lastName, displayName, companyId, companyName, isTerminated    - `medium`: id, firstName, lastName, displayName, jid_im, jid_tel, companyId, companyName, lastUpdateDate, lastAvatarUpdateDate, isTerminated, guestMode    - `full`: id, firstName, lastName, displayName, nickName, title, jobTitle, emails, phoneNumbers, country, state, language, timezone, jid_im, jid_tel, companyId, companyName, lastUpdateDate, lastAvatarUpdateDate, isTerminated, guestMode, lastOfflineMailReceivedDate
};
apiInstance.getCompanyAdministrators(companyId, accept, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company for which list of administrators is requested | 
 **accept** | **String**| application/json | 
 **format** | **String**| Allows to retrieve more or less user details in response.    - `small`: id, firstName, lastName, displayName, companyId, companyName, isTerminated    - `medium`: id, firstName, lastName, displayName, jid_im, jid_tel, companyId, companyName, lastUpdateDate, lastAvatarUpdateDate, isTerminated, guestMode    - `full`: id, firstName, lastName, displayName, nickName, title, jobTitle, emails, phoneNumbers, country, state, language, timezone, jid_im, jid_tel, companyId, companyName, lastUpdateDate, lastAvatarUpdateDate, isTerminated, guestMode, lastOfflineMailReceivedDate | [optional] 

### Return type

[**GetCompanyAdministratorsSuccess**](GetCompanyAdministratorsSuccess.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

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


## getCompanyById

> GetCompanyByIdSuccess getCompanyById(companyId, accept, opts)

Get a company data

This API allows user to get a company data.       **Users can only retrieve their own company and companies they can see** (companies with `visibility`=`public`, companies having user's companyId in `visibleBy` field, companies being in user's company organization and having `visibility`=`organization`, BP company of user's company).       If user request his own company, `numberUsers` field is returned with the number of Rainbow users being in this company.       Example: GET https://openrainbow.com/api/rainbow/enduser/v1.0/companies/569d0ef3ef7816921f7e94fa

### Example

```javascript
var RainbowEnduserPortal = require('rainbow_enduser_portal');
var defaultClient = RainbowEnduserPortal.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new RainbowEnduserPortal.CompaniesApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var accept = "accept_example"; // String | application/json
var opts = {
  'format': "format_example", // String | Allows to retrieve more or less company details in response. > - `small`: id, name > - `medium`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape > - `full`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape    **When a user wants data of his own company in 'full' mode, he gets all fields except subscriptions and fields related to a business partner managing this company.**
  'name': "name_example", // String | Allows to filter companies list on the given keyword(s) on field name.       The filtering is case insensitive and on partial name match: all companies **containing** the provided name value will be returned (whatever the position of the match).    Ex: if filtering is done on _comp_, companies with the following names are match the filter 'My company', 'Company', 'A comp 1', 'Comp of comps', ...
  'status': "status_example", // String | Allows to filter companies list on the provided status(es)
  'visibility': "visibility_example", // String | Allows to filter companies list on the provided visibility(ies)
  'organisationId': "organisationId_example", // String | Allows to filter companies list on the organisationIds provided in this option.       This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin`
  'isBP': true, // Boolean | Allows to filter companies list on isBP field:   * true returns only Business Partner companies, * false return only companies which are not Business Partner.     This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin`.
  'hasBP': true, // Boolean | Allows to filter companies list on companies being linked or not to a BP:   * true returns only companies linked to a BP (BP IR companies are also returned), * false return only companies which are not linked to a BP.     This filter can only be used if user has role(s) `superadmin`, `support` or `bp_admin`.    Users with role `bp_admin` can only use this filter with value `false`.
  'bpType': "bpType_example" // String | Allows to filter companies list on bpType field.    This filter allow to get all the Business Partner companies from a given bpType.       Only users with role `superadmin`, `support` or `bp_admin` can use this filter.
};
apiInstance.getCompanyById(companyId, accept, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **accept** | **String**| application/json | 
 **format** | **String**| Allows to retrieve more or less company details in response. > - `small`: id, name > - `medium`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape > - `full`: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape    **When a user wants data of his own company in 'full' mode, he gets all fields except subscriptions and fields related to a business partner managing this company.** | [optional] 
 **name** | **String**| Allows to filter companies list on the given keyword(s) on field name.       The filtering is case insensitive and on partial name match: all companies **containing** the provided name value will be returned (whatever the position of the match).    Ex: if filtering is done on _comp_, companies with the following names are match the filter 'My company', 'Company', 'A comp 1', 'Comp of comps', ... | [optional] 
 **status** | **String**| Allows to filter companies list on the provided status(es) | [optional] 
 **visibility** | **String**| Allows to filter companies list on the provided visibility(ies) | [optional] 
 **organisationId** | **String**| Allows to filter companies list on the organisationIds provided in this option.       This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin` | [optional] 
 **isBP** | **Boolean**| Allows to filter companies list on isBP field:   * true returns only Business Partner companies, * false return only companies which are not Business Partner.     This filter can only be used if user has role(s) `superadmin`, `support`, `bp_admin` or `admin`. | [optional] 
 **hasBP** | **Boolean**| Allows to filter companies list on companies being linked or not to a BP:   * true returns only companies linked to a BP (BP IR companies are also returned), * false return only companies which are not linked to a BP.     This filter can only be used if user has role(s) `superadmin`, `support` or `bp_admin`.    Users with role `bp_admin` can only use this filter with value `false`. | [optional] 
 **bpType** | **String**| Allows to filter companies list on bpType field.    This filter allow to get all the Business Partner companies from a given bpType.       Only users with role `superadmin`, `support` or `bp_admin` can use this filter. | [optional] 

### Return type

[**GetCompanyByIdSuccess**](GetCompanyByIdSuccess.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

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