avatax 17.7.3 → 17.8.1

data/lib/avatax/client/taxcodes.rb

@@ -11,8 +11,8 @@ module AvaTax
       # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       # @param companyId [Integer] The ID of the company that owns this tax code.
-      # @param model [object[]] The tax code you wish to create.
-      # @return [object[]]
+      # @param model [TaxCodeModel[]] The tax code you wish to create.
+      # @return [TaxCodeModel[]]
       def create_tax_codes(companyId, model)
         path = "/api/v2/companies/#{companyId}/taxcodes"
         post(path, model)
@@ -24,7 +24,7 @@ module AvaTax
       # Marks the existing TaxCode object at this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this tax code.
       # @param id [Integer] The ID of the tax code you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_tax_code(companyId, id)
         path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
         delete(path)
@@ -59,7 +59,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these tax codes
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -81,7 +81,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/taxrules.rb

@@ -11,8 +11,8 @@ module AvaTax
       # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
       # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
       # @param companyId [Integer] The ID of the company that owns this tax rule.
-      # @param model [object[]] The tax rule you wish to create.
-      # @return [object[]]
+      # @param model [TaxRuleModel[]] The tax rule you wish to create.
+      # @return [TaxRuleModel[]]
       def create_tax_rules(companyId, model)
         path = "/api/v2/companies/#{companyId}/taxrules"
         post(path, model)
@@ -24,7 +24,7 @@ module AvaTax
       # Mark the TaxRule identified by this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this tax rule.
       # @param id [Integer] The ID of the tax rule you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_tax_rule(companyId, id)
         path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
         delete(path)
@@ -59,7 +59,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these tax rules
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -81,7 +81,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/transactions.rb

@@ -7,28 +7,30 @@ module AvaTax
       #
       # Add lines to an existing unlocked transaction.
       #
-      # The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will
-      # be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number
-      # in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with
-      # the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all
-      # transaction lines for them, in this case, the line number becomes: "1", "2", "3", ...
-      #
-      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
-      # sales, purchases, inventory transfer, and returns (also called refunds).
-      # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
-      #
-      # * Lines
-      # * Details (implies lines)
-      # * Summary (implies details)
-      # * Addresses
-      #
-      # If you don't specify '$include' parameter, it will include both details and addresses.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      #  The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will
+      #  be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number
+      #  in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with
+      #  the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all
+      #  transaction lines for them, in this case, the line number becomes: "1", "2", "3", ...
+      #
+      #  A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      #  sales, purchases, inventory transfer, and returns (also called refunds).
+      #  You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
+      #
+      #  * Lines
+      #  * Details (implies lines)
+      #  * Summary (implies details)
+      #  * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
+      #
+      #  If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
+      # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] information about the transaction and lines to be added
       # @return [Object]
-      def add_lines(model)
+      def add_lines(model, options={})
         path = "/api/v2/companies/transactions/lines/add"
-        post(path, model)
+        post(path, model, options)
       end
 
 
@@ -176,14 +178,16 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       #
-      # If you don't specify '$include' parameter, it will include both details and addresses.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
+      # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] The transaction you wish to create
       # @return [Object]
-      def create_or_adjust_transaction(model)
+      def create_or_adjust_transaction(model, options={})
         path = "/api/v2/transactions/createoradjust"
-        post(path, model)
+        post(path, model, options)
       end
 
 
@@ -205,14 +209,16 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       #
-      # If you don't specify '$include' parameter, it will include both details and addresses.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
+      # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] The transaction you wish to create
       # @return [Object]
-      def create_transaction(model)
+      def create_transaction(model, options={})
         path = "/api/v2/transactions/create"
-        post(path, model)
+        post(path, model, options)
       end
 
 
@@ -220,25 +226,27 @@ module AvaTax
       #
       # Remove lines to an existing unlocked transaction.
       #
-      # The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will
-      # be able to delete transaction lines and adjust original transaction the way they like
+      #  The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will
+      #  be able to delete transaction lines and adjust original transaction the way they like
       #
-      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
-      # sales, purchases, inventory transfer, and returns (also called refunds).
-      # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
+      #  A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      #  sales, purchases, inventory transfer, and returns (also called refunds).
+      #  You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
       #
-      # * Lines
-      # * Details (implies lines)
-      # * Summary (implies details)
-      # * Addresses
+      #  * Lines
+      #  * Details (implies lines)
+      #  * Summary (implies details)
+      #  * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       #
-      # If you don't specify '$include' parameter, it will include both details and addresses.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      #  If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
+      # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] information about the transaction and lines to be removed
       # @return [Object]
-      def delete_lines(model)
+      def delete_lines(model, options={})
         path = "/api/v2/companies/transactions/lines/delete"
-        post(path, model)
+        post(path, model, options)
       end
 
 
@@ -253,9 +261,11 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code(companyCode, transactionCode, options={})
         path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
@@ -274,10 +284,12 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
       # @param documentType [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={})
         path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
@@ -298,8 +310,10 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       # @param id [Integer] The unique ID number of the transaction to retrieve
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_id(id, options={})
         path = "/api/v2/transactions/#{id}"
@@ -322,8 +336,10 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       # @param companyCode [String] The company code of the company that recorded this transaction
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Specifies objects to include in this fetch call
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -372,16 +388,18 @@ module AvaTax
       # * Details (implies lines)
       # * Summary (implies details)
       # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
       #
-      # If you don't specify '$include' parameter, it will include both details and addresses.
+      # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
       # @param companyCode [String] The code of the company that made the original sale
       # @param transactionCode [String] The transaction code of the original sale
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] Information about the refund to create
       # @return [Object]
-      def refund_transaction(companyCode, transactionCode, model)
+      def refund_transaction(companyCode, transactionCode, model, options={})
         path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
-        post(path, model)
+        post(path, model, options)
       end
 
 
@@ -432,4 +450,4 @@ module AvaTax
 
     end
   end
-end
+end

data/lib/avatax/client/upcs.rb

@@ -8,8 +8,8 @@ module AvaTax
       # Create one or more new UPC objects attached to this company.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
       # @param companyId [Integer] The ID of the company that owns this UPC.
-      # @param model [object[]] The UPC you wish to create.
-      # @return [object[]]
+      # @param model [UPCModel[]] The UPC you wish to create.
+      # @return [UPCModel[]]
       def create_u_p_cs(companyId, model)
         path = "/api/v2/companies/#{companyId}/upcs"
         post(path, model)
@@ -21,7 +21,7 @@ module AvaTax
       # Marks the UPC object identified by this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this UPC.
       # @param id [Integer] The ID of the UPC you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_u_p_c(companyId, id)
         path = "/api/v2/companies/#{companyId}/upcs/#{id}"
         delete(path)
@@ -50,7 +50,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these UPCs
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -69,7 +69,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/users.rb

@@ -9,7 +9,7 @@ module AvaTax
       # A user represents one person with access privileges to make API calls and work with a specific account.
       # @param id [Integer] The ID of the user to retrieve.
       # @param accountId [Integer] The accountID of the user you wish to get.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Optional fetch commands.
       # @return [Object]
       def get_user(id, accountId, options={})
         path = "/api/v2/accounts/#{accountId}/users/#{id}"
@@ -51,7 +51,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param accountId [Integer] The accountID of the user you wish to list.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Optional fetch commands.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -70,7 +70,7 @@ module AvaTax
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Optional fetch commands.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '17.7.3'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '17.8.1'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 17.7.3
+  version: 17.8.1
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -146,8 +146,11 @@ files:
 - lib/avatax/client/accounts.rb
 - lib/avatax/client/addresses.rb
 - lib/avatax/client/batches.rb
+- lib/avatax/client/certexpressinvites.rb
+- lib/avatax/client/certificates.rb
 - lib/avatax/client/companies.rb
 - lib/avatax/client/contacts.rb
+- lib/avatax/client/customers.rb
 - lib/avatax/client/definitions.rb
 - lib/avatax/client/filingcalendars.rb
 - lib/avatax/client/filings.rb
@@ -161,6 +164,7 @@ files:
 - lib/avatax/client/onboarding.rb
 - lib/avatax/client/pointofsale.rb
 - lib/avatax/client/registrar.rb
+- lib/avatax/client/reports.rb
 - lib/avatax/client/settings.rb
 - lib/avatax/client/subscriptions.rb
 - lib/avatax/client/taxcodes.rb