phone_com_client 1.0.1

data/docs/MenusApi.md

@@ -0,0 +1,316 @@
+# PhoneComClient::MenusApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_menu**](MenusApi.md#create_account_menu) | **POST** /accounts/{account_id}/menus | Create an individual menu.
+[**delete_account_menu**](MenusApi.md#delete_account_menu) | **DELETE** /accounts/{account_id}/menus/{menu_id} | Delete an individual menu.
+[**get_account_menu**](MenusApi.md#get_account_menu) | **GET** /accounts/{account_id}/menus/{menu_id} | Show details of an individual menu.
+[**list_account_menus**](MenusApi.md#list_account_menus) | **GET** /accounts/{account_id}/menus | Get a list of menus for an account.
+[**replace_account_menu**](MenusApi.md#replace_account_menu) | **PUT** /accounts/{account_id}/menus/{menu_id} | Replace an individual menu.
+
+
+# **create_account_menu**
+> MenuFull create_account_menu(account_id, , opts)
+
+Create an individual menu.
+
+Create an individual menu. See Account Menus 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::MenusApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  data: PhoneComClient::CreateMenuParams.new # CreateMenuParams | Menu data
+}
+
+begin
+  #Create an individual menu.
+  result = api_instance.create_account_menu(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling MenusApi->create_account_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **data** | [**CreateMenuParams**](CreateMenuParams.md)| Menu data | [optional]
+
+### Return type
+
+[**MenuFull**](MenuFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_account_menu**
+> DeleteEntry delete_account_menu(account_id, menu_id)
+
+Delete an individual menu.
+
+Delete an individual menu. See Account Menus 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::MenusApi.new
+
+account_id = 56 # Integer | Account ID
+
+menu_id = 56 # Integer | Menu ID
+
+
+begin
+  #Delete an individual menu.
+  result = api_instance.delete_account_menu(account_id, menu_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling MenusApi->delete_account_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **menu_id** | **Integer**| Menu ID |
+
+### Return type
+
+[**DeleteEntry**](DeleteEntry.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_menu**
+> MenuFull get_account_menu(account_id, menu_id)
+
+Show details of an individual menu.
+
+Show details of an individual menu. See Account Menus 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::MenusApi.new
+
+account_id = 56 # Integer | Account ID
+
+menu_id = 56 # Integer | Menu ID
+
+
+begin
+  #Show details of an individual menu.
+  result = api_instance.get_account_menu(account_id, menu_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling MenusApi->get_account_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **menu_id** | **Integer**| Menu ID |
+
+### Return type
+
+[**MenuFull**](MenuFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_menus**
+> ListMenus list_account_menus(account_id, , opts)
+
+Get a list of menus for an account.
+
+Get a list of menus for an account. See Account Menus 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::MenusApi.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 menus for an account.
+  result = api_instance.list_account_menus(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling MenusApi->list_account_menus: #{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
+
+[**ListMenus**](ListMenus.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **replace_account_menu**
+> MenuFull replace_account_menu(account_id, menu_id, opts)
+
+Replace an individual menu.
+
+Replace an individual menu. See Account Menus 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::MenusApi.new
+
+account_id = 56 # Integer | Account ID
+
+menu_id = 56 # Integer | Menu ID
+
+opts = {
+  data: PhoneComClient::ReplaceMenuParams.new # ReplaceMenuParams | Menu data
+}
+
+begin
+  #Replace an individual menu.
+  result = api_instance.replace_account_menu(account_id, menu_id, opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling MenusApi->replace_account_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **menu_id** | **Integer**| Menu ID |
+ **data** | [**ReplaceMenuParams**](ReplaceMenuParams.md)| Menu data | [optional]
+
+### Return type
+
+[**MenuFull**](MenuFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Notification.md

@@ -0,0 +1,9 @@
+# PhoneComClient::Notification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **Array<String>** | Array of email addresses | [optional]
+**sms** | **String** | Phone number capable of receiving SMS messages | [optional]
+
+

data/docs/NumberRegionsApi.md

@@ -0,0 +1,98 @@
+# PhoneComClient::NumberRegionsApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_available_phone_number_regions**](NumberRegionsApi.md#list_available_phone_number_regions) | **GET** /phone-numbers/available/regions |
+
+
+# **list_available_phone_number_regions**
+> ListPhoneNumbersRegions list_available_phone_number_regions(opts)
+
+
+
+This service lists the quantities of available phone numbers by region.
+
+### 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::NumberRegionsApi.new
+
+opts = {
+  filters_country_code: ['filters_country_code_example'], # Array<String> | Country Code filter
+  filters_npa: ['filters_npa_example'], # Array<String> | Area Code filter (North America only)
+  filters_nxx: ['filters_nxx_example'], # Array<String> | 2nd set of 3 digits filter (North America only)
+  filters_is_toll_free: ['filters_is_toll_free_example'], # Array<String> | Toll-free status filter
+  filters_city: ['filters_city_example'], # Array<String> | City filter
+  filters_province_postal_code: ['filters_province_postal_code_example'], # Array<String> | State or Province filter
+  filters_country_postal_code: ['filters_country_postal_code_example'], # Array<String> | Country filter
+  sort_country_code: 'sort_country_code_example', # String | International calling code sorting
+  sort_npa: 'sort_npa_example', # String | Area Code sorting (North America only)
+  sort_nxx: 'sort_nxx_example', # String | 2nd set of 3 digits sorting (North America)
+  sort_is_toll_free: 'sort_is_toll_free_example', # String | Toll Free status sorting
+  sort_city: 'sort_city_example', # String | City sorting
+  sort_province_postal_code: 'sort_province_postal_code_example', # String | State or Province sorting
+  sort_country_postal_code: 'sort_country_postal_code_example', # String | Country sorting
+  limit: 56, # Integer | Max results
+  offset: 56, # Integer | Results to skip
+  fields: 'fields_example', # String | Field set
+  group_by: ['group_by_example'] # Array<String> | Fields to group by (supports the same set of fields as the filters and sorting)
+}
+
+begin
+  #
+  result = api_instance.list_available_phone_number_regions(opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling NumberRegionsApi->list_available_phone_number_regions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filters_country_code** | [**Array&lt;String&gt;**](String.md)| Country Code filter | [optional]
+ **filters_npa** | [**Array&lt;String&gt;**](String.md)| Area Code filter (North America only) | [optional]
+ **filters_nxx** | [**Array&lt;String&gt;**](String.md)| 2nd set of 3 digits filter (North America only) | [optional]
+ **filters_is_toll_free** | [**Array&lt;String&gt;**](String.md)| Toll-free status filter | [optional]
+ **filters_city** | [**Array&lt;String&gt;**](String.md)| City filter | [optional]
+ **filters_province_postal_code** | [**Array&lt;String&gt;**](String.md)| State or Province filter | [optional]
+ **filters_country_postal_code** | [**Array&lt;String&gt;**](String.md)| Country filter | [optional]
+ **sort_country_code** | **String**| International calling code sorting | [optional]
+ **sort_npa** | **String**| Area Code sorting (North America only) | [optional]
+ **sort_nxx** | **String**| 2nd set of 3 digits sorting (North America) | [optional]
+ **sort_is_toll_free** | **String**| Toll Free status sorting | [optional]
+ **sort_city** | **String**| City sorting | [optional]
+ **sort_province_postal_code** | **String**| State or Province sorting | [optional]
+ **sort_country_postal_code** | **String**| Country sorting | [optional]
+ **limit** | **Integer**| Max results | [optional]
+ **offset** | **Integer**| Results to skip | [optional]
+ **fields** | **String**| Field set | [optional]
+ **group_by** | [**Array&lt;String&gt;**](String.md)| Fields to group by (supports the same set of fields as the filters and sorting) | [optional]
+
+### Return type
+
+[**ListPhoneNumbersRegions**](ListPhoneNumbersRegions.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/OauthAccessToken.md

@@ -0,0 +1,12 @@
+# PhoneComClient::OauthAccessToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** |  | [optional]
+**token_type** | **String** |  | [optional]
+**scope** | **String** |  | [optional]
+**refresh_token** | **String** |  | [optional]
+**expires_in** | **Integer** |  | [optional]
+
+

data/docs/OauthApi.md

@@ -0,0 +1,176 @@
+# PhoneComClient::OauthApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_oauth_access_token**](OauthApi.md#create_oauth_access_token) | **POST** /oauth/access-token | To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant.
+[**create_oauth_authorization**](OauthApi.md#create_oauth_authorization) | **GET** /oauth/authorization | Create Authorization Code or Access Token.
+[**get_oauth_access_token**](OauthApi.md#get_oauth_access_token) | **GET** /oauth/access-token | Retrieve details of an access token, such as scope, expiration and extension ID.
+
+
+# **create_oauth_access_token**
+> OauthAccessToken create_oauth_access_token(opts)
+
+To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant.
+
+To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant. For Authorization Code Grant, the input parameter 'code' is generated via the Create Authorization API. NOTE: The Create Access Token API now accepts requests in query string format as well as JSON body format. See OAuth for more details on how to obtain client id and client secret to create an access token at real time.
+
+### 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::OauthApi.new
+
+opts = {
+  data: PhoneComClient::CreateOauthParams.new # CreateOauthParams | Oauth data
+}
+
+begin
+  #To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant.
+  result = api_instance.create_oauth_access_token(opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthApi->create_oauth_access_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**CreateOauthParams**](CreateOauthParams.md)| Oauth data | [optional]
+
+### Return type
+
+[**OauthAccessToken**](OauthAccessToken.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_oauth_authorization**
+> create_oauth_authorization(client_id, response_type, scope, redirect_uri)
+
+Create Authorization Code or Access Token.
+
+Create Authorization Code or Access Token. The /oauth/authorization API supports Authorization Grant and Implicit Grant. In Authorization Grant, this API returns a code (response_type=code) for clients implemented in a browser using a scripting language such as JavaScript. Users may then use the code via the Create Access Token API to create an access token. The Implicit Grant is a simplified authorization code flow. In the implicit flow, instead of issuing the client an authorization code, the client is issued an access token (response_type=token) directly. See OAuth for more details on how to obtain client id and client secret to create authorization code access token at real time.
+
+### 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::OauthApi.new
+
+client_id = 'client_id_example' # String | Client ID
+
+response_type = 'response_type_example' # String | 'token' for Implicit Grant; 'code' for Authorization Code Grant
+
+scope = 'scope_example' # String | account-owner, extension-user and/or methods:ALL, separated by space (%20)
+
+redirect_uri = 'redirect_uri_example' # String | The URL where the response data of this API is redirected to
+
+
+begin
+  #Create Authorization Code or Access Token.
+  api_instance.create_oauth_authorization(client_id, response_type, scope, redirect_uri)
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthApi->create_oauth_authorization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | **String**| Client ID |
+ **response_type** | **String**| 'token' for Implicit Grant; 'code' for Authorization Code Grant |
+ **scope** | **String**| account-owner, extension-user and/or methods:ALL, separated by space (%20) |
+ **redirect_uri** | **String**| The URL where the response data of this API is redirected to |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_oauth_access_token**
+> GetOauthAccessToken get_oauth_access_token
+
+Retrieve details of an access token, such as scope, expiration and extension ID.
+
+Retrieve details of an access token, such as scope, expiration and extension ID. Voip ID will be returned as well if scope contains account-owner scope.
+
+### 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::OauthApi.new
+
+begin
+  #Retrieve details of an access token, such as scope, expiration and extension ID.
+  result = api_instance.get_oauth_access_token
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling OauthApi->get_oauth_access_token: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetOauthAccessToken**](GetOauthAccessToken.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/OauthClientFull.md

@@ -0,0 +1,9 @@
+# PhoneComClient::OauthClientFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Client ID | [optional]
+**client_name** | **String** | Name of Client | [optional]
+
+

data/docs/OauthClientRedirectUriFull.md

@@ -0,0 +1,10 @@
+# PhoneComClient::OauthClientRedirectUriFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | OAuth Client Redirect URI ID | [optional]
+**client** | [**OauthClientFull**](OauthClientFull.md) | Client details | [optional]
+**redirect_uri** | [**RedirectUriFull**](RedirectUriFull.md) | Redirect URI details | [optional]
+
+