# Buildium::AppliancesApi

All URIs are relative to *https://api.buildium.com*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**create_association_appliance**](AppliancesApi.md#create_association_appliance) | **POST** /v1/associations/appliances | Create an appliance |
| [**create_association_appliance_service_history**](AppliancesApi.md#create_association_appliance_service_history) | **POST** /v1/associations/appliances/{applianceId}/servicehistory | Create a service history |
| [**delete_association_appliances**](AppliancesApi.md#delete_association_appliances) | **DELETE** /v1/associations/appliances/{applianceId} | Delete an appliance |
| [**get_all_association_appliance_service_history**](AppliancesApi.md#get_all_association_appliance_service_history) | **GET** /v1/associations/appliances/{applianceId}/servicehistory | Retrieve all service history |
| [**get_association_appliance_by_id**](AppliancesApi.md#get_association_appliance_by_id) | **GET** /v1/associations/appliances/{applianceId} | Retrieve an appliance |
| [**get_association_appliance_service_history_by_id**](AppliancesApi.md#get_association_appliance_service_history_by_id) | **GET** /v1/associations/appliances/{applianceId}/servicehistory/{serviceHistoryId} | Retrieve a service history |
| [**get_association_appliances**](AppliancesApi.md#get_association_appliances) | **GET** /v1/associations/appliances | Retrieve all appliances |
| [**update_association_appliance**](AppliancesApi.md#update_association_appliance) | **PUT** /v1/associations/appliances/{applianceId} | Update an appliance |


## create_association_appliance

> <AssociationApplianceMessage> create_association_appliance(create_association_appliance_request)

Create an appliance

Creates an association appliance.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
create_association_appliance_request = Buildium::CreateAssociationApplianceRequest.new({association_id: 37, name: 'name_example'}) # CreateAssociationApplianceRequest | 

begin
  # Create an appliance
  result = api_instance.create_association_appliance(create_association_appliance_request)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->create_association_appliance: #{e}"
end
```

#### Using the create_association_appliance_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<AssociationApplianceMessage>, Integer, Hash)> create_association_appliance_with_http_info(create_association_appliance_request)

```ruby
begin
  # Create an appliance
  data, status_code, headers = api_instance.create_association_appliance_with_http_info(create_association_appliance_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AssociationApplianceMessage>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->create_association_appliance_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **create_association_appliance_request** | [**CreateAssociationApplianceRequest**](CreateAssociationApplianceRequest.md) |  |  |

### Return type

[**AssociationApplianceMessage**](AssociationApplianceMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## create_association_appliance_service_history

> <AssociationApplianceServiceHistoryMessage> create_association_appliance_service_history(appliance_id, create_association_appliance_service_history_request)

Create a service history

Creates a service history for an appliance.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
appliance_id = 56 # Integer | 
create_association_appliance_service_history_request = Buildium::CreateAssociationApplianceServiceHistoryRequest.new({service_type: 'Installed', date: Date.today}) # CreateAssociationApplianceServiceHistoryRequest | 

begin
  # Create a service history
  result = api_instance.create_association_appliance_service_history(appliance_id, create_association_appliance_service_history_request)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->create_association_appliance_service_history: #{e}"
end
```

#### Using the create_association_appliance_service_history_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<AssociationApplianceServiceHistoryMessage>, Integer, Hash)> create_association_appliance_service_history_with_http_info(appliance_id, create_association_appliance_service_history_request)

```ruby
begin
  # Create a service history
  data, status_code, headers = api_instance.create_association_appliance_service_history_with_http_info(appliance_id, create_association_appliance_service_history_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AssociationApplianceServiceHistoryMessage>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->create_association_appliance_service_history_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **appliance_id** | **Integer** |  |  |
| **create_association_appliance_service_history_request** | [**CreateAssociationApplianceServiceHistoryRequest**](CreateAssociationApplianceServiceHistoryRequest.md) |  |  |

### Return type

[**AssociationApplianceServiceHistoryMessage**](AssociationApplianceServiceHistoryMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## delete_association_appliances

> delete_association_appliances(appliance_id)

Delete an appliance

Deletes an associations appliance.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
appliance_id = 56 # Integer | 

begin
  # Delete an appliance
  api_instance.delete_association_appliances(appliance_id)
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->delete_association_appliances: #{e}"
end
```

#### Using the delete_association_appliances_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_association_appliances_with_http_info(appliance_id)

```ruby
begin
  # Delete an appliance
  data, status_code, headers = api_instance.delete_association_appliances_with_http_info(appliance_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->delete_association_appliances_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **appliance_id** | **Integer** |  |  |

### Return type

nil (empty response body)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## get_all_association_appliance_service_history

> <Array<AssociationApplianceServiceHistoryMessage>> get_all_association_appliance_service_history(appliance_id, opts)

Retrieve all service history

Retrieves all of the service history records for an appliance.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
appliance_id = 56 # Integer | 
opts = {
  orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
  offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
  limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
}

begin
  # Retrieve all service history
  result = api_instance.get_all_association_appliance_service_history(appliance_id, opts)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_all_association_appliance_service_history: #{e}"
end
```

#### Using the get_all_association_appliance_service_history_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<AssociationApplianceServiceHistoryMessage>>, Integer, Hash)> get_all_association_appliance_service_history_with_http_info(appliance_id, opts)

```ruby
begin
  # Retrieve all service history
  data, status_code, headers = api_instance.get_all_association_appliance_service_history_with_http_info(appliance_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<AssociationApplianceServiceHistoryMessage>>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_all_association_appliance_service_history_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **appliance_id** | **Integer** |  |  |
| **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
| **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
| **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |

### Return type

[**Array&lt;AssociationApplianceServiceHistoryMessage&gt;**](AssociationApplianceServiceHistoryMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## get_association_appliance_by_id

> <AssociationApplianceMessage> get_association_appliance_by_id(appliance_id)

Retrieve an appliance

Retrieves an association appliance by id.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
appliance_id = 56 # Integer | 

begin
  # Retrieve an appliance
  result = api_instance.get_association_appliance_by_id(appliance_id)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_association_appliance_by_id: #{e}"
end
```

#### Using the get_association_appliance_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<AssociationApplianceMessage>, Integer, Hash)> get_association_appliance_by_id_with_http_info(appliance_id)

```ruby
begin
  # Retrieve an appliance
  data, status_code, headers = api_instance.get_association_appliance_by_id_with_http_info(appliance_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AssociationApplianceMessage>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_association_appliance_by_id_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **appliance_id** | **Integer** |  |  |

### Return type

[**AssociationApplianceMessage**](AssociationApplianceMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## get_association_appliance_service_history_by_id

> <AssociationApplianceServiceHistoryMessage> get_association_appliance_service_history_by_id(appliance_id, service_history_id)

Retrieve a service history

Retrieves a specific service history record for a given appliance.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
appliance_id = 56 # Integer | 
service_history_id = 56 # Integer | 

begin
  # Retrieve a service history
  result = api_instance.get_association_appliance_service_history_by_id(appliance_id, service_history_id)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_association_appliance_service_history_by_id: #{e}"
end
```

#### Using the get_association_appliance_service_history_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<AssociationApplianceServiceHistoryMessage>, Integer, Hash)> get_association_appliance_service_history_by_id_with_http_info(appliance_id, service_history_id)

```ruby
begin
  # Retrieve a service history
  data, status_code, headers = api_instance.get_association_appliance_service_history_by_id_with_http_info(appliance_id, service_history_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AssociationApplianceServiceHistoryMessage>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_association_appliance_service_history_by_id_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **appliance_id** | **Integer** |  |  |
| **service_history_id** | **Integer** |  |  |

### Return type

[**AssociationApplianceServiceHistoryMessage**](AssociationApplianceServiceHistoryMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## get_association_appliances

> <Array<AssociationApplianceMessage>> get_association_appliances(opts)

Retrieve all appliances

Retrieves all association appliances.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
opts = {
  associationids: [37], # Array<Integer> | Filters results to appliances associated to any of the specified association identifiers.
  unitids: [37], # Array<Integer> | Filters results to appliances associated to any of the specified association unit identifiers.
  orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
  offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
  limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
}

begin
  # Retrieve all appliances
  result = api_instance.get_association_appliances(opts)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_association_appliances: #{e}"
end
```

#### Using the get_association_appliances_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<AssociationApplianceMessage>>, Integer, Hash)> get_association_appliances_with_http_info(opts)

```ruby
begin
  # Retrieve all appliances
  data, status_code, headers = api_instance.get_association_appliances_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<AssociationApplianceMessage>>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->get_association_appliances_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **associationids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to appliances associated to any of the specified association identifiers. | [optional] |
| **unitids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to appliances associated to any of the specified association unit identifiers. | [optional] |
| **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
| **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
| **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |

### Return type

[**Array&lt;AssociationApplianceMessage&gt;**](AssociationApplianceMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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


## update_association_appliance

> <AssociationApplianceMessage> update_association_appliance(appliance_id, update_association_appliance_request)

Update an appliance

Updates an association appliance.              <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit`

### Examples

```ruby
require 'time'
require 'buildium-ruby'
# setup authorization
Buildium.configure do |config|
  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
end

api_instance = Buildium::AppliancesApi.new
appliance_id = 56 # Integer | 
update_association_appliance_request = Buildium::UpdateAssociationApplianceRequest.new({name: 'name_example'}) # UpdateAssociationApplianceRequest | 

begin
  # Update an appliance
  result = api_instance.update_association_appliance(appliance_id, update_association_appliance_request)
  p result
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->update_association_appliance: #{e}"
end
```

#### Using the update_association_appliance_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<AssociationApplianceMessage>, Integer, Hash)> update_association_appliance_with_http_info(appliance_id, update_association_appliance_request)

```ruby
begin
  # Update an appliance
  data, status_code, headers = api_instance.update_association_appliance_with_http_info(appliance_id, update_association_appliance_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AssociationApplianceMessage>
rescue Buildium::ApiError => e
  puts "Error when calling AppliancesApi->update_association_appliance_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **appliance_id** | **Integer** |  |  |
| **update_association_appliance_request** | [**UpdateAssociationApplianceRequest**](UpdateAssociationApplianceRequest.md) |  |  |

### Return type

[**AssociationApplianceMessage**](AssociationApplianceMessage.md)

### Authorization

[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)

### HTTP request headers

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