# BorderguruApi.CompaniesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**createCompany**](CompaniesApi.md#createCompany) | **POST** /companies | Creates a new company in the database
[**deleteCompanyById**](CompaniesApi.md#deleteCompanyById) | **DELETE** /companies/{companyId} | Deletes a company by id
[**getCompanyById**](CompaniesApi.md#getCompanyById) | **GET** /companies/{companyId} | Returns a company by id
[**getCompanySummaryById**](CompaniesApi.md#getCompanySummaryById) | **GET** /companies/{companyId}/summary | Returns an aggregated summary of all orders from a company
[**listCompanies**](CompaniesApi.md#listCompanies) | **GET** /companies | Returns a list of all companies
[**listCompanyOrders**](CompaniesApi.md#listCompanyOrders) | **GET** /companies/{companyId}/orders | Returns all orders for a company
[**updateCompany**](CompaniesApi.md#updateCompany) | **PUT** /companies/{companyId} | Updates an existing company data


<a name="createCompany"></a>
# **createCompany**
> Company createCompany(company)

Creates a new company in the database

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var company = new BorderguruApi.CreateCompanyBody(); // CreateCompanyBody | Company data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createCompany(company, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **company** | [**CreateCompanyBody**](CreateCompanyBody.md)| Company data | 

### Return type

[**Company**](Company.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deleteCompanyById"></a>
# **deleteCompanyById**
> deleteCompanyById(companyId)

Deletes a company by id

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var companyId = "companyId_example"; // String | Unique id for a company


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteCompanyById(companyId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Unique id for a company | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getCompanyById"></a>
# **getCompanyById**
> Company getCompanyById(companyId)

Returns a company by id

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var companyId = "companyId_example"; // String | Unique id for a company


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCompanyById(companyId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Unique id for a company | 

### Return type

[**Company**](Company.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getCompanySummaryById"></a>
# **getCompanySummaryById**
> CompanySummary getCompanySummaryById(companyId)

Returns an aggregated summary of all orders from a company

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var companyId = "companyId_example"; // String | Unique id for a company


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCompanySummaryById(companyId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Unique id for a company | 

### Return type

[**CompanySummary**](CompanySummary.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="listCompanies"></a>
# **listCompanies**
> [Company] listCompanies()

Returns a list of all companies

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listCompanies(callback);
```

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

### Return type

[**[Company]**](Company.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="listCompanyOrders"></a>
# **listCompanyOrders**
> [Order] listCompanyOrders(companyId)

Returns all orders for a company

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var companyId = "companyId_example"; // String | Unique id for a company


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listCompanyOrders(companyId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Unique id for a company | 

### Return type

[**[Order]**](Order.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="updateCompany"></a>
# **updateCompany**
> Company updateCompany(companyId, company)

Updates an existing company data

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.CompaniesApi();

var companyId = "companyId_example"; // String | Unique id for a company

var company = new BorderguruApi.UpdateCompanyBody(); // UpdateCompanyBody | Company data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateCompany(companyId, company, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Unique id for a company | 
 **company** | [**UpdateCompanyBody**](UpdateCompanyBody.md)| Company data | 

### Return type

[**Company**](Company.md)

### Authorization

No authorization required

### HTTP request headers

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