phone_com_client 1.0.1

data/docs/RoutesApi.md

@@ -0,0 +1,316 @@
+# PhoneComClient::RoutesApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_route**](RoutesApi.md#create_route) | **POST** /accounts/{account_id}/routes | Add a new route to the account.
+[**delete_account_route**](RoutesApi.md#delete_account_route) | **DELETE** /accounts/{account_id}/routes/{route_id} | Delete a route from the account.
+[**get_account_route**](RoutesApi.md#get_account_route) | **GET** /accounts/{account_id}/routes/{route_id} | Show details of an individual route.
+[**list_account_routes**](RoutesApi.md#list_account_routes) | **GET** /accounts/{account_id}/routes | Get a list of routes for an account.
+[**replace_account_route**](RoutesApi.md#replace_account_route) | **PUT** /accounts/{account_id}/routes/{route_id} | Update the information of a route.
+
+
+# **create_route**
+> RouteFull create_route(account_id, , opts)
+
+Add a new route to the account.
+
+Add a new route to the account. See Intro to Routes 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::RoutesApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  data: PhoneComClient::CreateRouteParams.new # CreateRouteParams | Route data
+}
+
+begin
+  #Add a new route to the account.
+  result = api_instance.create_route(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling RoutesApi->create_route: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **data** | [**CreateRouteParams**](CreateRouteParams.md)| Route data | [optional]
+
+### Return type
+
+[**RouteFull**](RouteFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_account_route**
+> DeleteEntry delete_account_route(account_id, route_id)
+
+Delete a route from the account.
+
+Delete a route from the account. See Intro to Routes 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::RoutesApi.new
+
+account_id = 56 # Integer | Account ID
+
+route_id = 56 # Integer | Route ID
+
+
+begin
+  #Delete a route from the account.
+  result = api_instance.delete_account_route(account_id, route_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling RoutesApi->delete_account_route: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **route_id** | **Integer**| Route ID |
+
+### Return type
+
+[**DeleteEntry**](DeleteEntry.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_route**
+> RouteFull get_account_route(account_id, route_id)
+
+Show details of an individual route.
+
+Show details of an individual route. See Intro to Routes 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::RoutesApi.new
+
+account_id = 56 # Integer | Account ID
+
+route_id = 56 # Integer | Route ID
+
+
+begin
+  #Show details of an individual route.
+  result = api_instance.get_account_route(account_id, route_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling RoutesApi->get_account_route: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **route_id** | **Integer**| Route ID |
+
+### Return type
+
+[**RouteFull**](RouteFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_routes**
+> ListRoutes list_account_routes(account_id, , opts)
+
+Get a list of routes for an account.
+
+Get a list of routes for an account. See Intro to Routes 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::RoutesApi.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 routes for an account.
+  result = api_instance.list_account_routes(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling RoutesApi->list_account_routes: #{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
+
+[**ListRoutes**](ListRoutes.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **replace_account_route**
+> RouteFull replace_account_route(account_id, route_id, opts)
+
+Update the information of a route.
+
+Update the information of a route. See Intro to Routes 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::RoutesApi.new
+
+account_id = 56 # Integer | Account ID
+
+route_id = 56 # Integer | Route ID
+
+opts = {
+  data: PhoneComClient::CreateRouteParams.new # CreateRouteParams | Route data
+}
+
+begin
+  #Update the information of a route.
+  result = api_instance.replace_account_route(account_id, route_id, opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling RoutesApi->replace_account_route: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **route_id** | **Integer**| Route ID |
+ **data** | [**CreateRouteParams**](CreateRouteParams.md)| Route data | [optional]
+
+### Return type
+
+[**RouteFull**](RouteFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/RuleSet.md

@@ -0,0 +1,9 @@
+# PhoneComClient::RuleSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter** | [**RuleSetFilter**](RuleSetFilter.md) |  | [optional]
+**actions** | [**Array<RuleSetAction>**](RuleSetAction.md) | Array of Action Objects. Required. Routes have rule sets, and rule sets have one or more actions. The supported actions are described below: | [optional]
+
+

data/docs/RuleSetAction.md

@@ -0,0 +1,17 @@
+# PhoneComClient::RuleSetAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | Required. | [optional]
+**extension** | [**ExtensionSummary**](ExtensionSummary.md) | Extension that this action refers to. Output is an Extension Summary Object. Input must be an Extension Lookup Object. Required. | [optional]
+**items** | [**Array<RuleSetForwardItem>**](RuleSetForwardItem.md) | This action is for forwarding calls to any number of extensions or phone numbers. The forwarding is handled in parallel, meaning that all phone numbers and/or extensions will ring simultaneously. When the call is answered by any single phone number or extension, ringing will stop for all of them. Subsequent actions in this rule set will be performed if the call is not answered before the timeout period is reached, or if it is forwarded to an extension that has its own route and that route does not result in any actions that disconnect the call or take over call handling. | [optional]
+**timeout** | **Integer** | Seconds that our routing engine should wait until moving on. Optional. Must be an integer between 5 and 90. Default is 5 seconds. | [optional]
+**hold_music** | [**MediaSummary**](MediaSummary.md) | Hold Music to be played while callers are waiting. Output is a Media Summary Object. Input must be a Media Lookup Object. Optional. Must refer to a media recording that has is_hold_music set to TRUE. Default is to play a standard ring tone. | [optional]
+**greeting** | [**MediaSummary**](MediaSummary.md) | Greeting that this action refers to. Output is a Media Summary Object. Input must be a Media Lookup Object. Required. Must refer to a media recording that has is_hold_music set to FALSE. | [optional]
+**duration** | **Integer** | Required. Seconds that the caller should be placed on hold before being moved onto the next action. Must be an integer between 1 and 60 seconds. | [optional]
+**menu** | [**MenuSummary**](MenuSummary.md) | Menu that this action refers to. Required. Output is a Menu Summary Object. Input must be a Menu Lookup Object. | [optional]
+**queue** | [**QueueSummary**](QueueSummary.md) | Queue that this action refers to. Required. Output is a Queue Summary Object. Input must be a Queue Lookup Object. | [optional]
+**trunk** | [**TrunkSummary**](TrunkSummary.md) | Trunk that this action refers to. Required. Output is a Trunk Summary Object. Input must be a Trunk Lookup Object. | [optional]
+
+

data/docs/RuleSetFilter.md

@@ -0,0 +1,11 @@
+# PhoneComClient::RuleSetFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Required. | [optional]
+**schedule** | [**ScheduleSummary**](ScheduleSummary.md) | Schedule that this filter refers to. Output is a Schedule Summary Object. Input must be a Schedule Lookup Object. Required. | [optional]
+**contact** | [**ContactSummary**](ContactSummary.md) | Address Book Contact that this filter refers to. Output is a Contact Summary Object. Input must be a Contact Lookup Object. Required. | [optional]
+**group** | [**GroupSummary**](GroupSummary.md) | Address Book Group that this filter refers to. Output is a Contact Group Summary Object. Input must be a Contact Group Lookup Object. Required. | [optional]
+
+

data/docs/RuleSetForwardItem.md

@@ -0,0 +1,14 @@
+# PhoneComClient::RuleSetForwardItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Required. Must equal phone_number or extension. | [optional]
+**extension** | [**ExtensionSummary**](ExtensionSummary.md) | Required if type = \"extension\". Extension that callers should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object. | [optional]
+**number** | **String** | Required if type = \"phone_number\". Phone number that callers should be directed to. Must be a string in E.164 format. | [optional]
+**screening** | **BOOLEAN** | Boolean. Optional. Default is FALSE. Use this to activate call screening. If TRUE, the timeout on the parent action should be at least 30 seconds. | [optional] [default to false]
+**caller_id** | **String** | Optional. Must equal calling_number or called_number. Defines which phone number should be used for Caller ID. Default is calling_number. | [optional] [default to 'calling_number']
+**voice_tag** | **String** | Optional string. If screening = TRUE, this value will be passed into our Text-To-Speech engine and used to inform the caller of who they have reached. | [optional]
+**distinctive_ring** | **String** | Optional. Must equal one of: DEFAULT, STYLE_2, STYLE_3, STYLE_4, STYLE_5, STYLE_6, STYLE_7, STYLE_8, or STYLE_9. Identifies the style of ring tone you will hear when an incoming call is waiting. | [optional]
+
+

data/docs/ScheduleFull.md

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

data/docs/ScheduleSummary.md

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

data/docs/SchedulesApi.md

@@ -0,0 +1,137 @@
+# PhoneComClient::SchedulesApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account_schedule**](SchedulesApi.md#get_account_schedule) | **GET** /accounts/{account_id}/schedules/{schedule_id} | Show details of an individual schedule
+[**list_account_schedules**](SchedulesApi.md#list_account_schedules) | **GET** /accounts/{account_id}/schedules | Get a list of schedules for an account
+
+
+# **get_account_schedule**
+> ScheduleFull get_account_schedule(account_id, schedule_id)
+
+Show details of an individual schedule
+
+Show details of an individual schedule
+
+### 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::SchedulesApi.new
+
+account_id = 56 # Integer | Account ID
+
+schedule_id = 56 # Integer | Schedule ID
+
+
+begin
+  #Show details of an individual schedule
+  result = api_instance.get_account_schedule(account_id, schedule_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SchedulesApi->get_account_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **schedule_id** | **Integer**| Schedule ID |
+
+### Return type
+
+[**ScheduleFull**](ScheduleFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_schedules**
+> ListSchedules list_account_schedules(account_id, , opts)
+
+Get a list of schedules for an account
+
+Get a list of schedules 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::SchedulesApi.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 schedules for an account
+  result = api_instance.list_account_schedules(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SchedulesApi->list_account_schedules: #{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
+
+[**ListSchedules**](ListSchedules.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ScopeDetails.md

@@ -0,0 +1,8 @@
+# PhoneComClient::ScopeDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**voip_id** | **Integer** |  | [optional]
+
+

data/docs/SipAuthentication.md

@@ -0,0 +1,11 @@
+# PhoneComClient::SipAuthentication
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**host** | **String** | Hostname | [optional]
+**port** | **Integer** | Port number | [optional]
+**username** | **String** | Username. This is the ID of the device. | [optional]
+**password** | **String** | Password. | [optional]
+
+