avatax 19.12.1 → 20.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff5274ac366293a11972b289c96588846c783d119a90a3d9b4efde14afc1c77b
-  data.tar.gz: 9e121b02bebe73c0a28329f9b877de7fb200f1595d2d422e1ab8ddd65267a191
+  metadata.gz: e7d37ceebb222ef7471de79d08a99f2b440ee47e9281ede86a961652862c4fd9
+  data.tar.gz: 1024e3322a80760e52ac3242ca191f5aa231f075080b1216a132d5a40c6b3558
 SHA512:
-  metadata.gz: 51e03ea02329b58fba05cafa8fedfa5671ea6d4ff1652b2b056f2ba29cf498da5b20c4c1fe1f09e89fa1679cceb61be4be7a75f5e0ee337290fde609909dcd33
-  data.tar.gz: df5e539ac345595f63ec84af85abed40da6c876c5843c2f350e83f8f9f250d77a049ec70130cad5b2bdafe1cc6e625cfffe4b13e8bf8ca659f299cbf9e274e02
+  metadata.gz: 314bdf15f97c150b092423d6417ab470d7886ac37a5b87fb1e083c3906ddd45c47b678f3aa21981154939f3f5c80aaf383fc51ceb38977d531f0d456804b0f34
+  data.tar.gz: 49ad1fe4601e904941c8fcae8d2660aa31dc11680578ef2a0cf65384ceadb83fd24074fbd9e1941bd4aac96927698b51da14819063db40fb44da8749b998b224

data/lib/avatax/client/accounts.rb

@@ -24,11 +24,8 @@ module AvaTax
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] A request confirming that you wish to reset the license key of this account.
       # @return [Object]
-      def account_reset_license_key(id, model)
-        path = "/api/v2/accounts/#{id}/resetlicensekey"
-        post(path, model)
-      end
-
+      def account_reset_license_key(id, model)        path = "/api/v2/accounts/#{id}/resetlicensekey"
+        post(path, model)      end
 
       # Activate an account by accepting terms and conditions
       #
@@ -49,11 +46,8 @@ module AvaTax
       # @param id [Integer] The ID of the account to activate
       # @param model [Object] The activation request
       # @return [Object]
-      def activate_account(id, model)
-        path = "/api/v2/accounts/#{id}/activate"
-        post(path, model)
-      end
-
+      def activate_account(id, model)        path = "/api/v2/accounts/#{id}/activate"
+        post(path, model)      end
 
       # Retrieve audit history for an account.
       #
@@ -81,11 +75,8 @@ module AvaTax
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @return [FetchResult]
-      def audit_account(id, options={})
-        path = "/api/v2/accounts/#{id}/audit"
-        get(path, options)
-      end
-
+      def audit_account(id, options={})        path = "/api/v2/accounts/#{id}/audit"
+        get(path, options)      end
 
       # Retrieve a single account
       #
@@ -101,11 +92,8 @@ module AvaTax
       # @param id [Integer] The ID of the account to retrieve
       # @param include [String] A comma separated list of special fetch options
       # @return [Object]
-      def get_account(id, options={})
-        path = "/api/v2/accounts/#{id}"
-        get(path, options)
-      end
-
+      def get_account(id, options={})        path = "/api/v2/accounts/#{id}"
+        get(path, options)      end
 
       # Get configuration settings for this account
       #
@@ -127,11 +115,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 [AccountConfigurationModel[]]
-      def get_account_configuration(id)
-        path = "/api/v2/accounts/#{id}/configuration"
-        get(path)
-      end
-
+      def get_account_configuration(id)        path = "/api/v2/accounts/#{id}/configuration"
+        get(path)      end
 
       # Retrieve all accounts
       #
@@ -157,11 +142,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_accounts(options={})
-        path = "/api/v2/accounts"
-        get(path, options)
-      end
-
+      def query_accounts(options={})        path = "/api/v2/accounts"
+        get(path, options)      end
 
       # Change configuration settings for this account
       #
@@ -184,11 +166,8 @@ module AvaTax
       # @param id [Integer] 
       # @param model [AccountConfigurationModel[]] 
       # @return [AccountConfigurationModel[]]
-      def set_account_configuration(id, model)
-        path = "/api/v2/accounts/#{id}/configuration"
-        post(path, model)
-      end
-
+      def set_account_configuration(id, model)        path = "/api/v2/accounts/#{id}/configuration"
+        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/addresses.rb

@@ -30,11 +30,8 @@ module AvaTax
       # @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
       # @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
       # @return [Object]
-      def resolve_address(options={})
-        path = "/api/v2/addresses/resolve"
-        get(path, options)
-      end
-
+      def resolve_address(options={})        path = "/api/v2/addresses/resolve"
+        get(path, options)      end
 
       # Retrieve geolocation information for a specified address
       #
@@ -51,11 +48,8 @@ module AvaTax
       # * This API depends on the following active services<br />*Required* (all): AutoAddress.
       # @param model [Object] The address to resolve
       # @return [Object]
-      def resolve_address_post(model)
-        path = "/api/v2/addresses/resolve"
-        post(path, model)
-      end
-
+      def resolve_address_post(model)        path = "/api/v2/addresses/resolve"
+        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/avafileforms.rb

@@ -14,11 +14,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 model [AvaFileFormModel[]] The AvaFileForm you wish to create.
       # @return [AvaFileFormModel[]]
-      def create_ava_file_forms(model)
-        path = "/api/v2/avafileforms"
-        post(path, model)
-      end
-
+      def create_ava_file_forms(model)        path = "/api/v2/avafileforms"
+        post(path, model)      end
 
       # Delete a single AvaFileForm
       #
@@ -30,11 +27,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 id [Integer] The ID of the AvaFileForm you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_ava_file_form(id)
-        path = "/api/v2/avafileforms/#{id}"
-        delete(path)
-      end
-
+      def delete_ava_file_form(id)        path = "/api/v2/avafileforms/#{id}"
+        delete(path)      end
 
       # Retrieve a single AvaFileForm
       #
@@ -46,11 +40,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 id [Integer] The primary key of this AvaFileForm
       # @return [Object]
-      def get_ava_file_form(id)
-        path = "/api/v2/avafileforms/#{id}"
-        get(path)
-      end
-
+      def get_ava_file_form(id)        path = "/api/v2/avafileforms/#{id}"
+        get(path)      end
 
       # Retrieve all AvaFileForms
       #
@@ -66,11 +57,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_ava_file_forms(options={})
-        path = "/api/v2/avafileforms"
-        get(path, options)
-      end
-
+      def query_ava_file_forms(options={})        path = "/api/v2/avafileforms"
+        get(path, options)      end
 
       # Update a AvaFileForm
       #
@@ -84,11 +72,8 @@ module AvaTax
       # @param id [Integer] The ID of the AvaFileForm you wish to update
       # @param model [Object] The AvaFileForm model you wish to update.
       # @return [Object]
-      def update_ava_file_form(id, model)
-        path = "/api/v2/avafileforms/#{id}"
-        put(path, model)
-      end
-
+      def update_ava_file_form(id, model)        path = "/api/v2/avafileforms/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/batches.rb

@@ -31,11 +31,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param model [BatchModel[]] The batch you wish to create.
       # @return [BatchModel[]]
-      def create_batches(companyId, model)
-        path = "/api/v2/companies/#{companyId}/batches"
-        post(path, model)
-      end
-
+      def create_batches(companyId, model)        path = "/api/v2/companies/#{companyId}/batches"
+        post(path, model)      end
 
       # Delete a single batch
       #
@@ -56,11 +53,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param id [Integer] The ID of the batch to delete.
       # @return [ErrorDetail[]]
-      def delete_batch(companyId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        delete(path)
-      end
-
+      def delete_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        delete(path)      end
 
       # Download a single batch file
       #
@@ -73,11 +67,8 @@ module AvaTax
       # @param batchId [Integer] The ID of the batch object
       # @param id [Integer] The primary key of this batch file object
       # @return [Object]
-      def download_batch(companyId, batchId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
-        get(path)
-      end
-
+      def download_batch(companyId, batchId, id)        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
+        get(path)      end
 
       # Retrieve a single batch
       #
@@ -103,11 +94,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch
       # @param id [Integer] The primary key of this batch
       # @return [Object]
-      def get_batch(companyId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        get(path)
-      end
-
+      def get_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        get(path)      end
 
       # Retrieve all batches for this company
       #
@@ -143,11 +131,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_batches_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/batches"
-        get(path, options)
-      end
-
+      def list_batches_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/batches"
+        get(path, options)      end
 
       # Retrieve all batches
       #
@@ -179,11 +164,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_batches(options={})
-        path = "/api/v2/batches"
-        get(path, options)
-      end
-
+      def query_batches(options={})        path = "/api/v2/batches"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/certexpressinvites.rb

@@ -29,11 +29,8 @@ module AvaTax
       # @param customerCode [String] The number of the customer where the request is sent to
       # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
       # @return [CertExpressInvitationStatusModel[]]
-      def create_cert_express_invitation(companyId, customerCode, model)
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
-        post(path, model)
-      end
-
+      def create_cert_express_invitation(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
+        post(path, model)      end
 
       # Retrieve a single CertExpress invitation
       #
@@ -62,11 +59,8 @@ module AvaTax
       # @param id [Integer] The unique ID number of this CertExpress invitation
       # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
       # @return [Object]
-      def get_cert_express_invitation(companyId, customerCode, id, options={})
-        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
-        get(path, options)
-      end
-
+      def get_cert_express_invitation(companyId, customerCode, id, options={})        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
+        get(path, options)      end
 
       # List CertExpress invitations
       #
@@ -97,11 +91,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_cert_express_invitations(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/certexpressinvites"
-        get(path, options)
-      end
-
+      def list_cert_express_invitations(companyId, options={})        path = "/api/v2/companies/#{companyId}/certexpressinvites"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/certificates.rb

@@ -16,7 +16,7 @@ module AvaTax
       # calculating tax exemptions when processing is complete. For a certificate to be used in calculating exemptions,
       # it must have the following:
       #
-      # * A list of exposure zones indicating where the certificate is valid
+      # * An exposure zone indicating where the certificate is valid
       # * A link to the customer that is allowed to use this certificate
       # * Your tax transaction must contain the correct customer code
       #
@@ -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