waveapps 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7add40d1a01cf89f22a73ac635a539331481fcfe1ad607d94f8794adf7b0bd1c
-  data.tar.gz: 5020a93cfef8117a90292fbdd1835a3b27283184902c7831c0e377680283f6d5
+  metadata.gz: 50dbb250a88d5bea155da73a27a5b0149c8684395b33ec6db4ee84e8c08fe6f3
+  data.tar.gz: 441d07ba0bd21da26e8987587ccf2f92ae456cfd30282bae25a7d47223d957da
 SHA512:
-  metadata.gz: 47a0f388436dd8521eb1f69d77b1ba9ce2328f22632f272ea6ec328ad88136c42ff4d483aed27d55f84746ec5ea6ece81c4b23fdbb2e5a282040a8e627e56235
-  data.tar.gz: d9daac12bff6d0c364d441dd95850a0717d57c975c522fae1cc089430cd2d51464dc7204946eabd5e57aae71d19659d3513ad0ae14791a78221e52b907aacf16
+  metadata.gz: 002eda0511d2f230cb6e564be7c7634952268e8b7a1f3049230806da86f6ee2a4f14f794d17227b92b2d6a6bdfbb48e2d94144b1cd1fa2cffd980b510f6eac6a
+  data.tar.gz: ed1d2f1290d6e4d043dbeed8bd8229d7f30370834ca8a6bcf235569c982217b509160f417d404f8375e6fca191a03047b6ffa9366f89bed15da11417195758d0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waveapps (0.1.5)
+    waveapps (0.1.6)
       graphql-client (~> 0.16)
 
 GEM

data/examples/invoice.md

@@ -3,26 +3,91 @@
 ## Create invoice
 
 ```ruby
-Waveapps::Invoice.create_invoice(business_id: <BUSINESS_ID>, customer_id: <CUSTOMER_ID>, items: [{product_id: <PRODUCT_ID>}])
+Waveapps::Invoice.create_invoice(
+  business_id: <BUSINESS_ID>,
+  customer_id: <CUSTOMER_ID>,
+  items: [
+    {
+      product_id: <PRODUCT_ID>
+    }
+  ]
+)
 ```
-Optional arguments
+
+### 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`
 
+The `items` argument takes a mandatory `product_id` value and `taxes`, `quantity`, `description`,
+`unit_price`. The `description` and `unit_price` will override the values in the product.
+
+The `taxes` object inside `items` takes a mandatory `sales_tax_id` and an optional `amount`.
+
+The default `status` on creation is `DRAFT`. You can override this to `SAVED` when calling this method
+
+### Example with taxes
+
+```ruby
+Waveapps::Invoice.create_invoice(
+  business_id: <BUSINESS_ID>,
+  customer_id: <CUSTOMER_ID>,
+  items: [
+    {
+      product_id: <PRODUCT_ID>,
+      taxes: [
+        {
+          amount: 89.7,
+          sales_tax_id: <SALES_TAX_ID>
+        }
+      ]
+    }
+  ]
+)
+```
+
+### Example with product override
+
+```ruby
+Waveapps::Invoice.create_invoice(
+  business_id: <BUSINESS_ID>,
+  customer_id: <CUSTOMER_ID>,
+  items: [
+    {
+      product_id: <PRODUCT_ID>,
+      description: "5 Watt C7 light bulb",
+      unit_price: "2.7",
+      quantity: 5
+    }
+  ]
+)
+```
+
+
 ## List invoices
 ```ruby
 Waveapps::Invoice.list_invoices(business_id: <BUSINESS_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`
+
+The default `page_size` is 10 and `page` is 1
+Check the allowed `sort` arguments [here](https://developer.waveapps.com/hc/en-us/articles/360019968212#invoicesort). By default, the results are sorted by `[CREATED_AT_DESC]`.
+
+
 ## Send invoice
 
 Provide email of recipients in the `to` argument. If you have more than one recipient, pass it as an array.
 
 ```ruby
-Waveapps::Invoice.send_invoice(invoice_id: <INVOICE_ID>, to: [<EMAIL>])
+Waveapps::Invoice.send_invoice(invoice_id: <INVOICE_ID>, to: [<EMAIL>, <EMAIL>])
 ```
 
 Optional arguments
@@ -46,8 +111,7 @@ 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`
+Provide a `send_method` from one of the allowed methods [here](https://developer.waveapps.com/hc/en-us/articles/360019968212#invoicesendmethod)
 
 ```ruby
 Waveapps::Invoice.mark_as_sent(invoice_id: <INVOICE_ID>, send_method: <SEND_METHOD>)

data/lib/waveapps/invoice.rb

@@ -3,11 +3,19 @@
 module Waveapps
   class Invoice
     ListInvoicesQuery = Waveapps::Api::Client.parse <<-'GRAPHQL'
-  		query($businessId: ID!, $page: Int!, $pageSize: Int!) {
+  		query(
+        $businessId: ID!, $page: Int!, $pageSize: Int!, $sort: [InvoiceSort!]!,
+        $status: InvoiceStatus, $customerId: ID, $currency: CurrencyCode,
+        $sourceId: ID, $invoiceDateStart: Date, $invoiceDateEnd: Date,
+        $modifiedAtAfter: DateTime, $modifiedAtBefore: DateTime) {
 			  business(id: $businessId) {
 			    id
 			    isClassicInvoicing
-			    invoices(page: $page, pageSize: $pageSize) {
+			    invoices(page: $page, pageSize: $pageSize, sort: $sort,
+          status: $status, customerId: $customerId, currency: $currency,
+          sourceId: $sourceId, invoiceDateStart: $invoiceDateStart,
+          invoiceDateEnd: $invoiceDateEnd, modifiedAtAfter: $modifiedAtAfter,
+          modifiedAtBefore: $modifiedAtBefore) {
 			      pageInfo {
 			        currentPage
 			        totalPages
@@ -124,14 +132,22 @@ module Waveapps
 			}
     GRAPHQL
 
-    def self.list_invoices(page: 1, page_size: 10, business_id:)
+    def self.list_invoices(page: 1, page_size: 10, sort: [ "CREATED_AT_DESC"],
+      status: nil, customer_id: nil, currency: nil, source_id: nil,
+      invoice_date_start: nil, invoice_date_end: nil, modified_at_after: nil,
+      modified_at_before: nil, business_id:
+    )
       response = Waveapps::Api::Client.query(
         ListInvoicesQuery, variables: {
-          businessId: business_id, page: page, pageSize: page_size
+          businessId: business_id, page: page, pageSize: page_size, sort: sort,
+          status: status, customerId: customer_id, currency: currency,
+          sourceId: source_id, invoiceDateStart: invoice_date_start,
+          invoiceDateEnd: invoice_date_end, modifiedAtAfter: modified_at_after,
+          modifiedAtBefore: modified_at_before
         })
 
-      if response.data && response.data.business
-        return response.data.business.invoices.edges.map(&:node)
+      if response.data && response.data.business && response.data.business
+        return response.data.business.invoices
       end
       Waveapps::Api.handle_errors(response, :business)
     end

data/lib/waveapps/ruby/version.rb

@@ -1,5 +1,5 @@
 module Waveapps
   module Ruby
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waveapps
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Hannah Masila
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler