# ps.module.TeammateApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionTeammateExtensionGet**](TeammateApi.md#apiVersionTeammateExtensionGet) | **GET** /api/{version}/teammate/extension | [Representative] Get next available extension
[**apiVersionTeammateGet**](TeammateApi.md#apiVersionTeammateGet) | **GET** /api/{version}/teammate | [Representative] Returns a list of active Teammate.
[**apiVersionTeammateIdCallhandlingPut**](TeammateApi.md#apiVersionTeammateIdCallhandlingPut) | **PUT** /api/{version}/teammate/{id}/callhandling | Update call handling
[**apiVersionTeammateIdGet**](TeammateApi.md#apiVersionTeammateIdGet) | **GET** /api/{version}/teammate/{id} | [Representative] Retrieve existing Teammate account
[**apiVersionTeammateIdProfileimagePut**](TeammateApi.md#apiVersionTeammateIdProfileimagePut) | **PUT** /api/{version}/teammate/{id}/profileimage | [Representative] Upload existing Teammate Profile Image
[**apiVersionTeammateIdPut**](TeammateApi.md#apiVersionTeammateIdPut) | **PUT** /api/{version}/teammate/{id} | [Representative] Update existing teammmate.
[**apiVersionTeammateIdSmsnoPhoneNumberIdPut**](TeammateApi.md#apiVersionTeammateIdSmsnoPhoneNumberIdPut) | **PUT** /api/{version}/teammate/{id}/smsno/{phoneNumberId} |  (Auth policies: StandardPolicy)
[**apiVersionTeammateIdStatusStatusPut**](TeammateApi.md#apiVersionTeammateIdStatusStatusPut) | **PUT** /api/{version}/teammate/{id}/status/{status} | [Representative] Update teammate status
[**apiVersionTeammatePost**](TeammateApi.md#apiVersionTeammatePost) | **POST** /api/{version}/teammate | [Representative] Create a new Teammate.
[**apiVersionUserGet**](TeammateApi.md#apiVersionUserGet) | **GET** /api/{version}/user | [Own] Retrieve current login Teammate User info

<a name="apiVersionTeammateExtensionGet"></a>
# **apiVersionTeammateExtensionGet**
> apiVersionTeammateExtensionGet(version)

[Representative] Get next available extension

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateExtensionGet(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

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

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeammateGet"></a>
# **apiVersionTeammateGet**
> apiVersionTeammateGet(version, opts)

[Representative] Returns a list of active Teammate.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let version = "version_example"; // String | 
let opts = { 
  'tenantId': "tenantId_example", // String | 
  'role': new ps.module.PhoneSpeakEntitiesEnumsTeammateRole(), // PhoneSpeakEntitiesEnumsTeammateRole | 
  'status': new ps.module.PhoneSpeakEntitiesEnumsTeammateStatus(), // PhoneSpeakEntitiesEnumsTeammateStatus | 
  'defaultCallerId': "defaultCallerId_example", // String | 
  'sortBy': "sortBy_example", // String | 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // PhoneSpeakEntitiesEnumsListDirection | 
  'search': "search_example", // String | 
  'teammateIds': ["teammateIds_example"], // [String] | 
  'pageNum': 56, // Number | 
  'limit': 56, // Number | 
  'skipPagination': true // Boolean | 
};
apiInstance.apiVersionTeammateGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **tenantId** | **String**|  | [optional] 
 **role** | [**PhoneSpeakEntitiesEnumsTeammateRole**](.md)|  | [optional] 
 **status** | [**PhoneSpeakEntitiesEnumsTeammateStatus**](.md)|  | [optional] 
 **defaultCallerId** | **String**|  | [optional] 
 **sortBy** | **String**|  | [optional] 
 **direction** | [**PhoneSpeakEntitiesEnumsListDirection**](.md)|  | [optional] 
 **search** | **String**|  | [optional] 
 **teammateIds** | [**[String]**](String.md)|  | [optional] 
 **pageNum** | **Number**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **skipPagination** | **Boolean**|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeammateIdCallhandlingPut"></a>
# **apiVersionTeammateIdCallhandlingPut**
> apiVersionTeammateIdCallhandlingPut(idversion)

Update call handling

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateIdCallhandlingPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreTeammatesUpdateTeammateCallHandlingQuery**](PhoneSpeakServiceCoreTeammatesUpdateTeammateCallHandlingQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionTeammateIdGet"></a>
# **apiVersionTeammateIdGet**
> apiVersionTeammateIdGet(id, version)

[Representative] Retrieve existing Teammate account

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateIdGet(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeammateIdProfileimagePut"></a>
# **apiVersionTeammateIdProfileimagePut**
> apiVersionTeammateIdProfileimagePut(idversion)

[Representative] Upload existing Teammate Profile Image

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateIdProfileimagePut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreTeammatesUpdateProfileImageTeammateQuery**](PhoneSpeakServiceCoreTeammatesUpdateProfileImageTeammateQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionTeammateIdPut"></a>
# **apiVersionTeammateIdPut**
> apiVersionTeammateIdPut(idversion)

[Representative] Update existing teammmate.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateIdPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreUserManagementTeammatesUpdateTeammateQuery**](PhoneSpeakServiceCoreUserManagementTeammatesUpdateTeammateQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionTeammateIdSmsnoPhoneNumberIdPut"></a>
# **apiVersionTeammateIdSmsnoPhoneNumberIdPut**
> apiVersionTeammateIdSmsnoPhoneNumberIdPut(id, phoneNumberId, version)

 (Auth policies: StandardPolicy)

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let id = "id_example"; // String | 
let phoneNumberId = "phoneNumberId_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateIdSmsnoPhoneNumberIdPut(id, phoneNumberId, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **phoneNumberId** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeammateIdStatusStatusPut"></a>
# **apiVersionTeammateIdStatusStatusPut**
> apiVersionTeammateIdStatusStatusPut(id, status, version)

[Representative] Update teammate status

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let id = "id_example"; // String | 
let status = new ps.module.PhoneSpeakEntitiesEnumsTeammateStatus(); // PhoneSpeakEntitiesEnumsTeammateStatus | 
let version = "version_example"; // String | 

apiInstance.apiVersionTeammateIdStatusStatusPut(id, status, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **status** | [**PhoneSpeakEntitiesEnumsTeammateStatus**](.md)|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeammatePost"></a>
# **apiVersionTeammatePost**
> apiVersionTeammatePost(version)

[Representative] Create a new Teammate.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let version = "version_example"; // String | 

apiInstance.apiVersionTeammatePost(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreTeammatesCreateTeammateQuery**](PhoneSpeakServiceCoreTeammatesCreateTeammateQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionUserGet"></a>
# **apiVersionUserGet**
> apiVersionUserGet(version)

[Own] Retrieve current login Teammate User info

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.TeammateApi();
let version = "version_example"; // String | 

apiInstance.apiVersionUserGet(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

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

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined