lib/avatax/client/certificates.rb in avatax-22.11.0 vs lib/avatax/client/certificates.rb in avatax-23.1.0

- old
+ new

@@ -35,11 +35,11 @@ # @param companyId [Integer] The ID number of the company recording this certificate # @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, "22.11.0") end + post(path, model, options, "23.1.0") end # Revoke and delete a certificate # # Revoke the certificate identified by this URL, then delete it. # @@ -62,11 +62,11 @@ # Swagger Name: AvaTaxClient # @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, {}, "22.11.0") end + delete(path, {}, "23.1.0") end # Download an image for this certificate # # Download an image or PDF file for this certificate. # @@ -92,11 +92,11 @@ # @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, "22.11.0") end + get(path, options, "23.1.0") end # Retrieve a single certificate # # Get the current certificate identified by this URL. # @@ -124,11 +124,11 @@ # @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. * 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, "22.11.0") end + get(path, options, "23.1.0") end # Check a company's exemption certificate status. # # Checks whether this company is configured to use exemption certificates in AvaTax. # @@ -144,11 +144,11 @@ # * This API depends on the following active services:*Required* (all): AvaTaxPro. # Swagger Name: AvaTaxClient # @param companyId [Integer] The company ID to check # @return [Object] def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup" - get(path, {}, "22.11.0") end + get(path, {}, "23.1.0") end # Link attributes to a certificate # # Link one or many attributes to a certificate. # @@ -173,11 +173,11 @@ # @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, {}, "22.11.0") end + post(path, model, {}, "23.1.0") end # Link customers to a certificate # # Link one or more customers to an existing certificate. # @@ -203,11 +203,11 @@ # @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, {}, "22.11.0") end + post(path, model, {}, "23.1.0") end # List all attributes applied to this certificate # # Retrieve the list of attributes that are linked to this certificate. # @@ -231,11 +231,11 @@ # Swagger Name: AvaTaxClient # @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, {}, "22.11.0") end + get(path, {}, "23.1.0") end # List customers linked to this certificate # # List all customers linked to this certificate. # @@ -260,11 +260,11 @@ # @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, "22.11.0") end + get(path, options, "23.1.0") end # List all certificates for a company # # List all certificates recorded by a company # @@ -295,11 +295,11 @@ # @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. # @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, "22.11.0") end + get(path, options, "23.1.0") end # Request setup of exemption certificates for this company. # # Requests the setup of exemption certificates for this company. # @@ -317,11 +317,11 @@ # * This API depends on the following active services:*Required* (all): AvaTaxPro. # Swagger Name: AvaTaxClient # @param companyId [Integer] # @return [Object] def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup" - post(path, {}, "22.11.0") end + post(path, {}, "23.1.0") end # Unlink attributes from a certificate # # Unlink one or many attributes from a certificate. # @@ -346,11 +346,11 @@ # @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, {}, "22.11.0") end + post(path, model, {}, "23.1.0") end # Unlink customers from a certificate # # Unlinks one or more customers from a certificate. # @@ -377,11 +377,11 @@ # @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, {}, "22.11.0") end + post(path, model, {}, "23.1.0") end # Update a single certificate # # Replace the certificate identified by this URL with a new one. # @@ -403,11 +403,11 @@ # @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, {}, "22.11.0") end + put(path, model, {}, "23.1.0") end # Upload an image or PDF attachment for this certificate # # Upload an image or PDF attachment for this certificate. # @@ -432,9 +432,9 @@ # @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, {}, "22.11.0") end + post(path, {}, "23.1.0") end end end end \ No newline at end of file