phone_com_client 1.0.1

data/docs/SmsApi.md

@@ -0,0 +1,265 @@
+# PhoneComClient::SmsApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_sms**](SmsApi.md#create_account_sms) | **POST** /accounts/{account_id}/sms | Send a SMS to one or a group of recipients.
+[**get_account_sms**](SmsApi.md#get_account_sms) | **GET** /accounts/{account_id}/sms/{sms_id} | This service shows the details of an individual SMS.
+[**list_account_sms**](SmsApi.md#list_account_sms) | **GET** /accounts/{account_id}/sms | Get a list of SMS messages for an account.
+[**patch_account_sms**](SmsApi.md#patch_account_sms) | **PATCH** /accounts/{account_id}/sms/{sms_id} | Update the is_new parameter in a sms record.
+
+
+# **create_account_sms**
+> SmsFull create_account_sms(account_id, data)
+
+Send a SMS to one or a group of recipients.
+
+Send a SMS to one or a group of recipients. For details on the input fields, see Intro to SMS. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Create SMS API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms
+
+### 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::SmsApi.new
+
+account_id = 56 # Integer | Account ID
+
+data = PhoneComClient::CreateSmsParams.new # CreateSmsParams | SMS data
+
+
+begin
+  #Send a SMS to one or a group of recipients.
+  result = api_instance.create_account_sms(account_id, data)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SmsApi->create_account_sms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **data** | [**CreateSmsParams**](CreateSmsParams.md)| SMS data |
+
+### Return type
+
+[**SmsFull**](SmsFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_sms**
+> SmsFull get_account_sms(account_id, sms_id)
+
+This service shows the details of an individual SMS.
+
+This service shows the details of an individual SMS. See Intro to SMS for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Get SMS API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms/:sms_id
+
+### 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::SmsApi.new
+
+account_id = 56 # Integer | Account ID
+
+sms_id = 'sms_id_example' # String | SMS ID
+
+
+begin
+  #This service shows the details of an individual SMS.
+  result = api_instance.get_account_sms(account_id, sms_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SmsApi->get_account_sms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **sms_id** | **String**| SMS ID |
+
+### Return type
+
+[**SmsFull**](SmsFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_sms**
+> ListSms list_account_sms(account_id, , opts)
+
+Get a list of SMS messages for an account.
+
+Get a list of SMS messages for an account. See Intro to SMS for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List SMS API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms
+
+### 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::SmsApi.new
+
+account_id = 56 # Integer | Account ID
+
+opts = {
+  filters_id: ['filters_id_example'], # Array<String> | ID filter
+  filters_from: 'filters_from_example', # String | Caller ID filter
+  filters_to: 'filters_to_example', # String | Callee ID filter, the E.164 phone number to send the SMS TO. Note you must encode the + as %2B
+  filters_direction: 'filters_direction_example', # String | Direction filter
+  filters_extension: ['filters_extension_example'], # Array<String> | Extension filter
+  filters_created_at: 'filters_created_at_example', # String | Date string representing the UTC time that sms was created
+  sort_id: 'sort_id_example', # String | ID sorting
+  sort_created_at: 'sort_created_at_example', # String | Sort by created time of message
+  limit: 56, # Integer | Max results
+  offset: 56, # Integer | Results to skip
+  fields: 'fields_example', # String | Field set
+}
+
+begin
+  #Get a list of SMS messages for an account.
+  result = api_instance.list_account_sms(account_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SmsApi->list_account_sms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
+ **filters_from** | **String**| Caller ID filter | [optional]
+ **filters_to** | **String**| Callee ID filter, the E.164 phone number to send the SMS TO. Note you must encode the + as %2B | [optional]
+ **filters_direction** | **String**| Direction filter | [optional]
+ **filters_extension** | [**Array&lt;String&gt;**](String.md)| Extension filter | [optional]
+ **filters_created_at** | **String**| Date string representing the UTC time that sms was created | [optional]
+ **sort_id** | **String**| ID sorting | [optional]
+ **sort_created_at** | **String**| Sort by created time of message | [optional]
+ **limit** | **Integer**| Max results | [optional]
+ **offset** | **Integer**| Results to skip | [optional]
+ **fields** | **String**| Field set | [optional]
+
+### Return type
+
+[**ListSms**](ListSms.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_account_sms**
+> SmsFull patch_account_sms(account_id, sms_id, opts)
+
+Update the is_new parameter in a sms record.
+
+Update the is_new parameter in a sms record. See Account SMS for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Patch SMS API with the following definition: PATCH https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms/:sms_id
+
+### 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::SmsApi.new
+
+account_id = 56 # Integer | Account ID
+
+sms_id = 'sms_id_example' # String | SMS ID
+
+opts = {
+  data: PhoneComClient::PatchSmsParams.new # PatchSmsParams | Sms data
+}
+
+begin
+  #Update the is_new parameter in a sms record.
+  result = api_instance.patch_account_sms(account_id, sms_id, opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SmsApi->patch_account_sms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **sms_id** | **String**| SMS ID |
+ **data** | [**PatchSmsParams**](PatchSmsParams.md)| Sms data | [optional]
+
+### Return type
+
+[**SmsFull**](SmsFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SmsForwarding.md

@@ -0,0 +1,10 @@
+# PhoneComClient::SmsForwarding
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Can be \"extension\" or \"application\" | [optional]
+**extension** | [**ExtensionSummary**](ExtensionSummary.md) | Required if type = \"extension\". Extension that messages should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object. | [optional]
+**application** | [**ApplicationSummary**](ApplicationSummary.md) | Required if type = \"application\". Application that messages should be directed to. Output is an Application Summary Object. Input must be an Application Lookup Object. | [optional]
+
+

data/docs/SmsForwardingParams.md

@@ -0,0 +1,10 @@
+# PhoneComClient::SmsForwardingParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Can be \"extension\" or \"application\" | [optional]
+**extension** | **Integer** | Required if type = \"extension\". Extension that messages should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object. | [optional]
+**application** | **Integer** | Required if type = \"application\". Application that messages should be directed to. Output is an Application Summary Object. Input must be an Application Lookup Object. | [optional]
+
+

data/docs/SmsFull.md

@@ -0,0 +1,15 @@
+# PhoneComClient::SmsFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique SMS ID. Read-only. | [optional]
+**from** | **String** | Caller ID number to display on the incoming/outgoing SMS message. For an outgoing message, it must be a phone number associated with your Phone.com account. | [optional]
+**to** | [**Array<Recipient>**](Recipient.md) | An array of SMS recipients. | [optional]
+**direction** | **String** | Direction of SMS. 'in' for Incoming messages, 'out' for Outgoing messages. | [optional]
+**created_epoch** | **Integer** | Unix time stamp representing the UTC time that the object was created in the Phone.com API system. | [optional]
+**created_at** | **DateTime** | Date string representing the UTC time that the object was created in the Phone.com API system. | [optional]
+**text** | **String** | Body of the SMS text | [optional]
+**is_new** | **BOOLEAN** | True when SMS is new; False when SMS has been read. | [optional]
+
+

data/docs/SortCallLogs.md

@@ -0,0 +1,10 @@
+# PhoneComClient::SortCallLogs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**start_time** | **String** |  | [optional]
+**created_at** | **String** |  | [optional]
+
+

data/docs/SortId.md

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

data/docs/SortIdCreatedAt.md

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

data/docs/SortIdExtensionName.md

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

data/docs/SortIdName.md

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

data/docs/SortIdNamePhoneNumber.md

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

data/docs/SortIdUpdatedAt.md

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

data/docs/SortListAvailableNumbers.md

@@ -0,0 +1,10 @@
+# PhoneComClient::SortListAvailableNumbers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**internal** | **String** |  | [optional]
+**price** | **String** |  | [optional]
+**phone_number** | **String** |  | [optional]
+
+

data/docs/SortListPhoneNumbersRegions.md

@@ -0,0 +1,14 @@
+# PhoneComClient::SortListPhoneNumbersRegions
+
+## 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/SortNameNumber.md

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

data/docs/SubaccountPricingApi.md

@@ -0,0 +1,261 @@
+# PhoneComClient::SubaccountPricingApi
+
+All URIs are relative to *https://api.phone.com/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_subaccount_pricing**](SubaccountPricingApi.md#create_account_subaccount_pricing) | **POST** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing | Add a pricing plan to a subaccount.
+[**delete_account_subaccount_pricing**](SubaccountPricingApi.md#delete_account_subaccount_pricing) | **DELETE** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing/{pricing_id} | Delete a pricing plan from a subaccount.
+[**get_account_subaccount_pricing**](SubaccountPricingApi.md#get_account_subaccount_pricing) | **GET** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing/{pricing_id} | Get the details of a pricing plan for a subaccount.
+[**list_account_subaccount_pricing**](SubaccountPricingApi.md#list_account_subaccount_pricing) | **GET** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing | Get a list of pricing plans for a subaccount.
+
+
+# **create_account_subaccount_pricing**
+> PricingFull create_account_subaccount_pricing(account_id, subaccount_id, data)
+
+Add a pricing plan to a subaccount.
+
+Add a pricing plan to a subaccount. See Account Subaccount Pricing 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::SubaccountPricingApi.new
+
+account_id = 56 # Integer | Account ID
+
+subaccount_id = 56 # Integer | Subaccount ID
+
+data = PhoneComClient::CreatePricingParams.new # CreatePricingParams | Subaccount pricing data
+
+
+begin
+  #Add a pricing plan to a subaccount.
+  result = api_instance.create_account_subaccount_pricing(account_id, subaccount_id, data)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SubaccountPricingApi->create_account_subaccount_pricing: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **subaccount_id** | **Integer**| Subaccount ID |
+ **data** | [**CreatePricingParams**](CreatePricingParams.md)| Subaccount pricing data |
+
+### Return type
+
+[**PricingFull**](PricingFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_account_subaccount_pricing**
+> DeleteEntry delete_account_subaccount_pricing(account_id, subaccount_id, pricing_id)
+
+Delete a pricing plan from a subaccount.
+
+Delete a pricing plan from a subaccount. See Account Subaccount Pricing 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::SubaccountPricingApi.new
+
+account_id = 56 # Integer | Account ID
+
+subaccount_id = 56 # Integer | Subaccount ID
+
+pricing_id = 56 # Integer | Pricing Object ID
+
+
+begin
+  #Delete a pricing plan from a subaccount.
+  result = api_instance.delete_account_subaccount_pricing(account_id, subaccount_id, pricing_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SubaccountPricingApi->delete_account_subaccount_pricing: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **subaccount_id** | **Integer**| Subaccount ID |
+ **pricing_id** | **Integer**| Pricing Object ID |
+
+### Return type
+
+[**DeleteEntry**](DeleteEntry.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_account_subaccount_pricing**
+> PricingFull get_account_subaccount_pricing(account_id, subaccount_id, pricing_id)
+
+Get the details of a pricing plan for a subaccount.
+
+Get the details of a pricing plan for a subaccount. See Account Subaccount Pricing 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::SubaccountPricingApi.new
+
+account_id = 56 # Integer | Account ID
+
+subaccount_id = 56 # Integer | Subaccount ID
+
+pricing_id = 56 # Integer | Pricing Object ID
+
+
+begin
+  #Get the details of a pricing plan for a subaccount.
+  result = api_instance.get_account_subaccount_pricing(account_id, subaccount_id, pricing_id)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SubaccountPricingApi->get_account_subaccount_pricing: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **subaccount_id** | **Integer**| Subaccount ID |
+ **pricing_id** | **Integer**| Pricing Object ID |
+
+### Return type
+
+[**PricingFull**](PricingFull.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_account_subaccount_pricing**
+> ListPricings list_account_subaccount_pricing(account_id, subaccount_id, , opts)
+
+Get a list of pricing plans for a subaccount.
+
+Get a list of pricing plans for a subaccount. See Account Subaccount Pricing 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::SubaccountPricingApi.new
+
+account_id = 56 # Integer | Account ID
+
+subaccount_id = 56 # Integer | Subaccount 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 pricing plans for a subaccount.
+  result = api_instance.list_account_subaccount_pricing(account_id, subaccount_id, , opts)
+  p result
+rescue PhoneComClient::ApiError => e
+  puts "Exception when calling SubaccountPricingApi->list_account_subaccount_pricing: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **Integer**| Account ID |
+ **subaccount_id** | **Integer**| Subaccount 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
+
+[**ListPricings**](ListPricings.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+