faxplus_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 522e0a417cb9e97b26a73388d7369cfb9cf0cdf9ab4d69ef0e6f20f75f64a029
-  data.tar.gz: 502520063d90636f49deaee39b3f341ea9d4b516f67b8108e8a2f4a3b58d0412
+  metadata.gz: 4d7d5d99a832e5707096a02ae5209ea2984306a74d964345143acf573616fd9a
+  data.tar.gz: a049ba2bd56c73f3bdb6753a75cf73642128a916c750cc5519631e58bc5ee834
 SHA512:
-  metadata.gz: 0c60c55d502184d9e37acb42c7021ab08f33cfa82d46437645e905c7f814c78b8b5961ef0541b3f42c9ea98b1467ca86e16a4bd17d7a279185f2f7e669653199
-  data.tar.gz: af05b0b220a6118cbff131c7268bfb1754b1e3545b8ad0892f0d198e5e1681344286696c01f80e3597794dd1e2f9c0100334c682833309fb11c6a15e30f469ca
+  metadata.gz: 4a4c22a9b6bfd8a1f0d1afa06202c65ebf04739ca43fe860047a29278641ad17c42579c6a850a151e1fcefcea045926586852199e815d432355e9f388d1e7b0f
+  data.tar.gz: 9f7e41ed1231cd4bd97d8a465fe670dd8062c6659695b5842c01fe251f96e2248ec2ed8df581b47f76b730101b47154bb264e533c7a465d7d7126c51a7399d7f

data/README.md

@@ -6,7 +6,7 @@ Faxplus is a Ruby library for interacting with faxplus APIs.
 To start using faxplus, you first need to add it to your Gemfile, with an entry such as this:
 
 ```ruby
-gem 'faxplus_ruby'
+gem 'faxplus_api'
 ```
 
 Afterwards, run `bundle install` 
@@ -43,7 +43,8 @@ client.fax.revoke(user_id: 'userid', fax_id: 'fax_id') # Delete a fax
 ## Files.
 
 ```ruby
-client.file.upload(user_id: 'userid') # Upload a file TODO: Need proper params how to send file
+# Upload a file
+client.file.upload(user_id: 'userid', data: {fax_file: File.open('pdf_file_path.pdf'), multipart: true}) => {:path => "/storage/transient-hsfhadhaskha.pdf"}
 client.file.get(user_id: 'userid', fax_id: 'fax_id') # Download fax file
 client.file.fax_report(user_id: 'userid', fax_id: 'fax_id') # Get fax confirmation report
 ```
@@ -51,8 +52,8 @@ client.file.fax_report(user_id: 'userid', fax_id: 'fax_id') # Get fax confirmati
 
 ```ruby
 client.outbox.list(user_id: 'userid') # List faxes in the outbox
-# TODO: require proper params here
-client.outbox.send(user_id: 'userid') # Send a fax 
+# file_path from the client.file.upload output path
+client.outbox.send(user_id: 'userid', data: {from: "+12345667", to: ["+12345688"], files: [file_path]}) # Send a fax 
 client.outbox.get(user_id: 'userid', outbox_fax_id: 'outbox_fax_id') # List outgoing faxes
 client.outbox.update(user_id: 'userid', outbox_fax_id: 'outbox_fax_id') # Delete an outgoing fax
 client.outbox.delete(user_id: 'userid', outbox_fax_id: 'outbox_fax_id') # Modify an outgoing fax

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faxplus_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dilkhush Soni
@@ -52,7 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.6
-description: 
+description: |2
+    A simple wrapper around faxplus's API.
+    For detailed documentation, please visit: https://github.com/dilkhush/faxplus-ruby/blob/main/README.md
 email:
 - dilkhushsoni2010@gmail.com
 executables: []