lib/phaxio/client.rb in phaxio-0.3.1 vs lib/phaxio/client.rb in phaxio-0.4.0

@@ -63,11 +63,10 @@
     #   Phaxio.send_fax(to: "0123456789", filename: "test.pdf")
     #
     # Returns a HTTParty::Response object containing a success bool,
     # a String message, and an in faxID.
     def send_fax(options)
-      options.merge!({api_key: api_key, api_secret: api_secret})
       send_post("/send", options)
     end
 
     # Public: Test receiving a fax.
     #
@@ -84,14 +83,113 @@
     #   Phaxio.test_receive(filename: "test_file.pdf")
     #
     # Returns a HTTParty::Response object containing a success bool
     # and a String message.
     def test_receive(options)
-      options.merge!({api_key: api_key, api_secret: api_secret})
       send_post("/testReceive", options)
     end
 
+    # Public: Provision a phone number that you can use to receive faxes in
+    #         your Phaxio account.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           area_code    - The integer area code of the number you'd like
+    #                          to provision (required).
+    #           callback_url - A callback URL that Phaxio will post to when a
+    #                          fax is received by this number. This will
+    #                          override the global receive callback URL, if you
+    #                          have one set (optional).
+    #
+    # Examples
+    #
+    #   Phaxio.provision_number(area_code: 802)
+    #
+    # Returns a HTTParty::Response object containing a success bool, a string
+    # message, and data containing the phone number, city, state, cost,
+    # last_billed_at, and the date the number was provisioned at.
+    def provision_number(options)
+      send_post("/provisionNumber", options)
+    end
+
+    # Public: Release a phone number that you no longer need. Once a phone
+    #         number is released you will no longer be charged for it.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           number - The String of the phone number you want to release
+    #                    (required).
+    #
+    # Examples
+    #
+    #   Phaxio.release_number(number: "8021112222")
+    #
+    # Returns a HTTParty::Response object containing a success bool and a
+    # string message.
+    def release_number(options)
+      send_post("/releaseNumber", options)
+    end
+
+    # Public: Get a detailed list of the phone numbers you current own on
+    #         Phaxio.
+    #
+    # options - The Hash options used to refne th selection (default: {}):
+    #           area_code - An integer area code you'd like to filter by 
+    #                       (optional).
+    #           number    - A String phone number you'd like to retrieve
+    #                       (optional).
+    #
+    # Examples
+    #
+    #   Phaxio.list_numbers # list all the numbers you own
+    #
+    #   Phaxio.list_numbers(area_code: 802) # list all numbers in the 802 area
+    #
+    #   Phaxio.list_numbers(number: "8021112222") # show specific number detail
+    #
+    # Returns a HTTParty::Reponse object containing a success bool, a message,
+    # and the data attributes containing the queried phone number(s) details.
+    def list_numbers(options = {})
+      send_post("/numberList", options)
+    end
+
+    # Public: Get an image thumbnail or PDF file for a fax. For images to work
+    #         file storage must not be disabled with Phaxio.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           id   - The integer fax id of the fax you wish to retreive
+    #                  (required).
+    #           type - An enum for the type return, defaults to 'p' (optional):
+    #                  s - Small JPG format thumbnail of the fax, 129 x 167 px.
+    #                  l - Large JPG format thumbnail of the fax, 300 x 388 px.
+    #                  p - PDF version of the fax (default).
+    #
+    # Examples
+    #
+    #   Phaxio.get_fax_file(id: 1234, type: p)
+    #   Phaxio.get_fax_file(id: 3254, type: l)
+    #
+    # Returns the fax as the type specified in the call, defaults to PDF.
+    def get_fax_file(options)
+      send_post("/faxFile", options)
+    end
+
+    # Public: List faxes within the specified time range.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           start - The Unix Timestamp for the beginning of the range
+    #                   (required).
+    #           end   - The Unix Timestamp for the end of the range (required).
+    #
+    # Examples
+    #
+    #   Phaxio.list_faxes(start: 1293861600, end: 1294034400)
+    #
+    # Returns a HTTParty::Response object containing a success bool, a string
+    # message, paging information, and the fax data.
+    def list_faxes(options)
+      send_post("/faxList", options)
+    end
+
     # Public: Get the status of a specific fax.
     #
     # options - The Hash options used to refine the selection (default: {}):
     #           id - The int id of the fax you want to get the status of
     #                (required).
@@ -105,11 +203,10 @@
     def get_fax_status(options)
       if options[:id].nil?
         raise StandardError, "You must include a fax id."
       end
 
-      options.merge!({api_key: api_key, api_secret: api_secret})
       send_post("/faxStatus", options)
     end
 
     # Public: Cancel a specific fax.
     #
@@ -121,10 +218,9 @@
     #   Phaxio.cancel_fax(id: "123456")
     #
     # Returns a HTTParty::Response object containing a success bool
     # and a String message.
     def cancel_fax(options)
-      options.merge!({api_key: api_key, api_secret: api_secret})
       send_post("/faxCancel", options)
     end
 
     # Public: Get the status of Client's account.
     #