Merge pull request #34 from yujideveloper/update-api-reference-link-for-v2.1

Update the link to the API reference for v2.1

Author: jnankin

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
 

lib/phaxio/resources/account.rb

@@ -22,7 +22,7 @@ class << self
         #   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

lib/phaxio/resources/callback.rb

@@ -1,8 +1,8 @@
 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
+    # @see https://www.phaxio.com/docs/api/v2.1/faxes/send_webhook
+    # @see https://www.phaxio.com/docs/api/v2.1/faxes/receive_webhooks
     class Callback
       DIGEST = OpenSSL::Digest.new('sha1')
       private_constant :DIGEST

lib/phaxio/resources/fax.rb

@@ -120,7 +120,7 @@ class << self
         # @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 @@ def list params = {}
         # @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 @@ def create params = {}
         #   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 @@ def get id, params = {}
         # @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 @@ def cancel id, params = {}
         # @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 @@ def resend id, params = {}
         #   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 @@ def delete id, params = {}
         #   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 @@ def delete_file id, params = {}
         # @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 @@ def file id, params = {}
         #     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

lib/phaxio/resources/phax_code.rb

@@ -28,7 +28,7 @@ class << self
         #     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 @@ def create params = {}
         #     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)

lib/phaxio/resources/phone_number.rb

@@ -44,7 +44,7 @@ class << self
         #   - *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,7 +58,7 @@ def create params = {}
         #   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_record response
@@ -76,7 +76,7 @@ def get phone_number, params = {}
         # @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 +90,7 @@ def list params = {}
         #   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

lib/phaxio/resources/public/area_code.rb

@@ -46,7 +46,7 @@ class << self
           # @return [Phaxio::Resource::Collection<Phaxio::Resources::AreaCode>] A collection of
           #   AreaCode objects.
           # @raise [Phaxio::Error::PhaxioError]
-          # @see https://www.phaxio.com/docs/api/v2/public/list_area_codes
+          # @see https://www.phaxio.com/docs/api/v2.1/public/list_area_codes
           def list params = {}
             response = Client.request :get, available_area_codes_endpoint, params
             AreaCode.response_collection response

lib/phaxio/resources/public/country.rb

@@ -36,7 +36,7 @@ class << self
           # @return [Phaxio::Resource::Collection<Phaxio::Resources::Country>]
           #   A collection of supported countries.
           # @raise Phaxio::Error::PhaxioError
-          # @see https://www.phaxio.com/docs/api/v2/public/list_countries
+          # @see https://www.phaxio.com/docs/api/v2.1/public/list_countries
           def list params = {}
             response = Client.request :get, supported_countries_endpoint, params
             Country.response_collection response