phone_com_client 1.0.1

data/docs/CreateRedirectUriParams.md

@@ -0,0 +1,8 @@
+# PhoneComClient::CreateRedirectUriParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_uri** | **String** | Redirect URI string for use in redirect-based flows such as the authorization code and implicit flows | [optional]
+
+

data/docs/CreateRouteParams.md

@@ -0,0 +1,10 @@
+# PhoneComClient::CreateRouteParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name | [optional]
+**rules** | **Array<Object>** | Rule Sets | [optional]
+**extension** | **Object** | Extension Reference | [optional]
+
+

data/docs/CreateSmsParams.md

@@ -0,0 +1,11 @@
+# PhoneComClient::CreateSmsParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **String** | Phone number of sender |
+**to** | **String** | Outgoing destination numbers |
+**text** | **String** | Text body of the outgoing SMS message. Maximum 160 characters per message. |
+**extension_id** | **Integer** | ID of Extension where the sms is saved | [optional]
+
+

data/docs/CreateSubaccountParams.md

@@ -0,0 +1,11 @@
+# PhoneComClient::CreateSubaccountParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Sub account password |
+**password** | **String** | Sub account password |
+**contact** | [**ContactResponse**](ContactResponse.md) | Contact Object. See below for details. | [optional]
+**billing_contact** | [**ContactResponse**](ContactResponse.md) | Contact Object for billing purposes. See below for details. | [optional]
+
+

data/docs/CreateTrunkParams.md

@@ -0,0 +1,14 @@
+# PhoneComClient::CreateTrunkParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of Trunk | [optional]
+**uri** | **String** | URI of Trunk (in the form of SIP/user@host.com:port) | [optional]
+**max_concurrent_calls** | **Integer** | Max concurrent calls | [optional]
+**max_minutes_per_month** | **Integer** | Max minutes per month | [optional]
+**greeting** | **Object** | Recording lookup object | [optional]
+**error_message** | **Object** | Recording lookup object | [optional]
+**codecs** | **Array<Object>** | Custom audio codec configuration | [optional]
+
+

data/docs/DefaultApi.md

@@ -0,0 +1,57 @@
+# PhoneComClient::DefaultApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ping**](DefaultApi.md#ping) | **GET** /ping | The default API command
+
+
+# **ping**
+> PingResponse ping
+
+The default API command
+
+The default API command
+
+### 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::DefaultApi.new
+
+begin
+  #The default API command
+  result = api_instance.ping
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling DefaultApi->ping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PingResponse**](PingResponse.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DeleteEntry.md

@@ -0,0 +1,8 @@
+# PhoneComClient::DeleteEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **BOOLEAN** |  | [optional]
+
+

data/docs/DeviceFull.md

@@ -0,0 +1,11 @@
+# PhoneComClient::DeviceFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID | [optional]
+**name** | **String** | User-supplied name, otherwise NULL | [optional]
+**sip_authentication** | [**SipAuthentication**](SipAuthentication.md) |  | [optional]
+**lines** | [**Array<Line>**](Line.md) | Array of Line Objects showing which extensions are attached to this device, and their assigned line numbers. See below for details. | [optional]
+
+

data/docs/DeviceMembership.md

@@ -0,0 +1,9 @@
+# PhoneComClient::DeviceMembership
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line** | **Integer** | Line number to which this extension is assigned. Integer. | [optional]
+**device** | [**DeviceSummary**](DeviceSummary.md) | Device that this extension belongs to. Output is an Device Summary Object. | [optional]
+
+

data/docs/DeviceSummary.md

@@ -0,0 +1,9 @@
+# PhoneComClient::DeviceSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID | [optional]
+**name** | **String** | User-supplied name, otherwise NULL | [optional]
+
+

data/docs/DevicesApi.md

@@ -0,0 +1,316 @@
+# PhoneComClient::DevicesApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_device**](DevicesApi.md#create_account_device) | **POST** /accounts/{account_id}/devices | Register a generic VoIP device.
+[**delete_account_device**](DevicesApi.md#delete_account_device) | **DELETE** /accounts/{account_id}/devices/{device_id} | Delete a VoIP device.
+[**get_account_device**](DevicesApi.md#get_account_device) | **GET** /accounts/{account_id}/devices/{device_id} | Show details of an individual VoIP device.
+[**list_account_devices**](DevicesApi.md#list_account_devices) | **GET** /accounts/{account_id}/devices | Get a list of VoIP devices associated with your account.
+[**replace_account_device**](DevicesApi.md#replace_account_device) | **PUT** /accounts/{account_id}/devices/{device_id} | Update the details of an individual VoIP device.
+
+
+# **create_account_device**
+> DeviceFull create_account_device(account_id, , opts)
+
+Register a generic VoIP device.
+
+Register a generic VoIP device. See Devices for more detail.
+
+### 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::DevicesApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  data: PhoneComClient::CreateDeviceParams.new # CreateDeviceParams | Device data
+}
+
+begin
+  #Register a generic VoIP device.
+  result = api_instance.create_account_device(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling DevicesApi->create_account_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **data** | [**CreateDeviceParams**](CreateDeviceParams.md)| Device data | [optional]
+
+### Return type
+
+[**DeviceFull**](DeviceFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_account_device**
+> DeleteEntry delete_account_device(account_id, device_id)
+
+Delete a VoIP device.
+
+Delete a VoIP device. See Devices for more detail.
+
+### 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::DevicesApi.new
+
+account_id = 56 # Integer | Account ID
+
+device_id = 56 # Integer | Device ID
+
+
+begin
+  #Delete a VoIP device.
+  result = api_instance.delete_account_device(account_id, device_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling DevicesApi->delete_account_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **device_id** | **Integer**| Device ID |
+
+### Return type
+
+[**DeleteEntry**](DeleteEntry.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_device**
+> DeviceFull get_account_device(account_id, device_id)
+
+Show details of an individual VoIP device.
+
+Show details of an individual VoIP device. See Devices for more detail.
+
+### 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::DevicesApi.new
+
+account_id = 56 # Integer | Account ID
+
+device_id = 56 # Integer | Device ID
+
+
+begin
+  #Show details of an individual VoIP device.
+  result = api_instance.get_account_device(account_id, device_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling DevicesApi->get_account_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **device_id** | **Integer**| Device ID |
+
+### Return type
+
+[**DeviceFull**](DeviceFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_devices**
+> ListDevices list_account_devices(account_id, , opts)
+
+Get a list of VoIP devices associated with your account.
+
+Get a list of VoIP devices associated with your account. See Devices for more detail.
+
+### 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::DevicesApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  filters_id: ['filters_id_example'], # Array<String> | ID filter
+  filters_name: ['filters_name_example'], # Array<String> | Name filter
+  sort_id: 'sort_id_example', # String | ID 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 VoIP devices associated with your account.
+  result = api_instance.list_account_devices(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling DevicesApi->list_account_devices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
+ **filters_name** | [**Array&lt;String&gt;**](String.md)| Name filter | [optional]
+ **sort_id** | **String**| ID 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
+
+[**ListDevices**](ListDevices.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **replace_account_device**
+> DeviceFull replace_account_device(account_id, device_id, opts)
+
+Update the details of an individual VoIP device.
+
+Update the details of an individual VoIP device. See Devices for more detail.
+
+### 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::DevicesApi.new
+
+account_id = 56 # Integer | Account ID
+
+device_id = 56 # Integer | Device ID
+
+opts = {
+  data: PhoneComClient::CreateDeviceParams.new # CreateDeviceParams | Device data
+}
+
+begin
+  #Update the details of an individual VoIP device.
+  result = api_instance.replace_account_device(account_id, device_id, opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling DevicesApi->replace_account_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **device_id** | **Integer**| Device ID |
+ **data** | [**CreateDeviceParams**](CreateDeviceParams.md)| Device data | [optional]
+
+### Return type
+
+[**DeviceFull**](DeviceFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Email.md

@@ -0,0 +1,9 @@
+# PhoneComClient::Email
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Email type, one of: primary or alternate. Default is primary. | [optional]
+**email** | **String** | Email address. Required. | [optional]
+
+

data/docs/ExpressServiceCodeFull.md

@@ -0,0 +1,10 @@
+# PhoneComClient::ExpressServiceCodeFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID | [optional]
+**express_service_code** | **String** | An 8-digit number in string format | [optional]
+**expire_date** | **Array<Integer>** | UNIX time stamp representing the UTC time that the Express Service Code expires. Please note that every time this service is executed, the expire_date is set to now + 24 hours. | [optional]
+
+

data/docs/ExpressServiceCodesApi.md

@@ -0,0 +1,125 @@
+# PhoneComClient::ExpressServiceCodesApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account_express_srv_code**](ExpressServiceCodesApi.md#get_account_express_srv_code) | **GET** /accounts/{account_id}/express-service-codes/{code_id} | Show details of an account Express Service Code
+[**list_account_express_srv_codes**](ExpressServiceCodesApi.md#list_account_express_srv_codes) | **GET** /accounts/{account_id}/express-service-codes | Get the Express Service Code associated with your account in list format.
+
+
+# **get_account_express_srv_code**
+> ExpressServiceCodeFull get_account_express_srv_code(account_id, code_id)
+
+Show details of an account Express Service Code
+
+This service shows the details of an Account Express Service Code.
+
+### 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::ExpressServiceCodesApi.new
+
+account_id = 56 # Integer | Account ID
+
+code_id = 56 # Integer | Device ID
+
+
+begin
+  #Show details of an account Express Service Code
+  result = api_instance.get_account_express_srv_code(account_id, code_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling ExpressServiceCodesApi->get_account_express_srv_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **code_id** | **Integer**| Device ID |
+
+### Return type
+
+[**ExpressServiceCodeFull**](ExpressServiceCodeFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_express_srv_codes**
+> ListExpressServiceCodes list_account_express_srv_codes(account_id, , opts)
+
+Get the Express Service Code associated with your account in list format.
+
+Get the Express Service Code associated with your account in list format. See Express Service Codes for more detail.
+
+### 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::ExpressServiceCodesApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  filters_id: ['filters_id_example'], # Array<String> | ID filter
+}
+
+begin
+  #Get the Express Service Code associated with your account in list format.
+  result = api_instance.list_account_express_srv_codes(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling ExpressServiceCodesApi->list_account_express_srv_codes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
+
+### Return type
+
+[**ListExpressServiceCodes**](ListExpressServiceCodes.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ExtensionFull.md

@@ -0,0 +1,24 @@
+# PhoneComClient::ExtensionFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the extension. This is the internal Phone.com ID, not the extension number callers may dial. | [optional]
+**name** | **String** | User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required. | [optional]
+**extension** | **Integer** | Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required. | [optional]
+**voip_id** | **Integer** | API Account ID. Optional, object may return the voip_id. | [optional]
+**full_name** | **String** | Full name of the individual or department to which this extension is assigned | [optional]
+**usage_type** | **String** | Can be \"limited\" or \"unlimited\". In most cases, changing this will affect your monthly bill. Please see our Control Panel or contact Customer Service for pricing. | [optional]
+**device_membership** | [**DeviceMembership**](DeviceMembership.md) |  | [optional]
+**timezone** | **String** | Time zone. Can be in any commonly recognized format, such as \"America/Los_Angeles\". | [optional]
+**name_greeting** | [**MediaSummary**](MediaSummary.md) | Greeting that communicates the extension's name. Output is a Greeting Summary Object. Input must be a Greeting Lookup Object. | [optional]
+**include_in_directory** | **BOOLEAN** | Whether this extension should be included in the dial-by-name directory for this account. Boolean. | [optional]
+**caller_id** | **String** | Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone numbers. You can use our List Caller Ids service to see a current list. To unassign, you may set this to \"private\", NULL, or an empty string. | [optional]
+**local_area_code** | **String** | For outbound calls, this is the North American area code that this extension is calling from. | [optional]
+**enable_call_waiting** | **BOOLEAN** | Whether Call Waiting is enabled. Boolean. Default is TRUE. | [optional]
+**enable_outbound_calls** | **BOOLEAN** | Whether outgoing calls are enabled. Boolean. Default is TRUE. | [optional]
+**voicemail** | [**Voicemail**](Voicemail.md) |  | [optional]
+**call_notifications** | [**Notification**](Notification.md) |  | [optional]
+**route** | [**RouteSummary**](RouteSummary.md) | Route which will handle incoming voice and fax calls. Only valid on PUT requests, not POST. 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. Route must belong to this extension already. | [optional]
+
+

data/docs/ExtensionSummary.md

@@ -0,0 +1,10 @@
+# PhoneComClient::ExtensionSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the extension. This is the internal Phone.com ID, not the extension number callers may dial. | [optional]
+**name** | **String** | User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required. | [optional]
+**extension** | **Integer** | Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required. | [optional]
+
+