# ps.module.UrlApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionUrlGet**](UrlApi.md#apiVersionUrlGet) | **GET** /api/{version}/url | Returns a list of your url.
[**apiVersionUrlIdDelete**](UrlApi.md#apiVersionUrlIdDelete) | **DELETE** /api/{version}/url/{id} | Delete existing url.
[**apiVersionUrlIdGet**](UrlApi.md#apiVersionUrlIdGet) | **GET** /api/{version}/url/{id} | Retrieves the details of an existing url.
[**apiVersionUrlIdPut**](UrlApi.md#apiVersionUrlIdPut) | **PUT** /api/{version}/url/{id} | Updates the specific url.
[**apiVersionUrlPost**](UrlApi.md#apiVersionUrlPost) | **POST** /api/{version}/url | Create Url

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

Returns a list of your url.

### 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.UrlApi();
let version = "version_example"; // String | 
let opts = { 
  'country': new ps.module.PhoneSpeakEntitiesEnumsCountry(), // PhoneSpeakEntitiesEnumsCountry | 
  'sortBy': "sortBy_example", // String | 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // PhoneSpeakEntitiesEnumsListDirection | 
  'search': "search_example", // String | 
  'limit': 56, // Number | 
  'pageNum': 56 // Number | 
};
apiInstance.apiVersionUrlGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **country** | [**PhoneSpeakEntitiesEnumsCountry**](.md)|  | [optional] 
 **sortBy** | **String**|  | [optional] 
 **direction** | [**PhoneSpeakEntitiesEnumsListDirection**](.md)|  | [optional] 
 **search** | **String**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **pageNum** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

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

Delete existing url.

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

apiInstance.apiVersionUrlIdDelete(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="apiVersionUrlIdGet"></a>
# **apiVersionUrlIdGet**
> apiVersionUrlIdGet(id, version)

Retrieves the details of an existing url.

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

apiInstance.apiVersionUrlIdGet(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="apiVersionUrlIdPut"></a>
# **apiVersionUrlIdPut**
> apiVersionUrlIdPut(idversion)

Updates the specific url.

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

apiInstance.apiVersionUrlIdPut(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** | [**PhoneSpeakServiceCoreUrlsUpdateUrlQuery**](PhoneSpeakServiceCoreUrlsUpdateUrlQuery.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="apiVersionUrlPost"></a>
# **apiVersionUrlPost**
> apiVersionUrlPost(version)

Create Url

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

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

### Parameters

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