waveapps 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e66215891bf39f8cf100360c1a040333352a3e858fb8dc9066e9416609da11f
-  data.tar.gz: 5b81d1efa4eb8cbb64851268aaeac04560972fa5233a706d9dd40d21c95017fa
+  metadata.gz: 0cfd2cadda9a1b89374e0a887abf1372db8a66e312eef095d46ee0bd24a4196a
+  data.tar.gz: 58c8f49781184a986b8d4770426750f4ed20a4acdb484b9ab1c2026e023ec8a5
 SHA512:
-  metadata.gz: f00d6ea26923a895c71322889959293e416f53ca0e398aabcbb6e50e828c1f0d8b17b36be22936de7f76014d6ce7d1e0ef4bd00fe1d79c20096006fee7fa5d74
-  data.tar.gz: bc707487b8a151e6fa30604e57b92bd727bb538566de40b2f208d6e0f8bbf4c40c14b42ecaf4005f0dfdce6e7866c43c24486506bdfe52b56c8febf8a434da57
+  metadata.gz: 2155906045ed527d4549c8a298710b25af9732a4523ad8301e4f162e63cca140ce98d3bb0728993e772492d8be82706dafeade722520447394f23624e6a132d4
+  data.tar.gz: fe76a4d5ff85406621adf1dcea78ea9ad6efa52b36ea2ccb1b2b6a008bcd48aeee2b3c4569c8119a4ffb0fa9598bde11e032bf49e110bacfbc403b451ca9b5c8

data/README.md

@@ -28,21 +28,7 @@ The library needs to be configured with your account's access token which is ava
 require "waveapps"
 Waveapps.access_token = "sjblah_..."
 ```
-
-
-### Create invoices
-Replace `<BUSINESS_ID>`, `<CUSTOMER_ID>`, and `<PRODUCT_ID>` with real ids.
-
-```ruby
-Waveapps::Invoice.create_invoice(business_id: <BUSINESS_ID>, customer_id: <CUSTOMER_ID>, items: [{product_id: <PRODUCT_ID>}])
-```
-Optional arguments
-
-`status`, `currency`, `title`, `invoice_number`,
-`po_number`, `invoice_date`, `exchange_rate`, `due_date`,
-`memo`, `footer`, `disable_amex_payments`, `disable_credit_card_payments`,
-`disable_bank_payments`, `item_title`, `unit_title`, `price_title`, `amount_title`, `hide_name`, `hide_description`, `hide_unit`, `hide_price`, `hide_amount`
-
+See [examples](/examples) for specific methods
 
 ## Development
 

data/examples/invoice.md

@@ -0,0 +1,60 @@
+# Invoice
+
+## Create invoice
+
+```ruby
+Waveapps::Invoice.create_invoice(business_id: <BUSINESS_ID>, customer_id: <CUSTOMER_ID>, items: [{product_id: <PRODUCT_ID>}])
+```
+Optional arguments
+
+`status`, `currency`, `title`, `invoice_number`,
+`po_number`, `invoice_date`, `exchange_rate`, `due_date`,
+`memo`, `footer`, `disable_amex_payments`, `disable_credit_card_payments`,
+`disable_bank_payments`, `item_title`, `unit_title`, `price_title`, `amount_title`, `hide_name`, `hide_description`, `hide_unit`, `hide_price`, `hide_amount`
+
+## List invoices
+```ruby
+Waveapps::Invoice.list_invoices(business_id: <BUSINESS_ID>)
+```
+
+## Send invoice
+
+Provide email of recipients in the `to` argument. Note that this must be an array.
+
+```ruby
+Waveapps::Invoice.send_invoice(invoice_id: <INVOICE_ID>, to: [<EMAIL>])
+```
+
+Optional arguments
+
+`subject`, `message`, `attach_pdf`
+
+The default value of `attach_pdf` is `false`
+
+
+## Approve invoice
+
+```ruby
+Waveapps::Invoice.approve_invoice(invoice_id: <INVOICE_ID>)
+```
+
+## Delete invoice
+
+```ruby
+Waveapps::Invoice.delete_invoice(invoice_id: <INVOICE_ID>)
+```
+
+## Mark invoice as sent
+
+Provide one of the following for `send_method`
+`EXPORT_PDF`, `GMAIL`, `MARKED_SENT`, `NOT_SENT`, `OUTLOOK`, `SHARED_LINK`, `SKIPPED`, `WAVE`, `YAHOO`
+
+```ruby
+Waveapps::Invoice.mark_as_sent(invoice_id: <INVOICE_ID>, send_method: <SEND_METHOD>)
+```
+
+Optional arguments
+
+`sent_at`
+
+If `sent_at` is not provided, Wave will use the current time

data/lib/waveapps/api.rb

@@ -26,5 +26,26 @@ module Waveapps
     # Schema = GraphQL::Client.load_schema("./tmp/schema.json")
 
     Client = GraphQL::Client.new(schema: Schema, execute: HTTP)
+
+    def self.handle_errors(response, mutation)
+      # Parse/validation errors will have `response.data = nil`. The top level
+      # errors object will report these.
+      if response.errors.any?
+        # "Could not resolve to a node with the global id of 'abc'"
+        message = response.errors[:data].join(", ")
+        return ::Waveapps::Error.new(message)
+
+      # The server will likely give us a message about why the node()
+      # lookup failed.
+      elsif data = response.data
+        # "Could not resolve to a node with the global id of 'abc'"
+        if data.errors[mutation].any?
+          message = data.errors[mutation].join(", ")
+          return ::Waveapps::Error.new(message)
+        end
+      else
+        Waveapps::Error.new("Something went wrong!")
+      end
+    end
   end
 end

data/lib/waveapps/invoice.rb

@@ -125,12 +125,15 @@ module Waveapps
     GRAPHQL
 
     def self.list_invoices(page: 1, page_size: 10, business_id:)
-      result = Waveapps::Api::Client.query(ListInvoicesQuery, variables: {
-                                             businessId: business_id, page: page, pageSize: page_size
-                                           }).data
-      return nil if result.business.nil?
+      response = Waveapps::Api::Client.query(
+        ListInvoicesQuery, variables: {
+          businessId: business_id, page: page, pageSize: page_size
+        })
 
-      result.business.invoices.edges.map(&:node)
+      if response.data && response.data.business
+        return response.data.business.invoices.edges.map(&:node)
+      end
+      Waveapps::Api.handle_errors(response, :business)
     end
 
     CreateInvoiceQuery = Waveapps::Api::Client.parse <<-'GRAPHQL'
@@ -259,42 +262,48 @@ module Waveapps
       hide_price: nil, hide_amount: nil, items:, business_id:, customer_id:
     )
 
-      Waveapps::Api::Client.query(CreateInvoiceQuery, variables: {
-                                    input: {
-                                      businessId: business_id,
-                                      customerId: customer_id,
-                                      items: items.map do |pid|
-                                               {
-                                                 productId: pid[:product_id],
-                                                 quantity: pid[:quantity],
-                                                 description: pid[:description],
-                                                 unitPrice: pid[:unit_price]
-                                               }
-                                             end,
-                                      status: status,
-                                      currency: currency,
-                                      title: title,
-                                      invoiceNumber: invoice_number,
-                                      poNumber: po_number,
-                                      invoiceDate: invoice_date,
-                                      exchangeRate: exchange_rate,
-                                      dueDate: due_date,
-                                      memo: memo,
-                                      footer: footer,
-                                      disableAmexPayments: disable_amex_payments,
-                                      disableCreditCardPayments: disable_credit_card_payments,
-                                      disableBankPayments: disable_bank_payments,
-                                      itemTitle: item_title,
-                                      unitTitle: unit_title,
-                                      priceTitle: price_title,
-                                      amountTitle: amount_title,
-                                      hideName: hide_name,
-                                      hideDescription: hide_description,
-                                      hideUnit: hide_unit,
-                                      hidePrice: hide_price,
-                                      hideAmount: hide_amount
-                                    }
-                                  })
+      response = Waveapps::Api::Client.query(
+        CreateInvoiceQuery, variables: {
+          input: {
+            businessId: business_id,
+            customerId: customer_id,
+            items: items.map do |pid|
+              {
+               productId: pid[:product_id],
+               quantity: pid[:quantity],
+               description: pid[:description],
+               unitPrice: pid[:unit_price]
+              }
+            end,
+            status: status,
+            currency: currency,
+            title: title,
+            invoiceNumber: invoice_number,
+            poNumber: po_number,
+            invoiceDate: invoice_date,
+            exchangeRate: exchange_rate,
+            dueDate: due_date,
+            memo: memo,
+            footer: footer,
+            disableAmexPayments: disable_amex_payments,
+            disableCreditCardPayments: disable_credit_card_payments,
+            disableBankPayments: disable_bank_payments,
+            itemTitle: item_title,
+            unitTitle: unit_title,
+            priceTitle: price_title,
+            amountTitle: amount_title,
+            hideName: hide_name,
+            hideDescription: hide_description,
+            hideUnit: hide_unit,
+            hidePrice: hide_price,
+            hideAmount: hide_amount
+          }
+        })
+
+      if response.data && response.data.invoice_create
+        return response.data.invoice_create
+      end
+      Waveapps::Api.handle_errors(response, :invoice_create)
     end
 
     DeleteInvoiceQuery = Waveapps::Api::Client.parse <<-'GRAPHQL'
@@ -310,9 +319,99 @@ module Waveapps
   		}
     GRAPHQL
 
-    def self.delete_invoice(id)
-      result = Waveapps::Api::Client.query(DeleteInvoiceQuery, variables: { input: { id: id } })
-      result.data
+    def self.delete_invoice(invoice_id:)
+      response = Waveapps::Api::Client.query(DeleteInvoiceQuery, variables:
+        { input: { invoiceId: invoice_id }
+      })
+
+      if response.data && response.data.invoice_delete
+        return response.data.invoice_delete
+      end
+      Waveapps::Api.handle_errors(response, :invoice_delete)
+    end
+
+    SendInvoiceQuery = Waveapps::Api::Client.parse <<-'GRAPHQL'
+      mutation ($input: InvoiceSendInput!) {
+        invoiceSend(input: $input) {
+          didSucceed
+          inputErrors {
+            message
+            code
+            path
+          }
+        }
+      }
+    GRAPHQL
+
+    def self.send_invoice(subject: "", message: "", attach_pdf: false, invoice_id:, to: )
+      response = Waveapps::Api::Client.query(
+        SendInvoiceQuery, variables: {
+          input: {
+            invoiceId: invoice_id,
+            to: to,
+            attachPDF: attach_pdf,
+            subject: subject,
+            message: message
+          }
+        })
+
+      if response.data && response.data.invoice_send
+        return response.data.invoice_send
+      end
+      Waveapps::Api.handle_errors(response, :invoice_send)
+    end
+
+    ApproveInvoiceQuery = Waveapps::Api::Client.parse <<-'GRAPHQL'
+      mutation ($input: InvoiceApproveInput!) {
+        invoiceApprove(input: $input) {
+          didSucceed
+          inputErrors {
+            message
+            code
+            path
+          }
+        }
+      }
+    GRAPHQL
+
+    def self.approve_invoice(invoice_id: )
+      response = Waveapps::Api::Client.query(ApproveInvoiceQuery, variables: {
+        input: { invoiceId: invoice_id }
+      })
+
+      if response.data && response.data.invoice_approve
+        return response.data.invoice_approve
+      end
+      Waveapps::Api.handle_errors(response, :invoice_approve)
+    end
+
+    MarkSentInvoiceQuery = Waveapps::Api::Client.parse <<-'GRAPHQL'
+      mutation ($input: InvoiceMarkSentInput!) {
+        invoiceMarkSent(input: $input) {
+          didSucceed
+          inputErrors {
+            message
+            code
+            path
+          }
+        }
+      }
+    GRAPHQL
+
+    def self.mark_as_sent(sent_at: nil, send_method: , invoice_id: )
+      response = Waveapps::Api::Client.query(
+        MarkSentInvoiceQuery, variables: {
+          input: {
+            invoiceId: invoice_id,
+            sentAt: sent_at,
+            sendMethod: send_method
+          }
+        })
+
+      if response.data && response.data.invoice_mark_sent
+        return response.data.invoice_mark_sent
+      end
+      Waveapps::Api.handle_errors(response, :invoice_mark_sent)
     end
   end
 end

data/lib/waveapps/ruby/version.rb

@@ -1,5 +1,5 @@
 module Waveapps
   module Ruby
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waveapps
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Hannah Masila
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/invoice.md
 - lib/tasks/schema.rake
 - lib/waveapps.rb
 - lib/waveapps/api.rb