phone_com_client

PhoneComClient - the Ruby gem for the Phone.com API

This is a Phone.com api PhoneCom definition

This SDK is automatically generated by the PhoneCom Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

To build the Ruby code into a gem:

gem build phone_com_client.gemspec

Then either install the gem locally:

gem install ./phone_com_client-1.0.0.gem

(for development, run gem install --dev ./phone_com_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'phone_com_client', '~> 1.0.0'

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'phone_com_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# 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::AccountsApi.new

account_id = 56 # Integer | Account ID


begin
  #Retrieve details of an individual account
  result = api_instance.get_account(account_id, )
  p result
rescue PhoneComClient::ApiError => e
  puts "Exception when calling AccountsApi->get_account: #{e}"
end

All URIs are relative to https://api.phone.com/v4

• PhoneComClient::AccountFull
• PhoneComClient::AccountSummary
• PhoneComClient::Address
• PhoneComClient::AddressListContacts
• PhoneComClient::ApplicationFull
• PhoneComClient::ApplicationSummary
• PhoneComClient::AvailableNumbersFull
• PhoneComClient::CallDetails
• PhoneComClient::CallFull
• PhoneComClient::CallLogFull
• PhoneComClient::CallNotifications
• PhoneComClient::CallbackObject
• PhoneComClient::CallerIdFull
• PhoneComClient::CallerIdPhoneNumber
• PhoneComClient::ContactAccount
• PhoneComClient::ContactFull
• PhoneComClient::ContactResponse
• PhoneComClient::ContactSummary
• PhoneComClient::CreateCallParams
• PhoneComClient::CreateContactParams
• PhoneComClient::CreateDeviceParams
• PhoneComClient::CreateExtensionParams
• PhoneComClient::CreateGroupParams
• PhoneComClient::CreateListenerParams
• PhoneComClient::CreateMediaParams
• PhoneComClient::CreateMenuParams
• PhoneComClient::CreateOauthParams
• PhoneComClient::CreatePaymentParams
• PhoneComClient::CreatePhoneNumberParams
• PhoneComClient::CreatePricingParams
• PhoneComClient::CreateQueueParams
• PhoneComClient::CreateRedirectUriParams
• PhoneComClient::CreateRouteParams
• PhoneComClient::CreateSmsParams
• PhoneComClient::CreateSubaccountParams
• PhoneComClient::CreateTrunkParams
• PhoneComClient::DeleteEntry
• PhoneComClient::DeviceFull
• PhoneComClient::DeviceMembership
• PhoneComClient::DeviceSummary
• PhoneComClient::Email
• PhoneComClient::ExpressServiceCodeFull
• PhoneComClient::ExtensionFull
• PhoneComClient::ExtensionSummary
• PhoneComClient::FilterCallLogs
• PhoneComClient::FilterIdArray
• PhoneComClient::FilterIdDirectionFrom
• PhoneComClient::FilterIdExtensionNameArray
• PhoneComClient::FilterIdGroupIdUpdatedAtArray
• PhoneComClient::FilterIdNameArray
• PhoneComClient::FilterIdNamePhoneNumberArray
• PhoneComClient::FilterListAvailableNumbers
• PhoneComClient::FilterListPhoneNumbersRegions
• PhoneComClient::FilterNameNumberArray
• PhoneComClient::FilterVoicemailArray
• PhoneComClient::FromObject
• PhoneComClient::GetOauthAccessToken
• PhoneComClient::Greeting
• PhoneComClient::GreetingInput
• PhoneComClient::GroupFull
• PhoneComClient::GroupListContacts
• PhoneComClient::GroupSummary
• PhoneComClient::HoldMusic
• PhoneComClient::Line
• PhoneComClient::ListAccounts
• PhoneComClient::ListApplications
• PhoneComClient::ListAvailableNumbers
• PhoneComClient::ListCallLogs
• PhoneComClient::ListCallerIds
• PhoneComClient::ListContacts
• PhoneComClient::ListDevices
• PhoneComClient::ListExpressServiceCodes
• PhoneComClient::ListExtensions
• PhoneComClient::ListGroups
• PhoneComClient::ListListeners
• PhoneComClient::ListMedia
• PhoneComClient::ListMenus
• PhoneComClient::ListOauthClients
• PhoneComClient::ListOauthClientsRedirectUris
• PhoneComClient::ListPaymentMethods
• PhoneComClient::ListPhoneNumbers
• PhoneComClient::ListPhoneNumbersRegions
• PhoneComClient::ListPricings
• PhoneComClient::ListQueues
• PhoneComClient::ListRoutes
• PhoneComClient::ListSchedules
• PhoneComClient::ListSms
• PhoneComClient::ListTrunks
• PhoneComClient::ListVoicemail
• PhoneComClient::ListenerFull
• PhoneComClient::MediaFull
• PhoneComClient::MediaSummary
• PhoneComClient::Member
• PhoneComClient::MenuFull
• PhoneComClient::MenuSummary
• PhoneComClient::Notification
• PhoneComClient::OauthAccessToken
• PhoneComClient::OauthClientFull
• PhoneComClient::OauthClientRedirectUriFull
• PhoneComClient::Option
• PhoneComClient::PatchPaymentParams
• PhoneComClient::PatchSmsParams
• PhoneComClient::PatchVoicemailParams
• PhoneComClient::PaymentFull
• PhoneComClient::PaymentSummary
• PhoneComClient::PhoneNumberContact
• PhoneComClient::PhoneNumberFull
• PhoneComClient::PhoneNumbersRegionFull
• PhoneComClient::PingResponse
• PhoneComClient::PricingFull
• PhoneComClient::PricingObject
• PhoneComClient::QueueFull
• PhoneComClient::QueueSummary
• PhoneComClient::Recipient
• PhoneComClient::RedirectUriFull
• PhoneComClient::ReplaceExtensionParams
• PhoneComClient::ReplaceMenuParams
• PhoneComClient::ReplacePhoneNumberParams
• PhoneComClient::RouteFull
• PhoneComClient::RouteSummary
• PhoneComClient::RuleSet
• PhoneComClient::RuleSetAction
• PhoneComClient::RuleSetFilter
• PhoneComClient::RuleSetForwardItem
• PhoneComClient::ScheduleFull
• PhoneComClient::ScheduleSummary
• PhoneComClient::ScopeDetails
• PhoneComClient::SipAuthentication
• PhoneComClient::SmsForwarding
• PhoneComClient::SmsForwardingParams
• PhoneComClient::SmsFull
• PhoneComClient::SortCallLogs
• PhoneComClient::SortId
• PhoneComClient::SortIdCreatedAt
• PhoneComClient::SortIdExtensionName
• PhoneComClient::SortIdName
• PhoneComClient::SortIdNamePhoneNumber
• PhoneComClient::SortIdUpdatedAt
• PhoneComClient::SortListAvailableNumbers
• PhoneComClient::SortListPhoneNumbersRegions
• PhoneComClient::SortNameNumber
• PhoneComClient::TrunkFull
• PhoneComClient::TrunkSummary
• PhoneComClient::Voicemail
• PhoneComClient::VoicemailFull
• PhoneComClient::VoicemailInput

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header