README.md in phaxio-0.3.1 vs README.md in phaxio-0.4.0

- old
+ new

@@ -1,11 +1,11 @@ # Phaxio A Ruby gem for interacting with the [Phaxio API]( https://www.phaxio.com/docs ). +**Note: This gem only runs on Ruby version 1.9.+** - ## Installation Add this line to your application's Gemfile: gem 'phaxio' @@ -33,12 +33,19 @@ ### Currently Supported API Calls * send_fax - `Phaxio.send_fax(to: "0123456789", filename: "test.pdf")` * test_receive - `Phaxio.test_receive(filename: "test_file.pdf")` -* get_fax_status - `Phaxio.get_fax_status(id: "123456")` -* cancel_fax - `Phaxio.cancel_fax(id: "123456")` +* provision_number - `Phaxio.provision_number(area_code: 802)` +* release_number - `Phaxio.release_number(number: "8021112222")` +* list_numbers - `Phaxio.list_numbers(area_code: 802)` +* get_fax_file - `Phaxio.get_fax_file(id: 123456, type: p)` +* list_faxes - `Phaxio.list_numbers(area_code: 802)` +* list_faxes - `Phaxio.list_faxes(start: Time.now - 48000, +end: Time.now)` +* get_fax_status - `Phaxio.get_fax_status(id: 123456)` +* cancel_fax - `Phaxio.cancel_fax(id: 123456)` * get_account_status - `Phaxio.get_account_status` ### Example require 'phaxio' @@ -48,9 +55,15 @@ config.api_secret = "your_secret" end @fax = Phaxio.send_fax(to: '15555555555', string_data: "hello world") Phaxio.get_fax_status(id: @fax["faxId"]) + + # Get a Fax and save it as a PDF + @pdf = Phaxio.get_fax_file(id: @fax["faxId"], type: "p") + File.open("received_test.pdf", "w") do |file| + file << @pdf + end ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)