phaxio 2.1.0.pre → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f20cd3d8695312c8b64cf40cc01b8fe0e320b921a3527abc1ca005a9d140b11
-  data.tar.gz: '088662055ff2bd6ebbeb5055ad7316bd6d99acf9a93249383d9ad1aa08133a4b'
+  metadata.gz: 508fcbe635de23974bfdefe06aec6811fd7f91bd03377dd4a90b971cd1b6a44f
+  data.tar.gz: e33347de232350332fe604ecae8c0f511a3774fb9ef7c863f6a269bb53bad787
 SHA512:
-  metadata.gz: 99cfc91fefd07016507eb20049f5c7afeca903d2c227941bcd55a1cd14913faa1b03e69a2ceea1798da457bf338a48e5ad7c212f107aba598378965210a0d24a
-  data.tar.gz: cf3b858ff97a2b005f50a21709ee524fd20b6fc12080a59a48d57842b9e295f18de91a20f48ba5f9f1b64d632e5a38d7d375b0af8e323cea2232df49421deb93
+  metadata.gz: 6a041ed3d71f144ae2c2776a69be5d947982f1eb76c2a2e748f07b245d48ac8714c9199702b71a9b8c0cd404ea6318518834cb9da9365f569cc6b35633c66e83
+  data.tar.gz: d50baaa1fc873a3a20268fb0c56d1b902d0b922d8fcdb731d40e23d89c74bd9c6fea3e35aa66e8c7472502b5af7ac1ad060b5cec22d3fe244e816d98d9be10d5

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/phaxio/phaxio-ruby.svg?branch=master)](https://travis-ci.org/phaxio/phaxio-ruby)
 
-A Ruby gem for interacting with the [Phaxio API](https://www.phaxio.com/docs/api/v2).
+A Ruby gem for interacting with the [Phaxio API](https://www.phaxio.com/docs/api/v2.1).
 
 ## Installation
 
@@ -26,14 +26,14 @@ $ gem install phaxio
 
 ## Usage
 
-Set up your API Key, API Secret, and, optionally, Callback Token.
+Set up your API Key, API Secret, and, optionally, Webhook Token.
 
 ``` ruby
 require 'phaxio'
 
 Phaxio.api_key = '11111'
 Phaxio.api_secret = '22222'
-Phaxio.callback_token = '33333'
+Phaxio.webhook_token = '33333'
 ```
 
 Try sending a fax:
@@ -243,32 +243,32 @@ Account.get
 # => Account(balance: 1000, faxes_today: 0, faxes_this_month: 100)
 ```
 
-#### Callback
+#### Webhook
 
-##### `Callback.valid_signature?`
+##### `Webhook.valid_signature?`
 
-Validate the callback signature sent with a Phaxio callback. Requires that Phaxio.callback_token be
+Validate the webhook signature sent with a Phaxio webhook. Requires that Phaxio.webhook_token be
 set.
 
 ``` ruby
-Callback.valid_signature? received_signature, callback_url, received_params, received_files
+Webhook.valid_signature? received_signature, webhook_url, received_params, received_files
 # => true
 ```
 
-## Callback Validation Example with Sinatra
+## Webhook Validation Example with Sinatra
 
 ``` ruby
 require 'sinatra/base'
 require 'phaxio'
 
 class PhaxioWebhookExample < Sinatra::Base
-  Phaxio.callback_token = 'YOUR WEBHOOK TOKEN HERE'
-  
+  Phaxio.webhook_token = 'YOUR WEBHOOK TOKEN HERE'
+
   post '/webhook' do
     signature = request.env['HTTP_X_PHAXIO_SIGNATURE']
     url = request.url
     file_params = params[:file]
-    if Phaxio::Callback.valid_signature? signature, url, webhook_params, file_params
+    if Phaxio::Webhook.valid_signature? signature, url, webhook_params, file_params
       'Success'
     else
       'Invalid webhook signature'
@@ -289,22 +289,22 @@ end
 class WebhookController < ApplicationController
   skip_before_action :verify_authenticity_token
 
-	def index
+  def index
     signature = request.headers['X-Phaxio-Signature']  
-    Phaxio.callback_token = 'YOUR WEBHOOK TOKEN HERE'
+    Phaxio.webhook_token = 'YOUR WEBHOOK TOKEN HERE'
     url = request.original_url
 
     Rails.logger.debug "URL: " + url
     Rails.logger.debug "Signature: " + signature
     Rails.logger.debug "params: " + params.inspect
     Rails.logger.debug "webhook_params: " + webhook_params.to_h.inspect
-    
-    if Phaxio::Callback.valid_signature? signature, url, webhook_params.to_h, file_params
+
+    if Phaxio::Webhook.valid_signature? signature, url, webhook_params.to_h, file_params
       Rails.logger.debug "Success"
       render plain: 'Success'
     else
-      Rails.logger.debug "Invalid callback signature"
-      render plain: 'Invalid callback signature'
+      Rails.logger.debug "Invalid webhook signature"
+      render plain: 'Invalid webhook signature'
     end
   end
 

data/lib/phaxio/client.rb

@@ -44,10 +44,6 @@ module Phaxio
           conn.request :multipart
           conn.request :url_encoded
           conn.adapter :net_http
-
-          if Phaxio.api_key && Phaxio.api_secret
-            conn.basic_auth Phaxio.api_key, Phaxio.api_secret
-          end
         end
       end
 
@@ -153,8 +149,8 @@ module Phaxio
       end
 
       def api_headers params
-        api_key    = params[:api_key]    || Phaxio.api_key
-        api_secret = params[:api_secret] || Phaxio.api_secret
+        api_key    = params.delete(:api_key)    || Phaxio.api_key
+        api_secret = params.delete(:api_secret) || Phaxio.api_secret
         return unless api_key && api_secret
         auth = Base64.strict_encode64("#{api_key}:#{api_secret}")
         {'Authorization' => "Basic #{auth}"}

data/lib/phaxio/config.rb

@@ -13,14 +13,16 @@ module Phaxio
       # To find your API secret, visit https://console.phaxio.com/api_credentials
       attr_accessor :api_secret
 
-      # Your Phaxio callback token. This will be used to verify that callback requests are coming
+      # Your Phaxio webhook token. This will be used to verify that webhook requests are coming
       # from Phaxio.
       #
-      # To find your callback token, visit https://console.phaxio.com/user/callbacks/edit
-      attr_accessor :callback_token
+      # To find your webhook token, visit https://console.phaxio.com/user/callbacks/edit
+      attr_accessor :webhook_token
+      alias callback_token webhook_token
+      alias callback_token= webhook_token=
 
       # The Phaxio API endpoint. Users generally shouldn't need to change it.
-      # Defaults to https://api.phaxio.com/v2/
+      # Defaults to https://api.phaxio.com/v2.1/
       attr_writer :api_endpoint
 
       def api_endpoint

data/lib/phaxio/resource.rb

@@ -139,12 +139,18 @@ module Phaxio
       #
       # @see Phaxio::Resource.response_collection
       def initialize response_data, resource
-        if response_data.key? 'paging'
-          self.total = response_data['paging']['total']
-          self.per_page = response_data['paging']['per_page']
-          self.page = response_data['paging']['page']
+        # For some endpoints we'll get a hash with `paging` and `data` attributes.
+        # For others, just an array.
+        if response_data.is_a? Hash
+          if response_data.key? 'paging'
+            self.total = response_data['paging']['total']
+            self.per_page = response_data['paging']['per_page']
+            self.page = response_data['paging']['page']
+          end
+          self.raw_data = response_data['data']
+        else
+          self.raw_data = response_data
         end
-        self.raw_data = response_data['data']
         self.collection = raw_data.map { |record_data| resource.response_record record_data }
       end
 

data/lib/phaxio/resources/account.rb

@@ -22,7 +22,7 @@ module Phaxio
         #   Any parameters to send to Phaxio. This action does not have any unique parameters.
         # @return [Phaxio::Resources::Acount] Your account information.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/account/status
+        # @see https://www.phaxio.com/docs/api/v2.1/account/status
         def get params = {}
           response = Client.request :get, account_status_endpoint, params
           response_record response

data/lib/phaxio/resources/ata.rb

@@ -20,14 +20,37 @@ module Phaxio
       # @return [String] The domain for the ATA.
       # @!attribute domain
 
+      # @return [String] The user agent for the ATA.
+      # @!attribute user_agent
+
+      # @return [String] The SIP URI for the ATA.
+      # @!attribute sip_uri
+
+      # @return [String] The mac address for the ATA.
+      # @!attribute mac_address
+
+      # @return [String] The name of the group which the ATA belongs to.
+      # @!attribute group
+
       # @return [String] The username for the ATA.
-      # @!attribute uername
+      # @!attribute username
 
       # @return [String] The password for the ATA.
       # @!attribute password
 
       has_normal_attributes %w[
-        id name description user_phone_number domain username password
+        id name description user_phone_number domain user_agent sip_uri
+        mac_address group username password
+      ]
+
+      # @return [Time] The time at which the ATA was last registered.
+      # @!attribute last_registered
+
+      # @return [Time] The time at which the ATA's registration expires.
+      # @!attribute expiry_time
+
+      has_time_attributes %w[
+        last_registered expiry_time
       ]
 
       # A reference to an ATA. This is returned by certain actions which don't
@@ -41,6 +64,14 @@ module Phaxio
           id
         end
 
+        # Gets the referenced ATA.
+        # @return [Phaxio::Resources::ATA]
+        def get
+          Ata.get self
+        end
+        alias :retrieve :get
+        alias :find :get
+
         private
 
         def initialize id
@@ -48,21 +79,33 @@ module Phaxio
         end
       end
 
-      # A reference to a phone number, returned by ATA phone number management
-      # actions.
-      class PhoneNumberReference
-        # @return [String]
-        #   The phone number.
-        attr_accessor :phone_number
+      # A set of provisioning URLs.
+      class ProvisioningURLs
+        # @return [Hash<String: String>] The hash of provisioning URLs. 
+        # @!attribute urls
+        attr_reader :urls
+
+        GRANDSTREAM = 'Grandstream'
+        OBI = 'OBi'
+        NETGEN = 'Netgen'
 
-        def to_s
-          phone_number
+        def initialize data
+          @urls = data
         end
 
-        private
+        # @return [String] The Grandstream provisioning url.
+        def grandstream
+          self.urls.fetch(GRANDSTREAM)
+        end
+
+        # @return [String] The OBi provisioning url.
+        def obi
+          self.urls.fetch(OBI)
+        end
 
-        def initialize phone_number
-          self.phone_number = phone_number
+        # @return [String] The Netgen provisioning url.
+        def netgen
+          self.urls.fetch(NETGEN)
         end
       end
 
@@ -86,6 +129,7 @@ module Phaxio
         #   - *name* [String] - A name used to identify the ATA.
         #   - *description* [String] - A longer description of the ATA.
         #   - *domain* [String] - A domain for the ATA.
+        #   - *mac_address* [String] - A mac address for the ATA.
         # @return [Phaxio::Resources::Ata]
         #   The created ATA, including the generated username and password.
         # @raise [Phaxio::Error::PhaxioError]
@@ -99,7 +143,9 @@ module Phaxio
         # @param id [Integer]
         #   The ID of the ATA to retrieve information about.
         # @param params [Hash]
-        #   Any parameters to send to Phaxio. This action takes no unique parameters.
+        #   Any parameters to send to Phaxio.
+        #   - *with_credentials* [Boolean] - If enabled, the username and
+        #     password for the ATA will be included in the response.
         # @return [Phaxio::Resources::Ata]
         #   The requested ATA.
         # @raise [Phaxio::Error::PhaxioError]
@@ -118,7 +164,7 @@ module Phaxio
         #   Any parameters to send to Phaxio.
         #   - *name* [String] - A name used to identify the ATA.
         #   - *description* [String] - A longer description of the ATA.
-        #   - *domain* [String] - A domain for the ATA.
+        #   - *mac_address* [String] - A mac address for the ATA.
         # @return [Phaxio::Resources::Ata]
         #   The updated ATA.
         # @raise [Phaxio::Error::PhaxioError]
@@ -144,7 +190,7 @@ module Phaxio
 
         # Delete an ATA
         # @param id [Integer]
-        #   The Id of the ATA to delete.
+        #   The ID of the ATA to delete.
         # @param params [Hash]
         #   Any parameters to send to Phaxio. This action takes no unique parameters.
         # @return [Phaxio::Resources::Ata::Reference]
@@ -163,7 +209,7 @@ module Phaxio
         #   The phone number to add to the ATA.
         # @param params [Hash]
         #   Any parameters to send to Phaxio. This action takes no unique parameters.
-        # @return [Phaxio::Resources::Ata::PhoneNumberReference]
+        # @return [Phaxio::Resources::PhoneNumber::Reference]
         #   A reference to the added phone number.
         # @raise [Phaxio::Error::PhaxioError]
         # @see https://www.phaxio.com/docs/api/v2.1/atas/add_phone_number
@@ -179,7 +225,7 @@ module Phaxio
         #   The phone number you want to remove.
         # @param params [Hash]
         #   Any parameters to send to Phaxio. This action takes no unique parameters.
-        # @return [Phaxio::Resources::Ata::PhoneNumberReference]
+        # @return [Phaxio::Resources::PhoneNumber::Reference]
         #   A reference to the removed phone number.
         # @raise [Phaxio::Error::PhaxioError]
         # @see https://www.phaxio.com/docs/api/v2.1/atas/remove_phone_number
@@ -188,6 +234,18 @@ module Phaxio
           response_phone_number_reference response
         end
 
+        # Get ATA provisioning URLs for your Phaxio account.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio.
+        #   - *group* [String] - If given, this action instead returns
+        #     provisioning URLs for the named group.
+        # @return [Phaxio::Resources::Ata::ProvisioningURLs
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/provisioning_urls
+        def provisioning_urls params = {}
+          response = Client.request :get, provisioning_urls_endpoint, params
+          response_provisioning_urls response
+        end
+
         private
 
         def response_reference response
@@ -195,7 +253,11 @@ module Phaxio
         end
 
         def response_phone_number_reference response
-          PhoneNumberReference.new(response['phone_number'])
+          PhoneNumber::Reference.new(response['phone_number'])
+        end
+
+        def response_provisioning_urls response
+          ProvisioningURLs.new(response)
         end
 
         def atas_endpoint
@@ -213,6 +275,10 @@ module Phaxio
         def phone_number_endpoint id, phone_number
           "#{ata_endpoint(id)}/phone_numbers/#{phone_number}"
         end
+
+        def provisioning_urls_endpoint
+          "#{atas_endpoint}/provisioning_urls"
+        end
       end
     end
   end

data/lib/phaxio/resources/callback.rb

@@ -1,63 +1,17 @@
 module Phaxio
   module Resources
-    # Provides utilities for working with callbacks.
-    # @see https://www.phaxio.com/docs/api/v2/faxes/send_callback
-    # @see https://www.phaxio.com/docs/api/v2/faxes/receive_callback
+    # This class is provided for the sake of backwards compatibility; use the Webhook resource instead.
+    # @see Phaxio::Resources::Webhook
     class Callback
-      DIGEST = OpenSSL::Digest.new('sha1')
-      private_constant :DIGEST
-
       class << self
-        # Determines whether or not the passed signature is valid for the given
-        # url, params, and files.
-        # @param signature [String]
-        #   The signature received from Phaxio.
-        # @param url [String]
-        #   The callback URL used in this request.
-        # @param params [Hash]
-        #   The parameters received with the callback, excluding files.
-        # @param files [Array<File>]
-        #   The files received with the callback, if any.
-        # @return [true, false]
-        # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/security/callbacks
-        def valid_signature? signature, url, params, files = []
-          check_signature = generate_check_signature url, params, files
-          check_signature == signature
-        end
-
-        private
-
-        def generate_check_signature url, params, files = []
-          params_string = generate_params_string(params)
-          files_string = generate_files_string(files)
-          callback_data = "#{url}#{params_string}#{files_string}"
-          OpenSSL::HMAC.hexdigest(DIGEST, callback_token, callback_data)
-        end
-
-        def callback_token
-          Phaxio.callback_token or raise(Error::PhaxioError, 'No callback token has been set')
-        end
-
-        def generate_params_string(params)
-          sorted_params = params.sort_by { |key, _value| key }
-          params_strings = sorted_params.map { |key, value| "#{key}#{value}" }
-          params_strings.join
-        end
-
-        def generate_files_string(files)
-          files_array = files_to_array(files).reject(&:nil?)
-          sorted_files = files_array.sort_by { |file| file[:name] }
-          files_strings = sorted_files.map { |file| generate_file_string(file) }
-          files_strings.join
-        end
-
-        def files_to_array(files)
-          files.is_a?(Array) ? files : [files]
-        end
-
-        def generate_file_string(file)
-          file[:name] + DIGEST.hexdigest(file[:tempfile].read)
+        def valid_signature? *args
+          Phaxio::Resources::Webhook.valid_signature? *args
+        rescue Error::PhaxioError => error
+          if error.message == 'No webhook token has been set'
+            raise Error::PhaxioError, 'No callback token has been set'
+          else
+            raise error
+          end
         end
       end
     end

data/lib/phaxio/resources/fax.rb

@@ -84,7 +84,7 @@ module Phaxio
         attr_accessor :id
 
         # Gets the referenced fax.
-        # @return [Phaxio::Resource::Fax]
+        # @return [Phaxio::Resources::Fax]
         #   The referenced Fax.
         def get
           Fax.get self
@@ -120,7 +120,7 @@ module Phaxio
         # @return [Phaxio::Resource::Collection<Phaxio::Resources::Fax>]
         #   The collection of faxes matching your request.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/list_faxes
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/list_faxes
         def list params = {}
           response = Client.request :get, faxes_endpoint, params
           response_collection response
@@ -159,8 +159,8 @@ module Phaxio
         # @return [Phaxio::Resources::Fax]
         #   The created fax.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/create_and_send_fax
-        # @see https://www.phaxio.com/docs/api/v2/faxes/batching
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/create_and_send_fax
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/batching
         def create params = {}
           response = Client.request :post, faxes_endpoint, params
           response_reference response
@@ -174,7 +174,7 @@ module Phaxio
         #   A hash of parameters to send to Phaxio. This action takes no unique parameters.
         # @return [Phaxio::Resource::Fax] The requested fax.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/get_fax
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/get_fax
         def get id, params = {}
           response = Client.request :get, fax_endpoint(id.to_i), params
           response_record response
@@ -191,7 +191,7 @@ module Phaxio
         # @return [Phaxio::Resources::Fax::Reference]
         #   A reference to the canceled fax.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/cancel
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/cancel
         def cancel id, params = {}
           response = Client.request :post, cancel_fax_endpoint(id), params
           response_reference response
@@ -207,7 +207,7 @@ module Phaxio
         # @return [Phaxio::Resources::Fax::Reference]
         #   A reference to the resent fax.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/resend
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/resend
         def resend id, params = {}
           response = Client.request :post, resend_fax_endpoint(id), params
           response_reference response
@@ -221,7 +221,7 @@ module Phaxio
         #   parameters.
         # @return [true]
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/delete_fax
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/delete_fax
         def delete id, params = {}
           Client.request :delete, fax_endpoint(id), params
           true
@@ -235,7 +235,7 @@ module Phaxio
         #   parameters.
         # @return [true]
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/delete_fax_file
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/delete_fax_file
         def delete_file id, params = {}
           Client.request :delete, fax_file_endpoint(id), params
           true
@@ -252,7 +252,7 @@ module Phaxio
         # @return [File]
         #   The requested fax file.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/get_fax_file
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/get_fax_file
         def file id, params = {}
           Client.request :get, fax_file_endpoint(id), params
         end
@@ -269,7 +269,7 @@ module Phaxio
         #     number. Default is the public Phaxio phone number.
         # @return [true]
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/faxes/test_receive
+        # @see https://www.phaxio.com/docs/api/v2.1/faxes/test_receive
         def test_receive params = {}
           Client.request :post, faxes_endpoint, test_receive_params(params)
           true

data/lib/phaxio/resources/phax_code.rb

@@ -28,7 +28,7 @@ module Phaxio
         #     file instead of a PhaxCode object.
         # @return [Phaxio::Resources::PhaxCode | File] The created PhaxCode
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/phaxcodes/create_phax_code
+        # @see https://www.phaxio.com/docs/api/v2.1/phaxcodes/create_phax_code
         def create params = {}
           endpoint = case (params[:type] || params['type']).to_s
             when 'png' then phax_codes_endpoint_png
@@ -48,7 +48,7 @@ module Phaxio
         #     PhaxCode object.
         # @return [Phaxio::Resources::PhaxCode | File]
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/phaxcodes/retrieve_phax_code
+        # @see https://www.phaxio.com/docs/api/v2.1/phaxcodes/retrieve_phax_code
         def get params = {}
           identifier = params[:identifier] || params['identifier']
           endpoint = case (identifier)

data/lib/phaxio/resources/phone_number.rb

@@ -33,6 +33,32 @@ module Phaxio
 
       has_time_attributes %w(provisioned_at last_billed_at)
 
+      # A reference to a phone number, returned by some actions.
+      class Reference
+        # @return [String]
+        #   The phone number in E.164 format.
+        attr_accessor :phone_number
+
+        def to_s
+          phone_number
+        end
+
+        # Gets the referenced phone number.
+        # @return [Phaxio::Resources::PhoneNumber]
+        #   The referenced phone number.
+        def get
+          PhoneNumber.get self
+        end
+        alias :retrieve :get
+        alias :find :get
+
+        private
+
+        def initialize phone_number
+          self.phone_number = phone_number
+        end
+      end
+
       private
 
       class << self
@@ -44,7 +70,7 @@ module Phaxio
         #   - *callback_url* [String] - A callback URL that we'll post to when a fax is received by this number. This will override the global receive callback URL, if you have one specified.
         # @return [Phaxio::Resources::PhoneNumber] The newly provisioned number.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/phone_numbers/provision
+        # @see https://www.phaxio.com/docs/api/v2.1/phone_numbers/provision
         def create params = {}
           response = Client.request :post, phone_numbers_endpoint, params
           response_record response
@@ -58,9 +84,9 @@ module Phaxio
         #   A hash of parameters to send to Phaxio. This action has no unique parameters.
         # @return [Phaxio::Resources::PhoneNumber] The requested number.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/phone_numbers/get_number
+        # @see https://www.phaxio.com/docs/api/v2.1/phone_numbers/get_number
         def get phone_number, params = {}
-          response = Client.request :get, phone_number_endpoint(phone_number), params
+          response = Client.request :get, phone_number_endpoint(phone_number.to_s), params
           response_record response
         end
         alias :find :get
@@ -76,7 +102,7 @@ module Phaxio
         # @return [Phaxio::Resource::Collection<Phaxio::Resources::PhoneNumber>]
         #   A collection of phone numbers.
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/phone_numbers/list
+        # @see https://www.phaxio.com/docs/api/v2.1/phone_numbers/list
         def list params = {}
           response = Client.request :get, phone_numbers_endpoint, params
           response_collection response
@@ -90,7 +116,7 @@ module Phaxio
         #   A hash of parameters to send to Phaxio. This action has no unique parameters.
         # @return true
         # @raise [Phaxio::Error::PhaxioError]
-        # @see https://www.phaxio.com/docs/api/v2/phone_numbers/release
+        # @see https://www.phaxio.com/docs/api/v2.1/phone_numbers/release
         def delete phone_number, params = {}
           Client.request :delete, phone_number_endpoint(phone_number), params
           true