phone_com_client 1.0.1

data/docs/OauthClientsApi.md

@@ -0,0 +1,191 @@
+# PhoneComClient::OauthClientsApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_account_oauth_client**](OauthClientsApi.md#delete_account_oauth_client) | **DELETE** /accounts/{account_id}/oauth/clients/{client_id} | Delete an individual OAuth client.
+[**get_account_oauth_client**](OauthClientsApi.md#get_account_oauth_client) | **GET** /accounts/{account_id}/oauth/clients/{client_id} | Show details of an individual OAuth client.
+[**list_account_oauth_clients**](OauthClientsApi.md#list_account_oauth_clients) | **GET** /accounts/{account_id}/oauth/clients | Get a list of OAuth clients for an account.
+
+
+# **delete_account_oauth_client**
+> DeleteEntry delete_account_oauth_client(account_id, client_id, )
+
+Delete an individual OAuth client.
+
+Delete an individual OAuth client. See Account OAuth Clients for more info on the properties.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsApi.new
+
+account_id = 56 # Integer | Account ID
+
+client_id = 56 # Integer | Client ID
+
+
+begin
+  #Delete an individual OAuth client.
+  result = api_instance.delete_account_oauth_client(account_id, client_id, )
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsApi->delete_account_oauth_client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **client_id** | **Integer**| Client ID |
+
+### Return type
+
+[**DeleteEntry**](DeleteEntry.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_oauth_client**
+> OauthClientFull get_account_oauth_client(account_id, client_id, )
+
+Show details of an individual OAuth client.
+
+Show details of an individual OAuth client. See Account OAuth Clients for more info on the properties.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsApi.new
+
+account_id = 56 # Integer | Account ID
+
+client_id = 56 # Integer | Client ID
+
+
+begin
+  #Show details of an individual OAuth client.
+  result = api_instance.get_account_oauth_client(account_id, client_id, )
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsApi->get_account_oauth_client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **client_id** | **Integer**| Client ID |
+
+### Return type
+
+[**OauthClientFull**](OauthClientFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_oauth_clients**
+> ListOauthClients list_account_oauth_clients(account_id, , opts)
+
+Get a list of OAuth clients for an account.
+
+Get a list of OAuth clients for an account. See Account OAuth Clients for more info on the properties.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  filters_id: ['filters_id_example'], # Array<String> | ID filter
+  sort_id: 'sort_id_example', # String | ID sorting
+  limit: 56, # Integer | Max results
+  offset: 56, # Integer | Results to skip
+  fields: 'fields_example', # String | Field set
+}
+
+begin
+  #Get a list of OAuth clients for an account.
+  result = api_instance.list_account_oauth_clients(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsApi->list_account_oauth_clients: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
+ **sort_id** | **String**| ID sorting | [optional]
+ **limit** | **Integer**| Max results | [optional]
+ **offset** | **Integer**| Results to skip | [optional]
+ **fields** | **String**| Field set | [optional]
+
+### Return type
+
+[**ListOauthClients**](ListOauthClients.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/OauthClientsRedirectUrisApi.md

@@ -0,0 +1,262 @@
+# PhoneComClient::OauthClientsRedirectUrisApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_oauth_clients_redirect_uri**](OauthClientsRedirectUrisApi.md#create_account_oauth_clients_redirect_uri) | **POST** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris | Create an OAuth Client Redirect URI record.
+[**delete_account_oauth_clients_redirect_uri**](OauthClientsRedirectUrisApi.md#delete_account_oauth_clients_redirect_uri) | **DELETE** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris/{uri_id} | Delete an OAuth Client Redirect URI record.
+[**get_account_oauth_clients_redirect_uri**](OauthClientsRedirectUrisApi.md#get_account_oauth_clients_redirect_uri) | **GET** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris/{uri_id} | Get details of an OAuth Client Redirect URI record.
+[**list_account_oauth_clients_redirect_uris**](OauthClientsRedirectUrisApi.md#list_account_oauth_clients_redirect_uris) | **GET** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris | Get a list of OAuth Client Redirect URIs for an account.
+
+
+# **create_account_oauth_clients_redirect_uri**
+> OauthClientRedirectUriFull create_account_oauth_clients_redirect_uri(account_id, client_id, , opts)
+
+Create an OAuth Client Redirect URI record.
+
+Create an OAuth Client Redirect URI record.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsRedirectUrisApi.new
+
+account_id = 56 # Integer | Account ID
+
+client_id = 56 # Integer | Client ID
+
+opts = {
+  data: PhoneComClient::CreateRedirectUriParams.new # CreateRedirectUriParams | Redirect Uri data
+}
+
+begin
+  #Create an OAuth Client Redirect URI record.
+  result = api_instance.create_account_oauth_clients_redirect_uri(account_id, client_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsRedirectUrisApi->create_account_oauth_clients_redirect_uri: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **client_id** | **Integer**| Client ID |
+ **data** | [**CreateRedirectUriParams**](CreateRedirectUriParams.md)| Redirect Uri data | [optional]
+
+### Return type
+
+[**OauthClientRedirectUriFull**](OauthClientRedirectUriFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_account_oauth_clients_redirect_uri**
+> DeleteEntry delete_account_oauth_clients_redirect_uri(account_id, client_id, uri_id)
+
+Delete an OAuth Client Redirect URI record.
+
+Delete an OAuth Client Redirect URI record.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsRedirectUrisApi.new
+
+account_id = 56 # Integer | Account ID
+
+client_id = 56 # Integer | Client ID
+
+uri_id = 56 # Integer | Redirect URI ID
+
+
+begin
+  #Delete an OAuth Client Redirect URI record.
+  result = api_instance.delete_account_oauth_clients_redirect_uri(account_id, client_id, uri_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsRedirectUrisApi->delete_account_oauth_clients_redirect_uri: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **client_id** | **Integer**| Client ID |
+ **uri_id** | **Integer**| Redirect URI ID |
+
+### Return type
+
+[**DeleteEntry**](DeleteEntry.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_oauth_clients_redirect_uri**
+> OauthClientRedirectUriFull get_account_oauth_clients_redirect_uri(account_id, client_id, uri_id)
+
+Get details of an OAuth Client Redirect URI record.
+
+Get details of an OAuth Client Redirect URI record.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsRedirectUrisApi.new
+
+account_id = 56 # Integer | Account ID
+
+client_id = 56 # Integer | Client ID
+
+uri_id = 56 # Integer | Redirect URI ID
+
+
+begin
+  #Get details of an OAuth Client Redirect URI record.
+  result = api_instance.get_account_oauth_clients_redirect_uri(account_id, client_id, uri_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsRedirectUrisApi->get_account_oauth_clients_redirect_uri: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **client_id** | **Integer**| Client ID |
+ **uri_id** | **Integer**| Redirect URI ID |
+
+### Return type
+
+[**OauthClientRedirectUriFull**](OauthClientRedirectUriFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_oauth_clients_redirect_uris**
+> ListOauthClientsRedirectUris list_account_oauth_clients_redirect_uris(account_id, client_id, , opts)
+
+Get a list of OAuth Client Redirect URIs for an account.
+
+Get a list of OAuth Client Redirect URIs for an account.
+
+### Example
+```ruby
+# load the gem
+require 'phone_com_client'
+# setup authorization
+PhoneComClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = PhoneComClient::OauthClientsRedirectUrisApi.new
+
+account_id = 56 # Integer | Account ID
+
+client_id = 56 # Integer | Client ID
+
+opts = {
+  filters_id: ['filters_id_example'], # Array<String> | ID filter
+  sort_id: 'sort_id_example', # String | ID sorting
+  limit: 56, # Integer | Max results
+  offset: 56, # Integer | Results to skip
+  fields: 'fields_example', # String | Field set
+}
+
+begin
+  #Get a list of OAuth Client Redirect URIs for an account.
+  result = api_instance.list_account_oauth_clients_redirect_uris(account_id, client_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthClientsRedirectUrisApi->list_account_oauth_clients_redirect_uris: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **client_id** | **Integer**| Client ID |
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
+ **sort_id** | **String**| ID sorting | [optional]
+ **limit** | **Integer**| Max results | [optional]
+ **offset** | **Integer**| Results to skip | [optional]
+ **fields** | **String**| Field set | [optional]
+
+### Return type
+
+[**ListOauthClientsRedirectUris**](ListOauthClientsRedirectUris.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Option.md

@@ -0,0 +1,9 @@
+# PhoneComClient::Option
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | Keypad key. Must equal a single digit or the pound sign (\"#\"). | [optional]
+**route** | [**RouteSummary**](RouteSummary.md) | Route which will be entered when the user presses the designated key. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route. | [optional]
+
+

data/docs/PatchPaymentParams.md

@@ -0,0 +1,8 @@
+# PhoneComClient::PatchPaymentParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | primary, onfile or hidden | [optional]
+
+

data/docs/PatchSmsParams.md

@@ -0,0 +1,8 @@
+# PhoneComClient::PatchSmsParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_new** | **String** | Status of SMS | [optional]
+
+

data/docs/PatchVoicemailParams.md

@@ -0,0 +1,8 @@
+# PhoneComClient::PatchVoicemailParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_new** | **String** | Status of voicemail | [optional]
+
+

data/docs/PaymentFull.md

@@ -0,0 +1,20 @@
+# PhoneComClient::PaymentFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Payment Method ID | [optional]
+**voip_id** | **Integer** | API Account ID | [optional]
+**status** | **String** | 'primary' = primary card used for billing; 'onfile' = card on file; 'hidden' = deleted card; | [optional]
+**nickname** | **String** | Name of Card | [optional]
+**type** | **String** | 'cc' for credit card | [optional]
+**created_at** | **Integer** | Time payment record is created | [optional]
+**contact** | [**ContactResponse**](ContactResponse.md) | Detail of contact person | [optional]
+**decline_count** | **Integer** | Number of times the payment method was declined | [optional]
+**next_charge_date** | **Integer** | Next billing date | [optional]
+**updated_at** | **Integer** | Last time the payment method was updated | [optional]
+**cc_token** | **String** | Encrypted credit card token to be used for billing | [optional]
+**cc_number** | **String** | Credit card number partially masked with xxxxxxxx | [optional]
+**cc_exp** | **String** | Credit card expiration date | [optional]
+
+