avatax 17.7.3 → 17.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f91622695347c4040a71f175e5b217c4a90049a2
-  data.tar.gz: 4fdcbb988386306d7d8d1e4871fcc7b8a8cfdb01
+  metadata.gz: 9ff123feb21d5c4095101de3bd2374dd451eb3dd
+  data.tar.gz: 8d30daf442c6dc18fa66195e305c128d83cdc6a2
 SHA512:
-  metadata.gz: bd4cc8cefb18f556b6dbe8bf29375bed4da326c282bbfc74c4763b810b82a807836a9fa3daed3c445c1d18977f04f3cf91aae4c217a78f3d7705576ee86e43c3
-  data.tar.gz: fba6bea77a3fc36619eb1efe3accd0561137c0ff8655493e4f79f3a8c397c3b7b2e5467a0bd951dba7af104385c71a0bedc56e41f68086a074d7e148335d2528
+  metadata.gz: 36a96bbe9fa0cddb55147de9f7be3a14cf911537e6ae6327dafe10451b0df9ed9aee082d7246951cbcb645909aa705b918f46f88bc868e515fc6b16c04e06a54
+  data.tar.gz: 6879d45e224836daddd1e4869bc2c6871e00e3926d924d8c84dfae254035687edaa4a7b959238a09bf0dd0d42df9f346c891d0785b97b8dcd554dbbc736a8dd6

data/lib/avatax/client/accounts.rb

@@ -27,7 +27,7 @@ module AvaTax
       # If you have not read or accepted the terms and conditions, this API call will return the
       # unchanged account model.
       # @param id [Integer] The ID of the account to activate
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] Elements to include when fetching the account
       # @param model [Object] The activation request
       # @return [Object]
       def activate_account(id, model, options={})
@@ -44,7 +44,7 @@ module AvaTax
       # * Subscriptions
       # * Users
       # @param id [Integer] The ID of the account to retrieve
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of special fetch options
       # @return [Object]
       def get_account(id, options={})
         path = "/api/v2/accounts/#{id}"
@@ -67,7 +67,7 @@ module AvaTax
       # Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
       # tax calculation and address resolution, and should only be changed with care.
       # @param id [Integer] 
-      # @return [object[]]
+      # @return [AccountConfigurationModel[]]
       def get_account_configuration(id)
         path = "/api/v2/accounts/#{id}/configuration"
         get(path)
@@ -89,8 +89,8 @@ module AvaTax
       # Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
       # tax calculation and address resolution, and should only be changed with care.
       # @param id [Integer] 
-      # @param model [object[]] 
-      # @return [object[]]
+      # @param model [AccountConfigurationModel[]] 
+      # @return [AccountConfigurationModel[]]
       def set_account_configuration(id, model)
         path = "/api/v2/accounts/#{id}/configuration"
         post(path, model)

data/lib/avatax/client/batches.rb

@@ -10,8 +10,8 @@ module AvaTax
       # You may fetch a batch to check on its status and retrieve the results of the batch operation.
       # Each batch object may have one or more file objects (currently only one file is supported).
       # @param companyId [Integer] The ID of the company that owns this batch.
-      # @param model [object[]] The batch you wish to create.
-      # @return [object[]]
+      # @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)
@@ -23,7 +23,7 @@ module AvaTax
       # 
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param id [Integer] The ID of the batch you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_batch(companyId, id)
         path = "/api/v2/companies/#{companyId}/batches/#{id}"
         delete(path)
@@ -68,7 +68,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these batches
       # @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`.
@@ -89,7 +89,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/certexpressinvites.rb

@@ -0,0 +1,77 @@
+module AvaTax
+  class Client
+    module CertExpressInvites 
+
+
+      # Create a CertExpress invitation
+      #
+      # Creates an invitation for a customer to self-report certificates using the CertExpress website.
+      #
+      # This invitation is delivered by your choice of method, or you can present a hyperlink to the user
+      # directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where
+      # they can follow a step-by-step guide to enter information about their exemption certificates. The
+      # certificates entered will be recorded and automatically linked to their customer record.
+      #
+      # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
+      # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
+      # your company so that they can be used for tax exemptions.
+      # @param companyId [Integer] The unique ID number of the company that will record certificates
+      # @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
+
+
+      # Retrieve a single CertExpress invitation
+      #
+      # Retrieve an existing CertExpress invitation sent to a customer.
+      #
+      # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
+      # about their certificates. This step by step guide allows the customer to complete and upload the full
+      # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
+      # they will automatically be recorded to your company and linked to the customer record.
+      #
+      # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
+      # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
+      # your company so that they can be used for tax exemptions.
+      # @param companyId [Integer] The unique ID number of the company that issued this invitation
+      # @param customerCode [String] The number of the customer where the request is sent to
+      # @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
+
+
+      # List CertExpress invitations
+      #
+      # Retrieve CertExpress invitations sent by this company.
+      #
+      # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
+      # about their certificates. This step by step guide allows the customer to complete and upload the full
+      # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
+      # they will automatically be recorded to your company and linked to the customer record.
+      #
+      # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
+      # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
+      # your company so that they can be used for tax exemptions.
+      # @param companyId [Integer] The unique ID number of the company that issued this invitation
+      # @param include [String] OPTIONAL: A comma separated list of special fetch options.       No options are defined at this time.
+      # @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.
+      # @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
+
+    end
+  end
+end

data/lib/avatax/client/certificates.rb

@@ -0,0 +1,291 @@
+module AvaTax
+  class Client
+    module Certificates 
+
+
+      # Create certificates for this company
+      #
+      # Record one or more certificates document for this company.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      #
+      # When you create a certificate, it will be processed by Avalara and will become available for use in
+      # 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
+      # * A link to the customer that is allowed to use this certificate
+      # * Your tax transaction must contain the correct customer code
+      # @param companyId [Integer] The ID number of the company recording this certificate
+      # @param model [CertificateModel[]] Certificates to be created
+      # @return [CertificateModel[]]
+      def create_certificates(companyId, model)
+        path = "/api/v2/companies/#{companyId}/certificates"
+        post(path, model)
+      end
+
+
+      # Revoke and delete a certificate
+      #
+      # Revoke the certificate identified by this URL, then delete it.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      #
+      # Revoked certificates can no longer be used.
+      # @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 [Object]
+      def delete_certificate(companyId, id)
+        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
+        delete(path)
+      end
+
+
+      # Download an image for this certificate
+      #
+      # Download an image or PDF file for this certificate.
+      #
+      # This API can be used to download either a single-page preview of the certificate or a full PDF document.
+      # To retrieve a preview image, set the `$type` parameter to `Jpeg` and the `$page` parameter to `1`.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @param id [Integer] The unique ID number of this certificate
+      # @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
+
+
+      # Retrieve a single certificate
+      #
+      # Get the current certificate identified by this URL.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      #
+      # You can use the `$include` parameter to fetch the following additional objects for expansion:
+      #
+      # * Customers - Retrieves the list of customers linked to the certificate.
+      # * PoNumbers - Retrieves all PO numbers tied to the certificate.
+      # * Attributes - Retrieves all attributes applied to the certificate.
+      # @param companyId [Integer] The ID number of the company that recorded this certificate
+      # @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.   * PoNumbers - 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
+
+
+      # Link attributes to a certificate
+      #
+      # Link one or many attributes to a certificate.
+      #
+      # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
+      # certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @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
+
+
+      # Link customers to a certificate
+      #
+      # Link one or more customers to an existing certificate.
+      #
+      # Customers and certificates must be linked before a customer can make use of a certificate to obtain
+      # a tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate
+      # can be connected to multiple customer records using the `LinkCustomersToCertificate` API.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @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
+
+
+      # List all attributes applied to this certificate
+      #
+      # Retrieve the list of attributes that are linked to this certificate.
+      #
+      # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
+      # certificate at any time. The full list of defined attributes may be found using `/api/v2/definitions/certificateattributes`.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @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
+
+
+      # List customers linked to this certificate
+      #
+      # List all customers linked to this certificate.
+      #
+      # Customers must be linked to a certificate in order to make use of its tax exemption features. You
+      # can link or unlink customers to a certificate at any time.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @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
+
+
+      # List all certificates for a company
+      #
+      # List all certificates recorded by a company
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      #
+      # You can use the `$include` parameter to fetch the following additional objects for expansion:
+      #
+      # * Customers - Retrieves the list of customers linked to the certificate.
+      # * PoNumbers - Retrieves all PO numbers tied to the certificate.
+      # * Attributes - Retrieves all attributes applied to the certificate.
+      # @param companyId [Integer] The ID number of the company to search
+      # @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.   * PoNumbers - Retrieves all PO numbers tied to the certificate.   * Attributes - Retrieves all attributes applied to the certificate.
+      # @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.
+      # @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
+
+
+      # Unlink attributes from a certificate
+      #
+      # Unlink one or many attributes from a certificate.
+      #
+      # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
+      # certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @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
+
+
+      # Unlink customers from a certificate
+      #
+      # Unlinks one or more customers from a certificate.
+      #
+      # Unlinking a certificate from a customer will prevent the certificate from being used to generate
+      # tax exemptions for the customer in the future. If any previous transactions for this customer had
+      # used this linked certificate, those transactions will be unchanged and will still have a link to the
+      # exemption certificate in question.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @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
+
+
+      # Update a single certificate
+      #
+      # Replace the certificate identified by this URL with a new one.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The ID number of the company that recorded this certificate
+      # @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
+
+
+      # Upload an image or PDF attachment for this certificate
+      #
+      # Upload an image or PDF attachment for this certificate.
+      #
+      # Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please
+      # use the `PDF` data type.
+      #
+      # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
+      # can contain information about a customer's eligibility for exemption from sales or use taxes based on
+      # criteria you specify when you store the certificate. To view or manage your certificates directly, please
+      # log onto the administrative website for the product you purchased.
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @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
+
+    end
+  end
+end