phone_com_client 1.0.1

data/docs/ExtensionsApi.md

@@ -0,0 +1,262 @@
+# PhoneComClient::ExtensionsApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_extension**](ExtensionsApi.md#create_account_extension) | **POST** /accounts/{account_id}/extensions | Create an individual extension.
+[**get_account_extension**](ExtensionsApi.md#get_account_extension) | **GET** /accounts/{account_id}/extensions/{extension_id} | Show details of an individual extension.
+[**list_account_extensions**](ExtensionsApi.md#list_account_extensions) | **GET** /accounts/{account_id}/extensions | Get a list of extensions visible to the authenticated user or client.
+[**replace_account_extension**](ExtensionsApi.md#replace_account_extension) | **PUT** /accounts/{account_id}/extensions/{extension_id} | Replace an individual extension.
+
+
+# **create_account_extension**
+> ExtensionFull create_account_extension(account_id, , opts)
+
+Create an individual extension.
+
+Create an individual extension. See extension for more details.
+
+### 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::ExtensionsApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  data: PhoneComClient::CreateExtensionParams.new # CreateExtensionParams | Account Extensions Data
+}
+
+begin
+  #Create an individual extension.
+  result = api_instance.create_account_extension(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling ExtensionsApi->create_account_extension: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **data** | [**CreateExtensionParams**](CreateExtensionParams.md)| Account Extensions Data | [optional]
+
+### Return type
+
+[**ExtensionFull**](ExtensionFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_extension**
+> ExtensionFull get_account_extension(account_id, extension_id, )
+
+Show details of an individual extension.
+
+Show details of an individual extension. See extension for more details.
+
+### 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::ExtensionsApi.new
+
+account_id = 56 # Integer | Account ID
+
+extension_id = 56 # Integer | Extension ID
+
+
+begin
+  #Show details of an individual extension.
+  result = api_instance.get_account_extension(account_id, extension_id, )
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling ExtensionsApi->get_account_extension: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **extension_id** | **Integer**| Extension ID |
+
+### Return type
+
+[**ExtensionFull**](ExtensionFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_extensions**
+> ListExtensions list_account_extensions(account_id, , opts)
+
+Get a list of extensions visible to the authenticated user or client.
+
+Get a list of extensions visible to the authenticated user or client. See extension for more details.
+
+### 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::ExtensionsApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  filters_id: ['filters_id_example'], # Array<String> | ID filter
+  filters_extension: ['filters_extension_example'], # Array<String> | Extension filter
+  filters_name: ['filters_name_example'], # Array<String> | Name filter
+  sort_id: 'sort_id_example', # String | ID sorting
+  sort_extension: 'sort_extension_example', # String | Extension sorting
+  sort_name: 'sort_name_example', # String | Name sorting
+  limit: 56, # Integer | Max results
+  offset: 56, # Integer | Results to skip
+  fields: 'fields_example', # String | Field set
+}
+
+begin
+  #Get a list of extensions visible to the authenticated user or client.
+  result = api_instance.list_account_extensions(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling ExtensionsApi->list_account_extensions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
+ **filters_extension** | [**Array&lt;String&gt;**](String.md)| Extension filter | [optional]
+ **filters_name** | [**Array&lt;String&gt;**](String.md)| Name filter | [optional]
+ **sort_id** | **String**| ID sorting | [optional]
+ **sort_extension** | **String**| Extension sorting | [optional]
+ **sort_name** | **String**| Name sorting | [optional]
+ **limit** | **Integer**| Max results | [optional]
+ **offset** | **Integer**| Results to skip | [optional]
+ **fields** | **String**| Field set | [optional]
+
+### Return type
+
+[**ListExtensions**](ListExtensions.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **replace_account_extension**
+> ExtensionFull replace_account_extension(account_id, extension_id, , opts)
+
+Replace an individual extension.
+
+Replace an individual extension. See extension for more details.
+
+### 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::ExtensionsApi.new
+
+account_id = 56 # Integer | Account ID
+
+extension_id = 56 # Integer | Extension ID
+
+opts = {
+  data: PhoneComClient::ReplaceExtensionParams.new # ReplaceExtensionParams | Account Extensions Data
+}
+
+begin
+  #Replace an individual extension.
+  result = api_instance.replace_account_extension(account_id, extension_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling ExtensionsApi->replace_account_extension: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **extension_id** | **Integer**| Extension ID |
+ **data** | [**ReplaceExtensionParams**](ReplaceExtensionParams.md)| Account Extensions Data | [optional]
+
+### Return type
+
+[**ExtensionFull**](ExtensionFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/FilterCallLogs.md

@@ -0,0 +1,13 @@
+# PhoneComClient::FilterCallLogs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**start_time** | **String** |  | [optional]
+**created_at** | **String** |  | [optional]
+**direction** | **String** |  | [optional]
+**called_number** | **String** |  | [optional]
+**type** | **String** |  | [optional]
+
+

data/docs/FilterIdArray.md

@@ -0,0 +1,8 @@
+# PhoneComClient::FilterIdArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+
+

data/docs/FilterIdDirectionFrom.md

@@ -0,0 +1,10 @@
+# PhoneComClient::FilterIdDirectionFrom
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**direction** | **String** |  | [optional]
+**from** | **String** |  | [optional]
+
+

data/docs/FilterIdExtensionNameArray.md

@@ -0,0 +1,10 @@
+# PhoneComClient::FilterIdExtensionNameArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**extension** | **String** |  | [optional]
+**name** | **String** |  | [optional]
+
+

data/docs/FilterIdGroupIdUpdatedAtArray.md

@@ -0,0 +1,10 @@
+# PhoneComClient::FilterIdGroupIdUpdatedAtArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**group_id** | **String** |  | [optional]
+**updated_at** | **String** |  | [optional]
+
+

data/docs/FilterIdNameArray.md

@@ -0,0 +1,9 @@
+# PhoneComClient::FilterIdNameArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**name** | **String** |  | [optional]
+
+

data/docs/FilterIdNamePhoneNumberArray.md

@@ -0,0 +1,10 @@
+# PhoneComClient::FilterIdNamePhoneNumberArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**name** | **String** |  | [optional]
+**phone_number** | **String** |  | [optional]
+
+

data/docs/FilterListAvailableNumbers.md

@@ -0,0 +1,17 @@
+# PhoneComClient::FilterListAvailableNumbers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** |  | [optional]
+**country_code** | **String** |  | [optional]
+**npa** | **String** |  | [optional]
+**nxx** | **String** |  | [optional]
+**xxxx** | **String** |  | [optional]
+**city** | **String** |  | [optional]
+**province** | **String** |  | [optional]
+**country** | **String** |  | [optional]
+**price** | **String** |  | [optional]
+**category** | **String** |  | [optional]
+
+

data/docs/FilterListPhoneNumbersRegions.md

@@ -0,0 +1,14 @@
+# PhoneComClient::FilterListPhoneNumbersRegions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_code** | **String** |  | [optional]
+**npa** | **String** |  | [optional]
+**nxx** | **String** |  | [optional]
+**is_toll_free** | **String** |  | [optional]
+**city** | **String** |  | [optional]
+**province_postal_code** | **String** |  | [optional]
+**country_postal_code** | **String** |  | [optional]
+
+

data/docs/FilterNameNumberArray.md

@@ -0,0 +1,9 @@
+# PhoneComClient::FilterNameNumberArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional]
+**number** | **String** |  | [optional]
+
+

data/docs/FilterVoicemailArray.md

@@ -0,0 +1,13 @@
+# PhoneComClient::FilterVoicemailArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**from** | **String** |  | [optional]
+**to** | **String** |  | [optional]
+**is_new** | **String** |  | [optional]
+**created_at** | **Integer** |  | [optional]
+**extension** | **String** |  | [optional]
+
+

data/docs/FromObject.md

@@ -0,0 +1,11 @@
+# PhoneComClient::FromObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **String** | The caller phone number | [optional]
+**name** | **String** | The name / caller ID of the caller | [optional]
+**city** | **String** | The city where the caller is from | [optional]
+**state** | **String** | The state where the caller is from | [optional]
+
+

data/docs/GetOauthAccessToken.md

@@ -0,0 +1,10 @@
+# PhoneComClient::GetOauthAccessToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scope** | **String** |  | [optional]
+**expires_at** | **Integer** |  | [optional]
+**scope_details** | [**Array<ScopeDetails>**](ScopeDetails.md) |  | [optional]
+
+

data/docs/Greeting.md

@@ -0,0 +1,11 @@
+# PhoneComClient::Greeting
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The greeting to play. Can be \"name\" for the name_greeting as described above, \"standard\" for the standard greeting, or \"alternate\" for an alternate greeting. See below for details. | [optional]
+**alternate** | [**MediaSummary**](MediaSummary.md) | Greeting to be played when type=\"alternate\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object. | [optional]
+**standard** | [**MediaSummary**](MediaSummary.md) | Greeting to be played when type=\"standard\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object. | [optional]
+**enable_leave_message_prompt** | **BOOLEAN** | Whether to prompt the caller with the following words after the voicemail greeting has been played: \"Please leave your message after the tone. When finished, hang up or press the pound key.\" Boolean. | [optional]
+
+

data/docs/GreetingInput.md

@@ -0,0 +1,11 @@
+# PhoneComClient::GreetingInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The greeting to play. Can be \"name\" for the name_greeting as described above, \"standard\" for the standard greeting, or \"alternate\" for an alternate greeting. See below for details. | [optional]
+**alternate** | [**MediaSummary**](MediaSummary.md) | Greeting to be played when type=\"alternate\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object. | [optional]
+**standard** | [**MediaSummary**](MediaSummary.md) | Greeting to be played when type=\"standard\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object. | [optional]
+**enable_leave_message_prompt** | **String** | Whether to prompt the caller with the following words after the voicemail greeting has been played: \"Please leave your message after the tone. When finished, hang up or press the pound key.\" Boolean. | [optional]
+
+

data/docs/GroupFull.md

@@ -0,0 +1,9 @@
+# PhoneComClient::GroupFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Integer ID. Read-only. | [optional]
+**name** | **String** | Name | [optional]
+
+

data/docs/GroupListContacts.md

@@ -0,0 +1,9 @@
+# PhoneComClient::GroupListContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Integer ID. Read-only. | [optional]
+**name** | **String** | Name | [optional]
+
+

data/docs/GroupSummary.md

@@ -0,0 +1,9 @@
+# PhoneComClient::GroupSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Integer ID. Read-only. | [optional]
+**name** | **String** | Name | [optional]
+
+