avatax 20.7.0 → 20.7.1

data/lib/avatax/client/certificates.rb

@@ -35,11 +35,8 @@ module AvaTax
       # @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
       # @param model [CertificateModel[]] Certificates to be created
       # @return [CertificateModel[]]
-      def create_certificates(companyId, model, options={})
-        path = "/api/v2/companies/#{companyId}/certificates"
-        post(path, model, options)
-      end
-
+      def create_certificates(companyId, model, options={})        path = "/api/v2/companies/#{companyId}/certificates"
+        post(path, model, options)      end
 
       # Revoke and delete a certificate
       #
@@ -64,11 +61,8 @@ module AvaTax
       # @param companyId [Integer] The unique ID number of the company that recorded this certificate
       # @param id [Integer] The unique ID number of this certificate
       # @return [ErrorDetail[]]
-      def delete_certificate(companyId, id)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
-        delete(path)
-      end
-
+      def delete_certificate(companyId, id)        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
+        delete(path)      end
 
       # Download an image for this certificate
       #
@@ -96,11 +90,8 @@ module AvaTax
       # @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
       # @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
       # @return [Object]
-      def download_certificate_image(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
-        get(path, options)
-      end
-
+      def download_certificate_image(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
+        get(path, options)      end
 
       # Retrieve a single certificate
       #
@@ -130,11 +121,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.
       # @return [Object]
-      def get_certificate(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
-        get(path, options)
-      end
-
+      def get_certificate(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
+        get(path, options)      end
 
       # Check a company's exemption certificate status.
       #
@@ -152,11 +140,8 @@ module AvaTax
       # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The company ID to check
       # @return [Object]
-      def get_certificate_setup(companyId)
-        path = "/api/v2/companies/#{companyId}/certificates/setup"
-        get(path)
-      end
-
+      def get_certificate_setup(companyId)        path = "/api/v2/companies/#{companyId}/certificates/setup"
+        get(path)      end
 
       # Link attributes to a certificate
       #
@@ -183,11 +168,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
       # @return [FetchResult]
-      def link_attributes_to_certificate(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
-        post(path, model)
-      end
-
+      def link_attributes_to_certificate(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
+        post(path, model)      end
 
       # Link customers to a certificate
       #
@@ -215,11 +197,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param model [Object] The list of customers needed be added to the Certificate for exemption
       # @return [FetchResult]
-      def link_customers_to_certificate(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
-        post(path, model)
-      end
-
+      def link_customers_to_certificate(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
+        post(path, model)      end
 
       # List all attributes applied to this certificate
       #
@@ -245,11 +224,8 @@ module AvaTax
       # @param companyId [Integer] The unique ID number of the company that recorded this certificate
       # @param id [Integer] The unique ID number of this certificate
       # @return [FetchResult]
-      def list_attributes_for_certificate(companyId, id)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
-        get(path)
-      end
-
+      def list_attributes_for_certificate(companyId, id)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
+        get(path)      end
 
       # List customers linked to this certificate
       #
@@ -276,11 +252,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param include [String] OPTIONAL: A comma separated list of special fetch options.   No options are currently available when fetching customers.
       # @return [FetchResult]
-      def list_customers_for_certificate(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
-        get(path, options)
-      end
-
+      def list_customers_for_certificate(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
+        get(path, options)      end
 
       # List all certificates for a company
       #
@@ -313,11 +286,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_certificates(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/certificates"
-        get(path, options)
-      end
-
+      def query_certificates(companyId, options={})        path = "/api/v2/companies/#{companyId}/certificates"
+        get(path, options)      end
 
       # Request setup of exemption certificates for this company.
       #
@@ -337,11 +307,8 @@ module AvaTax
       # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @param companyId [Integer] 
       # @return [Object]
-      def request_certificate_setup(companyId)
-        path = "/api/v2/companies/#{companyId}/certificates/setup"
-        post(path)
-      end
-
+      def request_certificate_setup(companyId)        path = "/api/v2/companies/#{companyId}/certificates/setup"
+        post(path)      end
 
       # Unlink attributes from a certificate
       #
@@ -368,11 +335,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
       # @return [FetchResult]
-      def unlink_attributes_from_certificate(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
-        post(path, model)
-      end
-
+      def unlink_attributes_from_certificate(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
+        post(path, model)      end
 
       # Unlink customers from a certificate
       #
@@ -401,11 +365,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param model [Object] The list of customers to unlink from this certificate
       # @return [FetchResult]
-      def unlink_customers_from_certificate(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
-        post(path, model)
-      end
-
+      def unlink_customers_from_certificate(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
+        post(path, model)      end
 
       # Update a single certificate
       #
@@ -429,11 +390,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param model [Object] The new certificate object that will replace the existing one
       # @return [Object]
-      def update_certificate(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
-        put(path, model)
-      end
-
+      def update_certificate(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
+        put(path, model)      end
 
       # Upload an image or PDF attachment for this certificate
       #
@@ -460,11 +418,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this certificate
       # @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
       # @return [String]
-      def upload_certificate_image(companyId, id)
-        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
-        post(path)
-      end
-
+      def upload_certificate_image(companyId, id)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
+        post(path)      end
     end
   end
 end

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
       #
@@ -215,11 +191,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
       #
@@ -241,11 +214,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
       #
@@ -268,11 +238,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
       #
@@ -287,11 +254,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
       #
@@ -303,11 +267,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
       #
@@ -338,11 +299,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
       #
@@ -365,11 +323,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
       #
@@ -391,11 +346,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