avatax 17.7.3 → 17.8.1

data/lib/avatax/client/companies.rb

@@ -53,8 +53,8 @@ module AvaTax
       # Create one or more new company objects.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
       # You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
-      # @param model [object[]] Either a single company object or an array of companies to create
-      # @return [object[]]
+      # @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)
@@ -86,7 +86,7 @@ module AvaTax
       #
       # Deleting a company will delete all child companies, and all users attached to this company.
       # @param id [Integer] The ID of the company you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_company(id)
         path = "/api/v2/companies/#{id}"
         delete(path)
@@ -107,9 +107,8 @@ module AvaTax
       #  * TaxCodes
       #  * TaxRules
       #  * UPC
-      #  * ECMS
       # @param id [Integer] The ID of the company to retrieve.
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @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", 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}"
@@ -117,16 +116,6 @@ module AvaTax
       end
 
 
-      # 
-      #
-      # 
-      # @return [FetchResult]
-      def get_company()
-        path = "/api/v2/companies/mrs"
-        get(path)
-      end
-
-
       # Get configuration settings for this company
       #
       # Retrieve a list of all configuration settings tied to this company.
@@ -142,7 +131,7 @@ module AvaTax
       # Avalara-based account settings for `AvaCertServiceConfig` affect your account's exemption certificate
       # processing, and should only be changed with care.
       # @param id [Integer] 
-      # @return [object[]]
+      # @return [CompanyConfigurationModel[]]
       def get_company_configuration(id)
         path = "/api/v2/companies/#{id}/configuration"
         get(path)
@@ -179,13 +168,25 @@ module AvaTax
       # Returns a list of funding setup requests and their current status.
       # Each object in the result is a request that was made to setup or adjust funding configuration for this company.
       # @param id [Integer] The unique identifier of the company
-      # @return [object[]]
+      # @return [FundingStatusModel[]]
       def list_funding_requests_by_company(id)
         path = "/api/v2/companies/#{id}/funding"
         get(path)
       end
 
 
+      # Retrieve a list of MRS Companies with account
+      #
+      # This API is available by invitation only.
+      #
+      # Get a list of companies with an active MRS service.
+      # @return [FetchResult]
+      def list_mrs_companies()
+        path = "/api/v2/companies/mrs"
+        get(path)
+      end
+
+
       # Retrieve all companies
       #
       # Get multiple company objects.
@@ -202,8 +203,7 @@ module AvaTax
       # * TaxCodes
       # * TaxRules
       # * UPC
-      # * ECMS
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
       # @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.
@@ -230,8 +230,8 @@ module AvaTax
       # Avalara-based account settings for `AvaCertServiceConfig` affect your account's exemption certificate
       # processing, and should only be changed with care.
       # @param id [Integer] 
-      # @param model [object[]] 
-      # @return [object[]]
+      # @param model [CompanyConfigurationModel[]] 
+      # @return [CompanyConfigurationModel[]]
       def set_company_configuration(id, model)
         path = "/api/v2/companies/#{id}/configuration"
         post(path, model)

data/lib/avatax/client/contacts.rb

@@ -9,8 +9,8 @@ module AvaTax
       # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
       # a tax collecting and filing entity.
       # @param companyId [Integer] The ID of the company that owns this contact.
-      # @param model [object[]] The contacts you wish to create.
-      # @return [object[]]
+      # @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)
@@ -22,7 +22,7 @@ module AvaTax
       # Mark the existing contact object at this URL as deleted.
       # @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 [object[]]
+      # @return [ErrorDetail[]]
       def delete_contact(companyId, id)
         path = "/api/v2/companies/#{companyId}/contacts/#{id}"
         delete(path)
@@ -51,7 +51,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these contacts
       # @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`.
@@ -71,7 +71,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/customers.rb

@@ -0,0 +1,195 @@
+module AvaTax
+  class Client
+    module Customers 
+
+
+      # Create customers for this company
+      #
+      # Create one or more customers for this company.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param model [CustomerModel[]] The list of customer objects to be created
+      # @return [CustomerModel[]]
+      def create_customers(companyId, model)
+        path = "/api/v2/companies/#{companyId}/customers"
+        post(path, model)
+      end
+
+
+      # Delete a customer record
+      #
+      # Deletes the customer object referenced by this URL.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @return [Object]
+      def delete_customer(companyId, customerCode)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
+        delete(path)
+      end
+
+
+      # Retrieve a single customer
+      #
+      # Retrieve the customer identified by this URL.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this customer object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      #
+      # You can use the `$include` parameter to fetch the following additional objects for expansion:
+      #
+      # * Certificates - Fetch a list of certificates linked to this customer.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param include [String] Specify optional additional objects to include in this fetch request
+      # @return [Object]
+      def get_customer(companyId, customerCode, options={})
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
+        get(path, options)
+      end
+
+
+      # Link certificates to a customer
+      #
+      # Link one or more certificates to a customer.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param model [Object] The list of certificates to link to this customer
+      # @return [FetchResult]
+      def link_certificates_to_customer(companyId, customerCode, model)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/link"
+        post(path, model)
+      end
+
+
+      # List certificates linked to a customer
+      #
+      # List all certificates linked to a customer.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @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 list_certificates_for_customer(companyId, customerCode, options={})
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
+        get(path, options)
+      end
+
+
+      # List active certificates for a location
+      #
+      # List valid certificates linked to a customer in a particular country and region.
+      #
+      # This API is intended to help identify whether a customer has already provided a certificate that
+      # applies to a particular country and region. This API is intended to help you remind a customer
+      # when they have or have not provided copies of their exemption certificates to you during the sales
+      # order process.
+      #
+      # If a customer does not have a certificate on file and they wish to provide one, you should send the customer
+      # a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please
+      # see the `CreateCertExpressInvitation` API to create an invitation link for this customer.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
+      # @param region [String] Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.
+      # @return [Object]
+      def list_valid_certificates_for_customer(companyId, customerCode, country, region)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/#{country}/#{region}"
+        get(path)
+      end
+
+
+      # List all customers for this company
+      #
+      # List all customers recorded by this company matching the specified criteria.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      #
+      # You can use the `$include` parameter to fetch the following additional objects for expansion:
+      #
+      # * Certificates - Fetch a list of certificates linked to this customer.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
+      # @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_customers(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/customers"
+        get(path, options)
+      end
+
+
+      # Unlink certificates from a customer
+      #
+      # Remove one or more certificates to a customer.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param model [Object] The list of certificates to link to this customer
+      # @return [FetchResult]
+      def unlink_certificates_from_customer(companyId, customerCode, model)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/unlink"
+        post(path, model)
+      end
+
+
+      # Update a single customer
+      #
+      # Replace the customer object at this URL with a new record.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
+      # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param model [Object] The new customer model that will replace the existing record at this URL
+      # @return [Object]
+      def update_customer(companyId, customerCode, model)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/definitions.rb

@@ -34,11 +34,62 @@ module AvaTax
       end
 
 
+      # List certificate attributes used by a company
+      #
+      # List the certificate attributes defined by a company.
+      #
+      # A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
+      # certificate at any 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_certificate_attributes(options={})
+        path = "/api/v2/definitions/certificateattributes"
+        get(path, options)
+      end
+
+
+      # List certificate attributes used by a company
+      #
+      # List the certificate exempt reasons defined by a company.
+      #
+      # An exemption reason defines why a certificate allows a customer to be exempt
+      # for purposes of tax calculation.
+      # @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_certificate_exempt_reasons(options={})
+        path = "/api/v2/definitions/certificateexemptreasons"
+        get(path, options)
+      end
+
+
+      # List certificate exposure zones used by a company
+      #
+      # List the certificate exposure zones defined by a company.
+      #
+      # An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
+      # authority or other legal entity to which a certificate may apply.
+      # @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_certificate_exposure_zones(options={})
+        path = "/api/v2/definitions/certificateexposurezones"
+        get(path, options)
+      end
+
+
       # Retrieve the full list of communications transactiontypes
       #
       # Returns full list of communications transaction types which
       # are accepted in communication tax calculation requests.
-      # @param id [Integer] 
+      # @param id [Integer] The transaction type ID to examine
       # @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.
@@ -96,6 +147,24 @@ module AvaTax
       end
 
 
+      # List certificate exposure zones used by a company
+      #
+      # List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
+      #
+      # The CoverLetter model represents a message sent along with an invitation to use CertExpress to
+      # upload certificates. An invitation allows customers to use CertExpress to upload their exemption
+      # certificates directly; this cover letter explains why the invitation was sent.
+      # @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_cover_letters(options={})
+        path = "/api/v2/definitions/coverletters"
+        get(path, options)
+      end
+
+
       # Retrieve the full list of Avalara-supported entity use codes
       #
       # Returns the full list of Avalara-supported entity use codes.
@@ -500,7 +569,7 @@ module AvaTax
       #
       # Returns the full list of Avalara-supported rate type file types
       # This API is intended to be useful to identify all the different rate types.
-      # @param country [String] 
+      # @param country [String] The country to examine for rate types
       # @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.

data/lib/avatax/client/filingcalendars.rb

@@ -40,7 +40,7 @@ module AvaTax
       # are reviewed and validated by Avalara Compliance before being implemented.
       # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
       # @param id [Integer] The unique ID number of the filing calendar to cancel
-      # @param model [object[]] The cancellation request for this filing calendar
+      # @param model [FilingRequestModel[]] The cancellation request for this filing calendar
       # @return [Object]
       def cancel_filing_requests(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/request"
@@ -54,7 +54,7 @@ module AvaTax
       # A "filing request" represents a request to change an existing filing calendar. Filing requests
       # are reviewed and validated by Avalara Compliance before being implemented.
       # @param companyId [Integer] The unique ID of the company that will add the new filing calendar
-      # @param model [object[]] Information about the proposed new filing calendar
+      # @param model [FilingRequestModel[]] Information about the proposed new filing calendar
       # @return [Object]
       def create_filing_requests(companyId, model)
         path = "/api/v2/companies/#{companyId}/filingcalendars/add/request"
@@ -67,7 +67,7 @@ module AvaTax
       # This API is available by invitation only.
       # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
       # @param formCode [String] The unique code of the form
-      # @return [object[]]
+      # @return [CycleAddOptionModel[]]
       def cycle_safe_add(companyId, options={})
         path = "/api/v2/companies/#{companyId}/filingcalendars/add/options"
         get(path, options)
@@ -79,7 +79,7 @@ module AvaTax
       # This API is available by invitation only.
       # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
       # @param id [Integer] The unique ID of the filing calendar object
-      # @param model [object[]] A list of filing calendar edits to be made
+      # @param model [FilingCalendarEditModel[]] A list of filing calendar edits to be made
       # @return [Object]
       def cycle_safe_edit(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/options"
@@ -107,7 +107,7 @@ module AvaTax
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this filing calendar.
       # @param id [Integer] The ID of the filing calendar you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_filing_calendar(companyId, id)
         path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
         delete(path)
@@ -208,8 +208,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.
       # @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`.
-      # @param returnCountry [String] 
-      # @param returnRegion [String] 
+      # @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
+      # @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
       # @return [FetchResult]
       def query_filing_calendars(options={})
         path = "/api/v2/filingcalendars"
@@ -247,7 +247,7 @@ module AvaTax
       # to modify the value of a filing calendar using this API.
       # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
       # @param id [Integer] The unique ID number of the filing calendar to edit
-      # @param model [object[]] A list of filing calendar edits to be made
+      # @param model [FilingRequestModel[]] A list of filing calendar edits to be made
       # @return [Object]
       def request_filing_calendar_update(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/request"