certificates.rb in avatax-18.1.2

- old
+ new

@@ -17,10 +17,13 @@
       # 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
+      #
+      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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"
@@ -36,10 +39,13 @@
       # 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.
+      #
+      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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}"
@@ -56,10 +62,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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]
@@ -81,10 +90,13 @@
       # 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.
+      #
+      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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={})
@@ -102,10 +114,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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)
@@ -124,10 +139,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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)
@@ -145,10 +163,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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"
@@ -165,10 +186,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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={})
@@ -189,10 +213,13 @@
       # 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.
+      #
+      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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.
@@ -213,10 +240,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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)
@@ -236,10 +266,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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)
@@ -254,10 +287,13 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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)
@@ -275,9 +311,12 @@
       #
       # 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 may experience up to a three minute delay on your very first call to the exemption related endpoints
+      # (as your account gets provisioned). Thank you for your patience.
       # @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)
\ No newline at end of file