unleashed 0.1.11 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cdea89c1db61c6f9af7c6c076d44b61c8c8b544700eaab32b2f0b7adba4f71e
-  data.tar.gz: a7f23ff31284340aab544858de1a1421bf46a060a550c0b5ff943644b09fcf21
+  metadata.gz: 64bf42de94dbe048a5de0a81983e05e92ae7199df7c9f1d31b3af12759af408c
+  data.tar.gz: 10dfcd117b381f209e2e740a1a290e264ebb903d4c5121ba926aa01e440d05ed
 SHA512:
-  metadata.gz: 9acacc13ac8da33f97fb58da6df5ea72a1f4a7d2b80d663e03e42d34db7542cc0b567c015f794597468aef3a36545bd1c769c04f374b1bb99aa9c85718d7e0f9
-  data.tar.gz: f9dcd61b442996136c02b2019c52d2d5f6d5eac5e83422e37becee4910aed7c25acb9278a1fac455ebc103fe4f742738c26cabedc4f18e6968bd275feb0198b8
+  metadata.gz: 2b4186e4593a6eab6fd8225c3abc7ae16ad3c65e1dece3753d42a76483ae3682d52c142fa3cb66ba46631a001423e65a56e0d928a04de26772b74ca9203735a1
+  data.tar.gz: e0f30e55e86a48cf1d37a357de098788a3f7d059d9af542f0fe862891f96c45a9e3f4c3d397444eaa49b950ca33eb44bce9f1525e37051a98e59460deae22411

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.17] - 2021-01-14
+
+- Update HMAC input.
+
+## [0.1.16] - 2020-04-10
+
+- Add new model `Company` and resources.
+- Update README and separate it to some docs.
+
+## [0.1.15] - 2020-02-26
+
+- Update and fix bugs for `client`, `currency`, `customer`, `invoice` resources.
+- Show status code in error messge.
+- Print request info to debug easier.
+
+## [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.
+
+## [0.1.12] - 2019-12-05
+
+- Update some cases to show errors.
+
 ## [0.1.11] - 2019-12-04
 
 - Add `Payment Term`

data/README.md

@@ -70,219 +70,15 @@ options = { api_id: ENV['UNLEASHED_API_ID'], api_key: ENV['UNLEASHED_API_KEY'] }
 client = Unleashed::Client.new(options)
 ```
 
-### Customers
+## 4. Documentation for Models
 
-#### Create a new Customer
+* [Unleashed::Company](docs/Company.md)
+* [Unleashed::Currency](docs/Currency.md)
+* [Unleashed::Customer](docs/Customer.md)
+* [Unleashed::Invoice](docs/Invoice.md)
+* [Unleashed::PaymentTerm](docs/PaymentTerm.md)
 
-```ruby
-customer = client.customers.create(
-  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: 'c33e4f50-e42b-40cd-9147-4d0e4657cd4d'
-  },
-  Notes: nil,
-  Taxable: true,
-  SalesPerson: nil,
-  DiscountRate: 0.0000,
-  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
-)
-```
-
-#### Update a Customer
-
-```ruby
-customer = client.customers.update(
-  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.0000,
-  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
-)
-```
-
-#### Get all customers
-
-```ruby
-client.customers.all
-```
-
-#### Get a customer
-
-```ruby
-client.customers.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
-```
-
-#### Get the first customer
-
-```ruby
-client.customers.first
-```
-
-#### Get the last customer
-
-```ruby
-client.customers.last
-```
-
-### Invoices
-
-#### Get all invoices
-
-```ruby
-client.invoices.all
-```
-
-#### Get an invoice
-
-```ruby
-client.invoices.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
-```
-
-#### Get the first invoice
-
-```ruby
-client.invoices.first
-```
-
-#### Get the last invoice
-
-```ruby
-client.invoices.last
-```
-
-### Currencies
-
-#### Get all currencies
-
-```ruby
-client.currencies.all
-```
-
-#### Get the first currency
-
-```ruby
-client.currencies.first
-```
-
-#### Get the last currency
-
-```ruby
-client.currencies.last
-```
-
-### Payment Terms
-
-#### Get all payment terms
-
-```ruby
-client.payment_terms.all
-```
-
-#### Get the first payment term
-
-```ruby
-client.payment_terms.first
-```
-
-#### Get the last payment term
-
-```ruby
-client.payment_terms.last
-```
-
-## 4. Contributing
+## 5. Contributing
 
   1. Fork it [https://github.com/nnhansg/unleashed-ruby](https://github.com/nnhansg/unleashed-ruby)
   2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -290,10 +86,10 @@ client.payment_terms.last
   4. Push to the branch (`git push origin my-new-feature`)
   5. Create a new Pull Request
 
-## 5. License
+## 6. License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## 6. Code of Conduct
+## 7. Code of Conduct
 
 Everyone interacting in the Unleashed project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nnhansg/unleashed-ruby/blob/master/CODE_OF_CONDUCT.md).

data/docs/Company.md

@@ -0,0 +1,19 @@
+# Unleashed::Company
+
+## Get all companies
+
+```ruby
+client.companies.all
+```
+
+## Get the first company
+
+```ruby
+client.companies.first
+```
+
+## Get the last company
+
+```ruby
+client.companies.last
+```

data/docs/Currency.md

@@ -0,0 +1,19 @@
+# Unleashed::Currency
+
+## Get all currencies
+
+```ruby
+client.currencies.all
+```
+
+## Get the first currency
+
+```ruby
+client.currencies.first
+```
+
+## Get the last currency
+
+```ruby
+client.currencies.last
+```

data/docs/Customer.md

@@ -0,0 +1,165 @@
+# Unleashed::Customer
+
+## Create a new Customer
+
+```ruby
+customer = client.customers.create_or_update(
+  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: 'c33e4f50-e42b-40cd-9147-4d0e4657cd4d'
+  },
+  Notes: nil,
+  Taxable: true,
+  SalesPerson: nil,
+  DiscountRate: 0.0000,
+  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
+)
+```
+
+## Update a Customer
+
+```ruby
+customer = client.customers.update(
+  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.0000,
+  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
+)
+```
+
+## 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
+```
+
+## Get a customer
+
+```ruby
+client.customers.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
+```
+
+## Get the first customer
+
+```ruby
+client.customers.first
+```
+
+## Get the last customer
+
+```ruby
+client.customers.last
+```

data/docs/Invoice.md

@@ -0,0 +1,41 @@
+# Invoices
+
+## 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
+```
+
+## Get an invoice
+
+```ruby
+client.invoices.find('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
+```
+
+## Get the first invoice
+
+```ruby
+client.invoices.first
+```
+
+## Get the last invoice
+
+```ruby
+client.invoices.last
+```

data/docs/PaymentTerm.md

@@ -0,0 +1,19 @@
+# Payment Terms
+
+## Get all payment terms
+
+```ruby
+client.payment_terms.all
+```
+
+## Get the first payment term
+
+```ruby
+client.payment_terms.first
+```
+
+## Get the last payment term
+
+```ruby
+client.payment_terms.last
+```

data/lib/unleashed/client.rb

@@ -5,11 +5,13 @@ require_relative 'models/customer'
 require_relative 'models/invoice'
 require_relative 'models/currency'
 require_relative 'models/payment_term'
+require_relative 'models/company'
 require_relative 'resources/base_resource'
 require_relative 'resources/customer_resource'
 require_relative 'resources/invoice_resource'
 require_relative 'resources/currency_resource'
 require_relative 'resources/payment_term_resource'
+require_relative 'resources/company_resource'
 require 'json'
 require 'faraday'
 
@@ -48,6 +50,16 @@ module Unleashed
       end
     end
 
+    def hmac_input(params_hash)
+      hmac_input_a = []
+
+      params_hash.each do |k, v|
+        hmac_input_a << "#{k}=#{v}"
+      end
+
+      hmac_input_a.join('&')
+    end
+
     # Create a signature for request
     def signature(params = '')
       hash = OpenSSL::HMAC.digest('sha256', @api_key, params)
@@ -59,7 +71,8 @@ module Unleashed
       request.headers['Accept'] = 'application/json'
       request.headers['Content-Type'] = 'application/json'
       request.headers['api-auth-id'] = @api_id
-      request.headers['api-auth-signature'] = signature(request.params.to_query)
+      request.headers['api-auth-signature'] = signature(hmac_input(request.params))
+      request
     end
 
     # Make a HTTP GET request
@@ -73,12 +86,18 @@ module Unleashed
         request.params = parameters
 
         # Set headers
-        init_default_headers(request)
+        request = init_default_headers(request)
 
         # Assign more custom headers
         headers.each do |key, value|
           request.headers[key] = value
         end
+
+        # Print log
+        time = Time.zone.now.strftime('%Y-%m-%d %H:%M:%S %z')
+        puts "[#{time}] Client -- : HEADERS #{request.headers}"
+        puts "[#{time}] Client -- : GET #{request.path}"
+        puts "[#{time}] Client -- : PARAMS #{request.params}"
       end
 
       on_complete(response) unless skip_status_check
@@ -103,6 +122,13 @@ module Unleashed
         end
 
         request.body = parameters.to_json
+
+        # Print log
+        time = Time.zone.now.strftime('%Y-%m-%d %H:%M:%S %z')
+        puts "[#{time}] Client -- : HEADERS #{request.headers}"
+        puts "[#{time}] Client -- : POST #{request.path}"
+        puts "[#{time}] Client -- : PARAMS #{request.params}"
+        puts "[#{time}] Client -- : BODY #{request.body}"
       end
 
       on_complete(response) unless skip_status_check
@@ -117,7 +143,8 @@ module Unleashed
         customers: CustomerResource,
         invoices: InvoiceResource,
         currencies: CurrencyResource,
-        payment_terms: PaymentTermResource
+        payment_terms: PaymentTermResource,
+        companies: CompanyResource
       }
     end
 

data/lib/unleashed/error.rb

@@ -41,12 +41,12 @@ module Unleashed
         @response.body
       else
         json_response = JSON.parse(@response.body)
-        message = ''
+        message = "[StatusCode=#{@response.status}] - "
         message << json_response['description'] if json_response.key?('description')
         message << json_response['Description'] if json_response.key?('Description')
 
-        if json_response.key?('errors')
-          message << json_response['errors'].map { |attribute, content| "#{attribute}: #{content}" }.join(', ')
+        if json_response.key?('Items') && json_response['Items'].is_a?(Array)
+          message << json_response['Items'].map { |attribute, content| "#{attribute}: #{content}" }.join(', ')
         end
 
         message

data/lib/unleashed/models/company.rb

@@ -0,0 +1,5 @@
+module Unleashed
+  # Manage Companies
+  class Company < BaseModel
+  end
+end

data/lib/unleashed/resources/company_resource.rb

@@ -0,0 +1,38 @@
+module Unleashed
+  # The Companies resource allows Companies to be listed. An individual Company details can be
+  # viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)
+  # to the URI. Here are some example URIs:
+  # /Companies - returns a list of Company related information.
+  #
+  # @see https://apidocs.unleashedsoftware.com/Companies
+  class CompanyResource < BaseResource
+    def model
+      Unleashed::Company
+    end
+
+    # Lists all information for your company
+    # /Companies - returns a list of Company related information.
+    #
+    # @return [Array<Unleashed::Company>] Lists all information for your company.
+    def all
+      endpoint = 'Companies'
+      response = JSON.parse(@client.get(endpoint).body)
+      companies = response.key?('Items') ? response['Items'] : []
+      companies.map { |attributes| Unleashed::Company.new(@client, attributes) }
+    end
+
+    # Get a first company in all
+    #
+    # @return [Unleashed::Company]
+    def first
+      all.first
+    end
+
+    # Get a last company in all
+    #
+    # @return [Unleashed::Company]
+    def last
+      all.last
+    end
+  end
+end

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).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,29 @@ 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
+      endpoint << "/#{params[:Page]}" if params[:Page].present?
+      response = JSON.parse(@client.get(endpoint, params).body)
       customers = response.key?('Items') ? response['Items'] : []
       customers.map { |attributes| Unleashed::Customer.new(@client, attributes) }
     end
@@ -27,11 +44,12 @@ module Unleashed
     # Get a single customer
     # /Customers/E6E8163F-6911-40e9-B740-90E5A0A3A996 - returns details of a particular customer.
     #
-    # @param id [String] customer ID.
+    # @param guid [String] customer ID.
     #
     # @return [Unleashed::Customer]
-    def find(id)
-      response = JSON.parse(@client.get("Customers/#{id}").body)
+    def find(guid)
+      endpoint = "Customers/#{guid}"
+      response = JSON.parse(@client.get(endpoint).body)
       Unleashed::Customer.new(@client, response)
     end
 
@@ -52,11 +70,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,60 @@ 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
+      endpoint << "/#{params[:Page]}" if params[:Page].present?
+      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 = 11
+    TINY = 17
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}".freeze
   end

data/unleashed.gemspec

@@ -13,15 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/nnhansg/unleashed-ruby'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = 'https://github.com'
-  # else
-  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
-  #     'public gem pushes.'
-  # end
-
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/nnhansg/unleashed-ruby/src/master/'
   spec.metadata['changelog_uri'] = 'https://github.com/nnhansg/unleashed-ruby/src/master/CHANGELOG.md'
@@ -43,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '>= 0'
   spec.add_dependency 'json', '>= 0'
   spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleashed
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.17
 platform: ruby
 authors:
 - Nhan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -62,16 +62,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,11 @@ files:
 - bin/.keep
 - bin/console
 - bin/setup
+- docs/Company.md
+- docs/Currency.md
+- docs/Customer.md
+- docs/Invoice.md
+- docs/PaymentTerm.md
 - lib/.keep
 - lib/unleashed.rb
 - lib/unleashed/client.rb
@@ -114,11 +119,13 @@ files:
 - lib/unleashed/default.rb
 - lib/unleashed/error.rb
 - lib/unleashed/models/base_model.rb
+- lib/unleashed/models/company.rb
 - lib/unleashed/models/currency.rb
 - lib/unleashed/models/customer.rb
 - lib/unleashed/models/invoice.rb
 - lib/unleashed/models/payment_term.rb
 - lib/unleashed/resources/base_resource.rb
+- lib/unleashed/resources/company_resource.rb
 - lib/unleashed/resources/currency_resource.rb
 - lib/unleashed/resources/customer_resource.rb
 - lib/unleashed/resources/invoice_resource.rb