# ps.module.NumberApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionNumberCountryGet**](NumberApi.md#apiVersionNumberCountryGet) | **GET** /api/{version}/number/{country} | Search Number
[**apiVersionNumberCountryPurchasePost**](NumberApi.md#apiVersionNumberCountryPurchasePost) | **POST** /api/{version}/number/{country}/purchase | [TBC] Purchase Number
[**apiVersionNumberCountryReleaseDelete**](NumberApi.md#apiVersionNumberCountryReleaseDelete) | **DELETE** /api/{version}/number/{country}/release | [TBC] Release number
[**apiVersionNumberCountryReservePost**](NumberApi.md#apiVersionNumberCountryReservePost) | **POST** /api/{version}/number/{country}/reserve | Reserve Number
[**apiVersionNumberImportPost**](NumberApi.md#apiVersionNumberImportPost) | **POST** /api/{version}/number/import | [TBC] Import Number to local number pool

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

Search Number

### 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.NumberApi();
let country = new ps.module.PhoneSpeakEntitiesEnumsCountry(); // PhoneSpeakEntitiesEnumsCountry | 
let version = "version_example"; // String | 
let opts = { 
  'areaCode': "areaCode_example", // String | 
  'isTollFree': true, // Boolean | 
  'limit': 56, // Number | 
  'provider': new ps.module.PhoneSpeakEntitiesEnumsNumberProvider(), // PhoneSpeakEntitiesEnumsNumberProvider | 
  'randomRecord': true // Boolean | 
};
apiInstance.apiVersionNumberCountryGet(country, version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **country** | [**PhoneSpeakEntitiesEnumsCountry**](.md)|  | 
 **version** | **String**|  | 
 **areaCode** | **String**|  | [optional] 
 **isTollFree** | **Boolean**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **provider** | [**PhoneSpeakEntitiesEnumsNumberProvider**](.md)|  | [optional] 
 **randomRecord** | **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="apiVersionNumberCountryPurchasePost"></a>
# **apiVersionNumberCountryPurchasePost**
> apiVersionNumberCountryPurchasePost(countryversion)

[TBC] Purchase Number

### 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.NumberApi();
let country = new ps.module.PhoneSpeakEntitiesEnumsCountry(); // PhoneSpeakEntitiesEnumsCountry | Phone number country
let version = "version_example"; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **country** | [**PhoneSpeakEntitiesEnumsCountry**](.md)| Phone number country | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreNumbersPurchaseNumberQuery**](PhoneSpeakServiceCoreNumbersPurchaseNumberQuery.md)| Purchase the Phone number. Phone number format must be in E164. | [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="apiVersionNumberCountryReleaseDelete"></a>
# **apiVersionNumberCountryReleaseDelete**
> apiVersionNumberCountryReleaseDelete(countryversion)

[TBC] Release number

### 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.NumberApi();
let country = new ps.module.PhoneSpeakEntitiesEnumsCountry(); // PhoneSpeakEntitiesEnumsCountry | Phone number country
let version = "version_example"; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **country** | [**PhoneSpeakEntitiesEnumsCountry**](.md)| Phone number country | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreNumbersReleaseNumberQuery**](PhoneSpeakServiceCoreNumbersReleaseNumberQuery.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="apiVersionNumberCountryReservePost"></a>
# **apiVersionNumberCountryReservePost**
> apiVersionNumberCountryReservePost(countryversion)

Reserve Number

### 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.NumberApi();
let country = new ps.module.PhoneSpeakEntitiesEnumsCountry(); // PhoneSpeakEntitiesEnumsCountry | Phone number country
let version = "version_example"; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **country** | [**PhoneSpeakEntitiesEnumsCountry**](.md)| Phone number country | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreNumbersReserveNumberQuery**](PhoneSpeakServiceCoreNumbersReserveNumberQuery.md)| Reserve the phone number. Phone number format must be in E164. | [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="apiVersionNumberImportPost"></a>
# **apiVersionNumberImportPost**
> apiVersionNumberImportPost(version)

[TBC] Import Number to local number pool

### 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.NumberApi();
let version = "version_example"; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreNumbersImportNumberQuery**](PhoneSpeakServiceCoreNumbersImportNumberQuery.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