avatax 19.12.1 → 20.1.0

data/lib/avatax/client/companies.rb

@@ -34,11 +34,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The ID of the company to check if its integration is certified.
       # @return [String]
-      def certify_integration(id)
-        path = "/api/v2/companies/#{id}/certify"
-        get(path)
-      end
-
+      def certify_integration(id)        path = "/api/v2/companies/#{id}/certify"
+        get(path)      end
 
       # Change the filing status of this company
       #
@@ -62,11 +59,8 @@ module AvaTax
       # @param id [Integer] 
       # @param model [Object] 
       # @return [String]
-      def change_filing_status(id, model)
-        path = "/api/v2/companies/#{id}/filingstatus"
-        post(path, model)
-      end
-
+      def change_filing_status(id, model)        path = "/api/v2/companies/#{id}/filingstatus"
+        post(path, model)      end
 
       # Quick setup for a company with a single physical address
       #
@@ -88,11 +82,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param model [Object] Information about the company you wish to create.
       # @return [Object]
-      def company_initialize(model)
-        path = "/api/v2/companies/initialize"
-        post(path, model)
-      end
-
+      def company_initialize(model)        path = "/api/v2/companies/initialize"
+        post(path, model)      end
 
       # Create new companies
       #
@@ -107,11 +98,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param model [CompanyModel[]] Either a single company object or an array of companies to create
       # @return [CompanyModel[]]
-      def create_companies(model)
-        path = "/api/v2/companies"
-        post(path, model)
-      end
-
+      def create_companies(model)        path = "/api/v2/companies"
+        post(path, model)      end
 
       # Request managed returns funding setup for a company
       #
@@ -133,11 +121,8 @@ module AvaTax
       # @param id [Integer] The unique identifier of the company
       # @param model [Object] The funding initialization request
       # @return [Object]
-      def create_funding_request(id, model)
-        path = "/api/v2/companies/#{id}/funding/setup"
-        post(path, model)
-      end
-
+      def create_funding_request(id, model)        path = "/api/v2/companies/#{id}/funding/setup"
+        post(path, model)      end
 
       # Delete a single company
       #
@@ -148,11 +133,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the company you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_company(id)
-        path = "/api/v2/companies/#{id}"
-        delete(path)
-      end
-
+      def delete_company(id)        path = "/api/v2/companies/#{id}"
+        delete(path)      end
 
       # Check the funding configuration of a company
       #
@@ -167,11 +149,8 @@ module AvaTax
       # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param companyId [Integer] The unique identifier of the company
       # @return [Object]
-      def funding_configuration_by_company(companyId)
-        path = "/api/v2/companies/#{companyId}/funding/configuration"
-        get(path)
-      end
-
+      def funding_configuration_by_company(companyId)        path = "/api/v2/companies/#{companyId}/funding/configuration"
+        get(path)      end
 
       # Check the funding configuration of a company
       #
@@ -187,11 +166,8 @@ module AvaTax
       # @param companyId [Integer] The unique identifier of the company
       # @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
       # @return [FundingConfigurationModel[]]
-      def funding_configurations_by_company_and_currency(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/funding/configurations"
-        get(path, options)
-      end
-
+      def funding_configurations_by_company_and_currency(companyId, options={})        path = "/api/v2/companies/#{companyId}/funding/configurations"
+        get(path, options)      end
 
       # Retrieve a single company
       #
@@ -214,11 +190,8 @@ module AvaTax
       # @param id [Integer] The ID of the company to retrieve.
       # @param include [String] OPTIONAL: A comma separated list of special fetch options.      * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules".   * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
       # @return [Object]
-      def get_company(id, options={})
-        path = "/api/v2/companies/#{id}"
-        get(path, options)
-      end
-
+      def get_company(id, options={})        path = "/api/v2/companies/#{id}"
+        get(path, options)      end
 
       # Get configuration settings for this company
       #
@@ -240,11 +213,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] 
       # @return [CompanyConfigurationModel[]]
-      def get_company_configuration(id)
-        path = "/api/v2/companies/#{id}/configuration"
-        get(path)
-      end
-
+      def get_company_configuration(id)        path = "/api/v2/companies/#{id}/configuration"
+        get(path)      end
 
       # Get this company's filing status
       #
@@ -267,11 +237,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] 
       # @return [String]
-      def get_filing_status(id)
-        path = "/api/v2/companies/#{id}/filingstatus"
-        get(path)
-      end
-
+      def get_filing_status(id)        path = "/api/v2/companies/#{id}/filingstatus"
+        get(path)      end
 
       # Check managed returns funding status for a company
       #
@@ -286,11 +253,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The unique identifier of the company
       # @return [FundingStatusModel[]]
-      def list_funding_requests_by_company(id)
-        path = "/api/v2/companies/#{id}/funding"
-        get(path)
-      end
-
+      def list_funding_requests_by_company(id)        path = "/api/v2/companies/#{id}/funding"
+        get(path)      end
 
       # Retrieve a list of MRS Companies with account
       #
@@ -302,11 +266,8 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @return [FetchResult]
-      def list_mrs_companies()
-        path = "/api/v2/companies/mrs"
-        get(path)
-      end
-
+      def list_mrs_companies()        path = "/api/v2/companies/mrs"
+        get(path)      end
 
       # Retrieve all companies
       #
@@ -336,11 +297,8 @@ module AvaTax
       # @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`.
       # @return [FetchResult]
-      def query_companies(options={})
-        path = "/api/v2/companies"
-        get(path, options)
-      end
-
+      def query_companies(options={})        path = "/api/v2/companies"
+        get(path, options)      end
 
       # Change configuration settings for this company
       #
@@ -363,11 +321,8 @@ module AvaTax
       # @param id [Integer] 
       # @param model [CompanyConfigurationModel[]] 
       # @return [CompanyConfigurationModel[]]
-      def set_company_configuration(id, model)
-        path = "/api/v2/companies/#{id}/configuration"
-        post(path, model)
-      end
-
+      def set_company_configuration(id, model)        path = "/api/v2/companies/#{id}/configuration"
+        post(path, model)      end
 
       # Update a single company
       #
@@ -389,11 +344,8 @@ module AvaTax
       # @param id [Integer] The ID of the company you wish to update.
       # @param model [Object] The company object you wish to update.
       # @return [Object]
-      def update_company(id, model)
-        path = "/api/v2/companies/#{id}"
-        put(path, model)
-      end
-
+      def update_company(id, model)        path = "/api/v2/companies/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/compliance.rb

@@ -9,11 +9,8 @@ module AvaTax
       # @param companyId [Integer] 
       # @param model [TransactionReferenceFieldModel[]] 
       # @return [FetchResult]
-      def tag_transaction(companyId, model)
-        path = "/api/v2/companies/#{companyId}/transactions/tag"
-        put(path, model)
-      end
-
+      def tag_transaction(companyId, model)        path = "/api/v2/companies/#{companyId}/transactions/tag"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/contacts.rb

@@ -15,11 +15,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this contact.
       # @param model [ContactModel[]] The contacts you wish to create.
       # @return [ContactModel[]]
-      def create_contacts(companyId, model)
-        path = "/api/v2/companies/#{companyId}/contacts"
-        post(path, model)
-      end
-
+      def create_contacts(companyId, model)        path = "/api/v2/companies/#{companyId}/contacts"
+        post(path, model)      end
 
       # Delete a single contact
       #
@@ -31,11 +28,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this contact.
       # @param id [Integer] The ID of the contact you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_contact(companyId, id)
-        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
-        delete(path)
-      end
-
+      def delete_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        delete(path)      end
 
       # Retrieve a single contact
       #
@@ -49,11 +43,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company for this contact
       # @param id [Integer] The primary key of this contact
       # @return [Object]
-      def get_contact(companyId, id)
-        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
-        get(path)
-      end
-
+      def get_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        get(path)      end
 
       # Retrieve contacts for this company
       #
@@ -71,11 +62,8 @@ module AvaTax
       # @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`.
       # @return [FetchResult]
-      def list_contacts_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/contacts"
-        get(path, options)
-      end
-
+      def list_contacts_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/contacts"
+        get(path, options)      end
 
       # Retrieve all contacts
       #
@@ -94,11 +82,8 @@ module AvaTax
       # @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`.
       # @return [FetchResult]
-      def query_contacts(options={})
-        path = "/api/v2/contacts"
-        get(path, options)
-      end
-
+      def query_contacts(options={})        path = "/api/v2/contacts"
+        get(path, options)      end
 
       # Update a single contact
       #
@@ -115,11 +100,8 @@ module AvaTax
       # @param id [Integer] The ID of the contact you wish to update
       # @param model [Object] The contact you wish to update.
       # @return [Object]
-      def update_contact(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
-        put(path, model)
-      end
-
+      def update_contact(companyId, id, model)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/customers.rb

@@ -28,11 +28,8 @@ module AvaTax
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param model [CustomerModel[]] The list of customer objects to be created
       # @return [CustomerModel[]]
-      def create_customers(companyId, model)
-        path = "/api/v2/companies/#{companyId}/customers"
-        post(path, model)
-      end
-
+      def create_customers(companyId, model)        path = "/api/v2/companies/#{companyId}/customers"
+        post(path, model)      end
 
       # Delete a customer record
       #
@@ -56,11 +53,8 @@ module AvaTax
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @return [Object]
-      def delete_customer(companyId, customerCode)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
-        delete(path)
-      end
-
+      def delete_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
+        delete(path)      end
 
       # Retrieve a single customer
       #
@@ -91,11 +85,8 @@ module AvaTax
       # @param customerCode [String] The unique code representing this customer
       # @param include [String] Specify optional additional objects to include in this fetch request
       # @return [Object]
-      def get_customer(companyId, customerCode, options={})
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
-        get(path, options)
-      end
-
+      def get_customer(companyId, customerCode, options={})        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
+        get(path, options)      end
 
       # Link attributes to a customer
       #
@@ -123,11 +114,8 @@ module AvaTax
       # @param customerCode [String] The unique code representing the current customer
       # @param model [CustomerAttributeModel[]] The list of attributes to link to the customer.
       # @return [FetchResult]
-      def link_attributes_to_customer(companyId, customerCode, model)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/link"
-        put(path, model)
-      end
-
+      def link_attributes_to_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/link"
+        put(path, model)      end
 
       # Link certificates to a customer
       #
@@ -152,11 +140,8 @@ module AvaTax
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The list of certificates to link to this customer
       # @return [FetchResult]
-      def link_certificates_to_customer(companyId, customerCode, model)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/link"
-        post(path, model)
-      end
-
+      def link_certificates_to_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/link"
+        post(path, model)      end
 
       # Link two customer records together
       #
@@ -182,11 +167,8 @@ module AvaTax
       # @param code [String] The code of the bill-to customer to link.
       # @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
       # @return [Object]
-      def link_ship_to_customers_to_bill_customer(companyId, code, model)
-        path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
-        post(path, model)
-      end
-
+      def link_ship_to_customers_to_bill_customer(companyId, code, model)        path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
+        post(path, model)      end
 
       # Retrieve a customer's attributes
       #
@@ -213,11 +195,8 @@ module AvaTax
       # @param companyId [Integer] The unique ID number of the company that recorded the provided customer
       # @param customerCode [String] The unique code representing the current customer
       # @return [FetchResult]
-      def list_attributes_for_customer(companyId, customerCode)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes"
-        get(path)
-      end
-
+      def list_attributes_for_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes"
+        get(path)      end
 
       # List certificates linked to a customer
       #
@@ -246,11 +225,8 @@ module AvaTax
       # @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`.
       # @return [FetchResult]
-      def list_certificates_for_customer(companyId, customerCode, options={})
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
-        get(path, options)
-      end
-
+      def list_certificates_for_customer(companyId, customerCode, options={})        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
+        get(path, options)      end
 
       # List valid certificates for a location
       #
@@ -279,11 +255,8 @@ module AvaTax
       # @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
       # @param region [String] Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.
       # @return [Object]
-      def list_valid_certificates_for_customer(companyId, customerCode, country, region)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/#{country}/#{region}"
-        get(path)
-      end
-
+      def list_valid_certificates_for_customer(companyId, customerCode, country, region)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/#{country}/#{region}"
+        get(path)      end
 
       # List all customers for this company
       #
@@ -316,11 +289,8 @@ module AvaTax
       # @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`.
       # @return [FetchResult]
-      def query_customers(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/customers"
-        get(path, options)
-      end
-
+      def query_customers(companyId, options={})        path = "/api/v2/companies/#{companyId}/customers"
+        get(path, options)      end
 
       # Unlink attributes from a customer
       #
@@ -348,11 +318,8 @@ module AvaTax
       # @param customerCode [String] The unique code representing the current customer
       # @param model [CustomerAttributeModel[]] The list of attributes to unlink from the customer.
       # @return [FetchResult]
-      def unlink_attributes_from_customer(companyId, customerCode, model)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/unlink"
-        put(path, model)
-      end
-
+      def unlink_attributes_from_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/unlink"
+        put(path, model)      end
 
       # Unlink certificates from a customer
       #
@@ -377,11 +344,8 @@ module AvaTax
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The list of certificates to link to this customer
       # @return [FetchResult]
-      def unlink_certificates_from_customer(companyId, customerCode, model)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/unlink"
-        post(path, model)
-      end
-
+      def unlink_certificates_from_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/unlink"
+        post(path, model)      end
 
       # Update a single customer
       #
@@ -406,11 +370,8 @@ module AvaTax
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The new customer model that will replace the existing record at this URL
       # @return [Object]
-      def update_customer(companyId, customerCode, model)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
-        put(path, model)
-      end
-
+      def update_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
+        put(path, model)      end
     end
   end
 end