# HivelocityApi.DeploymentApi

All URIs are relative to *https://localhost/api/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteDeploymentIdResource**](DeploymentApi.md#deleteDeploymentIdResource) | **DELETE** /deploy/{deploymentId} | Delete the specified deployment
[**getDeploymentIdResource**](DeploymentApi.md#getDeploymentIdResource) | **GET** /deploy/{deploymentId} | Return a dictionary with deployment information
[**getDeploymentResource**](DeploymentApi.md#getDeploymentResource) | **GET** /deploy/ | Return a list with all client deployments
[**postDeploymentIdResource**](DeploymentApi.md#postDeploymentIdResource) | **POST** /deploy/{deploymentId} | Input a billing info id and script to process and finish a deployment
[**postDeploymentResource**](DeploymentApi.md#postDeploymentResource) | **POST** /deploy/ | Start a new deployment
[**putDeploymentIdResource**](DeploymentApi.md#putDeploymentIdResource) | **PUT** /deploy/{deploymentId} | Receive product, quantity and options to be added on the deployment


<a name="deleteDeploymentIdResource"></a>
# **deleteDeploymentIdResource**
> deleteDeploymentIdResource(deploymentId)

Delete the specified deployment

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.ApiClient.instance;

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

var apiInstance = new HivelocityApi.DeploymentApi();

var deploymentId = 56; // Number | Id of the deployment to interact with


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deploymentId** | **Number**| Id of the deployment to interact with | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="getDeploymentIdResource"></a>
# **getDeploymentIdResource**
> Deployment getDeploymentIdResource(deploymentId, opts)

Return a dictionary with deployment information

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.ApiClient.instance;

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

var apiInstance = new HivelocityApi.DeploymentApi();

var deploymentId = 56; // Number | Id of the deployment to interact with

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deploymentId** | **Number**| Id of the deployment to interact with | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**Deployment**](Deployment.md)

### Authorization

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

### HTTP request headers

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

<a name="getDeploymentResource"></a>
# **getDeploymentResource**
> [Deployment] getDeploymentResource(opts)

Return a list with all client deployments

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.ApiClient.instance;

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

var apiInstance = new HivelocityApi.DeploymentApi();

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**[Deployment]**](Deployment.md)

### Authorization

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

### HTTP request headers

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

<a name="postDeploymentIdResource"></a>
# **postDeploymentIdResource**
> postDeploymentIdResource(deploymentIdpayload)

Input a billing info id and script to process and finish a deployment

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.ApiClient.instance;

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

var apiInstance = new HivelocityApi.DeploymentApi();

var deploymentId = 56; // Number | Id of the deployment to interact with

var payload = new HivelocityApi.DeploymentStart(); // DeploymentStart | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deploymentId** | **Number**| Id of the deployment to interact with | 
 **payload** | [**DeploymentStart**](DeploymentStart.md)|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="postDeploymentResource"></a>
# **postDeploymentResource**
> Deployment postDeploymentResource(opts)

Start a new deployment

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.ApiClient.instance;

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

var apiInstance = new HivelocityApi.DeploymentApi();

var opts = { 
  'deploymentName': "deploymentName_example", // String | 
  'xFields': "xFields_example" // String | An optional fields mask
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deploymentName** | **String**|  | [optional] 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**Deployment**](Deployment.md)

### Authorization

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

### HTTP request headers

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

<a name="putDeploymentIdResource"></a>
# **putDeploymentIdResource**
> Deployment putDeploymentIdResource(deploymentIdpayload, opts)

Receive product, quantity and options to be added on the deployment

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.ApiClient.instance;

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

var apiInstance = new HivelocityApi.DeploymentApi();

var deploymentId = 56; // Number | Id of the deployment to interact with

var payload = new HivelocityApi.DeploymentCustomization(); // DeploymentCustomization | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deploymentId** | **Number**| Id of the deployment to interact with | 
 **payload** | [**DeploymentCustomization**](DeploymentCustomization.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**Deployment**](Deployment.md)

### Authorization

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

### HTTP request headers

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