unleashed 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7d32b1d247ccea9399690a692565cf43b06a61990e59c2a73643d0d08889559
-  data.tar.gz: e32d0170f365f79bacf4bccced4f0af0722b91ca4b8ad5234f76917002c74898
+  metadata.gz: 163e4108af74a8837955b70ece495fce05e57d754dea7456fe4728acf6cfe898
+  data.tar.gz: 0a483a88892922a15831688c082dbc2e1b2f26b14263186ca39cb283064b9be3
 SHA512:
-  metadata.gz: 2d7db5fbec3130bc8fc3cf461e52a7b1847fd2130afd861f2e88e52787b8ee892f3764d22a1f8d6c31886e6b5a5da6993e44934f14b7c7caa6b52cc7199de1bc
-  data.tar.gz: e4e850bf51a3379bd72451a6cf334a940cd4d00ca204c7e9a54eb5337f52de9b1cb36a78d46d5175e0f2528cc4036ae2073a74a4b2c1828bafd9c0f72f149b85
+  metadata.gz: acbf6829e4329b7e330ccdbe6cea08fa4b2cc4c5d07d2c4cadbea1f3906a8edae529e1a92931eb1c0d98adabfc07efe2d52fb0eba8040b6b477db0d517b6c495
+  data.tar.gz: cf3eb8666c697dc75739735ad1b00400eb564328dcfc54d8a0432236b9958c22ceef757a4dd66c0c7d50595cb9fbc3c123758c62dc50ecb46bab464f53453478

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.14] - 2020-02-23
+
+- Update options, queries, comments of `currencies`, `customers`, `invoices`, `payment terms`.
+- Replace `create` method by `create_or_update` method of `customers`
+
 ## [0.1.13] - 2019-12-05
 
 - Update version.

data/README.md

@@ -75,7 +75,7 @@ client = Unleashed::Client.new(options)
 #### Create a new Customer
 
 ```ruby
-customer = client.customers.create(
+customer = client.customers.create_or_update(
   Guid: '59f21e05-07fe-4d9d-b460-a09db4c3caa9',
   Addresses: [
     {
@@ -195,6 +195,26 @@ customer = client.customers.update(
 #### Get all customers
 
 ```ruby
+# List all customers
+# /Customers - also returns the first 200 customers because page number 1 is the default.
+#
+# @param options [Hash] Optional options.
+# @option PageSize: Can ask for up to 200 customers. Default: 200
+# @option Page: Page index. Default: 1
+# @option CustomerType: Only returns customers that matches the specified customer type.
+# @option SellPriceTier: Only returns customers that are assigned to the specified sell price tier.
+# @option Currency: Only returns customers with currency code exactly matching the specified value.
+# @option Customer: Returns customers whose customer code or customer name contains the specified value. It is case-sensitive.
+# @option CustomerCode: Only returns customers that start with the specific customer code.
+# @option CustomerName: Only returns customers that start with the specific customer name.
+# @option ContactEmail: Only returns customers that have a contact email that starts with the specified email address.
+# @option ModifiedSince: Only returns customers modified since a specified date.
+# @option IncludeObsolete: Returns all customers, including obsolete, if set to `true`. If set to `false` or if it is not specified then returns only active (ie. non-obsolete) customers.
+# @option XeroContactId: Only returns customers that start with the specific Xero Contact Id.
+# @option OrderBy: Orders the list by `LastModifiedOn` or `CreatedOn` date. By default the list is ordered by `CustomerCode`.
+# @option Sort: Orders the list by `CreatedOn` date sorted in ascending or descending order.
+#
+# @return [Array<Unleashed::Customer>] List all customers.
 client.customers.all
 ```
 
@@ -221,6 +241,22 @@ client.customers.last
 #### Get all invoices
 
 ```ruby
+# List all invoices
+# /Invoices - also returns the first 200 invoices because page number 1 is the default.
+#
+# @param options [Hash] Optional options.
+# @option Page: Page index. Default: 1
+# @option PageSize: Specifies the page size for pagination. Default page size is 200 invoices.
+# @option CustomerCode: Returns invoices that matches the specific customer code.
+# @option StartDate: Returns invoices created after a specified date, must be UTC format.
+# @option EndDate: Returns invoices created before a specified date, must be UTC format.
+# @option ModifiedSince: Returns invoices created or edited after a specified date, must be UTC format.
+# @option OrderNumber: Returns the invoices associated with the Sales Order Number.
+# @option InvoiceNumber: Returns a single invoice with the specified invoice number. If set, it overrides all other filters.
+# @option InvoiceStatus: Returns invoices with the specified status. Multiple selection can be specified as comma separated.For example: `invoiceStatus=Completed,Parked`. If no invoiceStatus filter is specified, then we exclude “Deleted” by default.
+# @option SerialBatch: False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
+#
+# @return [Array<Unleashed::Invoice>] List all invoices.
 client.invoices.all
 ```
 

data/lib/unleashed/resources/currency_resource.rb

@@ -10,13 +10,10 @@ module Unleashed
     # List all currencies
     # /Currencies - also returns the first 200 currencies because page number 1 is the default.
     #
-    # @param options [Hash] Optional options.
-    # @option options [Integer] :page_size Can ask for up to 200 currencies. default: 10
-    # @option options [Integer] :page Page index. default: 1
-    #
     # @return [Array<Unleashed::Currency>] List all currencies.
-    def all(options = { page: 1, page_size: 10 })
-      response = JSON.parse(@client.get('Currencies', options).body)
+    def all
+      endpoint = 'Currencies'
+      response = JSON.parse(@client.get(endpoint, options).body)
       currencies = response.key?('Items') ? response['Items'] : []
       currencies.map { |attributes| Unleashed::Currency.new(@client, attributes) }
     end

data/lib/unleashed/resources/customer_resource.rb

@@ -14,12 +14,33 @@ module Unleashed
     # /Customers - also returns the first 200 customers because page number 1 is the default.
     #
     # @param options [Hash] Optional options.
-    # @option options [Integer] :page_size Can ask for up to 200 customers. default: 10
-    # @option options [Integer] :page Page index. default: 1
+    # @option PageSize: Can ask for up to 200 customers. Default: 200
+    # @option Page: Page index. Default: 1
+    # @option CustomerType: Only returns customers that matches the specified customer type.
+    # @option SellPriceTier: Only returns customers that are assigned to the specified sell price tier.
+    # @option Currency: Only returns customers with currency code exactly matching the specified value.
+    # @option Customer: Returns customers whose customer code or customer name contains the specified value. It is case-sensitive.
+    # @option CustomerCode: Only returns customers that start with the specific customer code.
+    # @option CustomerName: Only returns customers that start with the specific customer name.
+    # @option ContactEmail: Only returns customers that have a contact email that starts with the specified email address.
+    # @option ModifiedSince: Only returns customers modified since a specified date.
+    # @option IncludeObsolete: Returns all customers, including obsolete, if set to `true`. If set to `false` or if it is not specified then returns only active (ie. non-obsolete) customers.
+    # @option XeroContactId: Only returns customers that start with the specific Xero Contact Id.
+    # @option OrderBy: Orders the list by `LastModifiedOn` or `CreatedOn` date. By default the list is ordered by `CustomerCode`.
+    # @option Sort: Orders the list by `CreatedOn` date sorted in ascending or descending order.
     #
     # @return [Array<Unleashed::Customer>] List all customers.
-    def all(options = { page: 1, page_size: 10 })
-      response = JSON.parse(@client.get('Customers', options).body)
+    def all(options = { Page: 1, PageSize: 200 })
+      endpoint = 'Customers'
+      params = options.dup
+
+      # Handle Page option
+      if params[:Page].present?
+        endpoint << "/#{params[:Page]}"
+        params.delete :Page
+      end
+
+      response = JSON.parse(@client.get(endpoint, params).body)
       customers = response.key?('Items') ? response['Items'] : []
       customers.map { |attributes| Unleashed::Customer.new(@client, attributes) }
     end
@@ -31,7 +52,8 @@ module Unleashed
     #
     # @return [Unleashed::Customer]
     def find(id)
-      response = JSON.parse(@client.get("Customers/#{id}").body)
+      endpoint = "Customers/#{id}"
+      response = JSON.parse(@client.get(endpoint).body)
       Unleashed::Customer.new(@client, response)
     end
 
@@ -52,11 +74,27 @@ module Unleashed
     # Create a new customer
     #
     # @param attributes [Hash] Customer's attributes.
+    # attributes = { Guid: "59f21e05-07fe-4d9d-b460-a09db4c3caa9", Addresses: [ { AddressType: "Shipping",
+    #   AddressName: "Example Address", StreetAddress: "Example Address",
+    #   StreetAddress2: "Example Address 2", Suburb: "Example Suburb", City: "Auckland",
+    #   Region: "Auckland", Country: "New Zealand", PostalCode: "1061", IsDefault: false,
+    #   DeliveryInstruction: "Have a good day" } ], TaxCode: "", TaxRate: nil,
+    #   CustomerCode: "UnleashedCustomer", CustomerName: "Unleashed Customer", GSTVATNumber: nil,
+    #   BankName: nil, BankBranch: nil, BankAccount: nil, Website: nil, PhoneNumber: nil, FaxNumber: nil,
+    #   MobileNumber: nil, DDINumber: nil, TollFreeNumber: nil, Email: nil, EmailCC: nil,
+    #   Currency: { CurrencyCode: "NZD", Description: "New Zealand, Dollars",
+    #     Guid: "6cb5d67a-1c96-4fa8-bf59-b23c2d69f22a" }, Notes: nil, Taxable: true, SalesPerson: nil,
+    #     DiscountRate: 0, PrintPackingSlipInsteadOfInvoice: false, PrintInvoice: false,
+    #     StopCredit: false, Obsolete: false, XeroSalesAccount: nil, XeroCostOfGoodsAccount: nil,
+    #     SellPriceTier: "", SellPriceTierReference: nil, CustomerType: "Cash",
+    #     PaymentTerm: "20th Month following", ContactFirstName: nil, ContactLastName: nil }
     #
     # @return [Unleashed::Customer]
-    def create(attributes)
+    def create_or_update(attributes)
       id = attributes[:Guid].present? ? attributes[:Guid] : ''
-      response = JSON.parse(@client.post("Customers/#{id}", attributes).body)
+      endpoint = 'Customers'
+      endpoint << "/#{id}" if id.present?
+      response = JSON.parse(@client.post(endpoint, attributes).body)
       Unleashed::Customer.new(@client, response)
     end
   end

data/lib/unleashed/resources/invoice_resource.rb

@@ -14,12 +14,64 @@ module Unleashed
     # /Invoices - also returns the first 200 invoices because page number 1 is the default.
     #
     # @param options [Hash] Optional options.
-    # @option options [Integer] :page_size Can ask for up to 200 invoices. default: 10
-    # @option options [Integer] :page Page index. default: 1
+    # @option Page: Page index. Default: 1
+    # @option PageSize: Specifies the page size for pagination. Default page size is 200 invoices.
+    # @option CustomerCode: Returns invoices that matches the specific customer code.
+    # @option StartDate: Returns invoices created after a specified date, must be UTC format.
+    # @option EndDate: Returns invoices created before a specified date, must be UTC format.
+    # @option ModifiedSince: Returns invoices created or edited after a specified date, must be UTC format.
+    # @option OrderNumber: Returns the invoices associated with the Sales Order Number.
+    # @option InvoiceNumber: Returns a single invoice with the specified invoice number. If set, it overrides all other filters.
+    # @option InvoiceStatus: Returns invoices with the specified status. Multiple selection can be specified as comma separated.For example: `invoiceStatus=Completed,Parked`. If no invoiceStatus filter is specified, then we exclude “Deleted” by default.
+    # @option SerialBatch: False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
     #
     # @return [Array<Unleashed::Invoice>] List all invoices.
-    def all(options = { page: 1, page_size: 10 })
-      response = JSON.parse(@client.get('Invoices', options).body)
+    # { Pagination: { NumberOfItems: 2, PageSize: 200, PageNumber: 1, NumberOfPages: 1 },
+    # Items: [ { InvoiceNumber: "SI-137", OrderNumber: "SO-137", QuoteNumber: nil,
+    #   InvoiceDate: "/Date(1565058456626)/", DueDate: "/Date(1568937600000)/",
+    #   InvoiceStatus: "Completed", Customer: { CustomerCode: "WADE",
+    #     CustomerName: "Wade's Apparel & Accessories", CurrencyId: 110,
+    #     Guid: "b9f21e05-07fe-4d9d-b460-a09db4c3caa9", LastModifiedOn: "/Date(1559778437146)/" },
+    #     Comments: nil, PostalAddress: nil, DeliveryAddress: { AddressType: nil,
+    #       AddressName: nil, StreetAddress: nil, StreetAddress2: nil, Suburb: nil, City: nil,
+    #       Region: nil, Country: nil, PostalCode: nil, IsDefault: false },
+    #       DeliveryInstruction: "Handle with care.", SubTotal: 25.0, TaxTotal: 5.0, Total: 30.0,
+    #       BCSubTotal: 25.27, BCTaxTotal: 5.05, BCTotal: 30.32, CreatedBy: "james@JamesInc.com",
+    #       PaymentTerm: "20th Month following", InvoiceLines: [ { LineNumber: 1, LineType: nil,
+    #         Product: { Guid: "23280680-a2bd-4873-a390-501e0f3399d1", ProductCode: "NAIL-M",
+    #           ProductDescription: "Medium Nails" }, OrderQuantity: 1.0, InvoiceQuantity: 1.0,
+    #           UnitPrice: 25.0, DiscountRate: 0.0, LineTotal: 25.0, Comments: "", TaxRate: 0.2,
+    #           LineTax: 5.0, BCUnitPrice: 25.2729, SerialNumbers: nil, BatchNumbers: nil,
+    #           Guid: "866e295f-76fb-49e7-9407-b2ed4e0a5d0d", LastModifiedOn: "/Date(1565058457156)/" } ],
+    #           Guid: "10a1571d-8c5a-4e5e-bbba-bc3215a27e17", LastModifiedOn: "/Date(1565058457161)/" },
+    #           { InvoiceNumber: "SI-136", OrderNumber: "SO-136", QuoteNumber: nil,
+    #             InvoiceDate: "/Date(1565058268231)/", DueDate: "/Date(1568937600000)/",
+    #             InvoiceStatus: "Completed", Customer: { CustomerCode: "WADE",
+    #               CustomerName: "Wade's Apparel & Accessories", CurrencyId: 110,
+    #               Guid: "b9f21e05-07fe-4d9d-b460-a09db4c3caa9", LastModifiedOn: "/Date(1559778437146)/" },
+    #               Comments: nil, PostalAddress: nil, DeliveryAddress: { AddressType: nil,
+    #                 AddressName: nil, StreetAddress: nil, StreetAddress2: nil, Suburb: nil, City: nil,
+    #                 Region: nil, Country: nil, PostalCode: nil, IsDefault: false },
+    #                 DeliveryInstruction: nil, SubTotal: 25.0, TaxTotal: 5.0, Total: 30.0,
+    #                 BCSubTotal: 25.27, BCTaxTotal: 5.05, BCTotal: 30.32, CreatedBy: "james@JamesInc.com",
+    #                 PaymentTerm: "20th Month following", InvoiceLines: [ { LineNumber: 1, LineType: nil,
+    #                   Product: { Guid: "23280680-a2bd-4873-a390-501e0f3399d1", ProductCode: "NAIL-M",
+    #                     ProductDescription: "Medium Nails" }, OrderQuantity: 1.0, InvoiceQuantity: 1.0,
+    #                     UnitPrice: 25.0, DiscountRate: 0.0, LineTotal: 25.0, Comments: "", TaxRate: 0.2,
+    #                     LineTax: 5.0, BCUnitPrice: 25.2729, SerialNumbers: nil, BatchNumbers: nil,
+    #                     Guid: "2b994962-e446-4b18-b8c7-5f445adde8cc", LastModifiedOn: "/Date(1565058268757)/" } ],
+    #                     Guid: "5cc41e1e-468f-4c01-beb9-a077fc06df46", LastModifiedOn: "/Date(1565058268764)/" } ] }
+    def all(options = { Page: 1, PageSize: 200 })
+      endpoint = 'Invoices'
+      params = options.dup
+
+      # Handle Page option
+      if params[:Page].present?
+        endpoint << "/#{params[:Page]}"
+        params.delete :Page
+      end
+
+      response = JSON.parse(@client.get(endpoint, params).body)
       invoices = response.key?('Items') ? response['Items'] : []
       invoices.map { |attributes| Unleashed::Invoice.new(@client, attributes) }
     end

data/lib/unleashed/resources/payment_term_resource.rb

@@ -11,13 +11,28 @@ module Unleashed
     # List all payment_terms
     # /PaymentTerms - also returns the first 200 payment_terms because page number 1 is the default.
     #
-    # @param options [Hash] Optional options.
-    # @option options [Integer] :page_size Can ask for up to 200 payment_terms. default: 10
-    # @option options [Integer] :page Page index. default: 1
-    #
-    # @return [Array<Unleashed::PaymentTerm>] List all payment_terms.
-    def all(options = { page: 1, page_size: 10 })
-      response = JSON.parse(@client.get('PaymentTerms', options).body)
+    # @return [Array<Unleashed::PaymentTerm>] List all payment terms.
+    # {
+    #   "Items": [
+    #     {
+    #         "Guid": "6223b37e-2ee4-41ed-a215-5f14c53e8f7f",
+    #         "Type": "DaysOfTheMonthFollowing",
+    #         "Days": 20,
+    #         "Obsolete": false,
+    #         "PaymentTermDescription": "20th Month following"
+    #     },
+    #     {
+    #         "Guid": "6488bee4-ea4c-4a25-ba1b-a86965120e34",
+    #         "Type": "DaysOfTheMonthFollowing",
+    #         "Days": 25,
+    #         "Obsolete": false,
+    #         "PaymentTermDescription": "25th Month following"
+    #     }
+    #   ]
+    # }
+    def all
+      endpoint = 'PaymentTerms'
+      response = JSON.parse(@client.get(endpoint).body)
       payment_terms = response.key?('Items') ? response['Items'] : []
       payment_terms.map { |attributes| Unleashed::PaymentTerm.new(@client, attributes) }
     end
@@ -35,16 +50,5 @@ module Unleashed
     def last
       all.last
     end
-
-    # Create a new payment_term
-    #
-    # @param attributes [Hash] PaymentTerm's attributes.
-    #
-    # @return [Unleashed::PaymentTerm]
-    def create(attributes)
-      id = attributes[:Guid].present? ? attributes[:Guid] : ''
-      response = JSON.parse(@client.post("PaymentTerms/#{id}", attributes).body)
-      Unleashed::PaymentTerm.new(@client, response)
-    end
   end
 end

data/lib/unleashed/version.rb

@@ -2,7 +2,7 @@ module Unleashed
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY = 13
+    TINY = 14
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}".freeze
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleashed
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Nhan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday