avatax 19.12.0 → 20.7.0

data/lib/avatax/client/reports.rb

@@ -1,110 +1,110 @@
-module AvaTax
-  class Client
-    module Reports 
-
-
-      # Download a report
-      #
-      # This API downloads the file associated with a report.
-      #
-      # If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
-      # use the `GetReport` API.
-      #
-      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
-      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
-      #
-      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
-      # * In the result of the Initiate API, you receive back a report's `id` value.
-      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
-      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
-      #
-      # This API works for all report types.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param id [Integer] The unique ID number of this report
-      # @return [Object]
-      def download_report(id)
-        path = "/api/v2/reports/#{id}/attachment"
-        get(path)
-      end
-
-
-      # Retrieve a single report
-      #
-      # Retrieve a single report by its unique ID number.
-      #
-      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
-      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
-      #
-      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
-      # * In the result of the Initiate API, you receive back a report's `id` value.
-      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
-      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
-      #
-      # This API call returns information about any report type.
-      # @param id [Integer] The unique ID number of the report to retrieve
-      # @return [Object]
-      def get_report(id)
-        path = "/api/v2/reports/#{id}"
-        get(path)
-      end
-
-
-      # Initiate an ExportDocumentLine report task
-      #
-      # Begins running an `ExportDocumentLine` report task and returns the identity of the report.
-      #
-      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
-      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
-      #
-      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
-      # * In the result of the Initiate API, you receive back a report's `id` value.
-      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
-      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
-      #
-      # The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param companyId [Integer] The unique ID number of the company to report on.
-      # @param model [Object] Options that may be configured to customize the report.
-      # @return [ReportModel[]]
-      def initiate_export_document_line_report(companyId, model)
-        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
-        post(path, model)
-      end
-
-
-      # List all report tasks for account
-      #
-      # List all report tasks for your account.
-      #
-      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
-      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
-      #
-      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
-      # * In the result of the Initiate API, you receive back a report's `id` value.
-      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
-      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
-      #
-      # This API call returns information about all report types across your entire account.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param companyId [Integer] The id of the company for which to get reports.
-      # @param pageKey [String] Provide a page key to retrieve the next page of results.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
-      # @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.
-      # @return [FetchResult]
-      def list_reports(options={})
-        path = "/api/v2/reports"
-        get(path, options)
-      end
-
-    end
-  end
+module AvaTax
+  class Client
+    module Reports 
+
+
+      # Download a report
+      #
+      # This API downloads the file associated with a report.
+      #
+      # If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
+      # use the `GetReport` API.
+      #
+      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
+      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
+      #
+      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
+      # * In the result of the Initiate API, you receive back a report's `id` value.
+      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
+      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
+      #
+      # This API works for all report types.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param id [Integer] The unique ID number of this report
+      # @return [Object]
+      def download_report(id)
+        path = "/api/v2/reports/#{id}/attachment"
+        get(path)
+      end
+
+
+      # Retrieve a single report
+      #
+      # Retrieve a single report by its unique ID number.
+      #
+      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
+      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
+      #
+      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
+      # * In the result of the Initiate API, you receive back a report's `id` value.
+      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
+      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
+      #
+      # This API call returns information about any report type.
+      # @param id [Integer] The unique ID number of the report to retrieve
+      # @return [Object]
+      def get_report(id)
+        path = "/api/v2/reports/#{id}"
+        get(path)
+      end
+
+
+      # Initiate an ExportDocumentLine report task
+      #
+      # Begins running an `ExportDocumentLine` report task and returns the identity of the report.
+      #
+      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
+      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
+      #
+      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
+      # * In the result of the Initiate API, you receive back a report's `id` value.
+      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
+      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
+      #
+      # The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The unique ID number of the company to report on.
+      # @param model [Object] Options that may be configured to customize the report.
+      # @return [ReportModel[]]
+      def initiate_export_document_line_report(companyId, model)
+        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
+        post(path, model)
+      end
+
+
+      # List all report tasks for account
+      #
+      # List all report tasks for your account.
+      #
+      # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
+      # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
+      #
+      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
+      # * In the result of the Initiate API, you receive back a report's `id` value.
+      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
+      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
+      #
+      # This API call returns information about all report types across your entire account.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The id of the company for which to get reports.
+      # @param pageKey [String] Provide a page key to retrieve the next page of results.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
+      # @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.
+      # @return [FetchResult]
+      def list_reports(options={})
+        path = "/api/v2/reports"
+        get(path, options)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/settings.rb

@@ -1,175 +1,175 @@
-module AvaTax
-  class Client
-    module Settings 
-
-
-      # Create a new setting
-      #
-      # Create one or more new setting objects attached to this company.
-      #
-      # The company settings system is a metadata system that you can use to store extra information
-      # about a company. Your integration or connector could use this data storage to keep track of
-      # preference information, reminders, or any other storage that would need to persist even if
-      # the customer uninstalls your application.
-      #
-      # A setting can refer to any type of data you need to remember about this company object.
-      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
-      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param companyId [Integer] The ID of the company that owns this setting.
-      # @param model [SettingModel[]] The setting you wish to create.
-      # @return [SettingModel[]]
-      def create_settings(companyId, model)
-        path = "/api/v2/companies/#{companyId}/settings"
-        post(path, model)
-      end
-
-
-      # Delete a single setting
-      #
-      # Mark the setting object at this URL as deleted.
-      #
-      # The company settings system is a metadata system that you can use to store extra information
-      # about a company. Your integration or connector could use this data storage to keep track of
-      # preference information, reminders, or any other storage that would need to persist even if
-      # the customer uninstalls your application.
-      #
-      # A setting can refer to any type of data you need to remember about this company object.
-      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
-      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param companyId [Integer] The ID of the company that owns this setting.
-      # @param id [Integer] The ID of the setting you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_setting(companyId, id)
-        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        delete(path)
-      end
-
-
-      # Retrieve a single setting
-      #
-      # Get a single setting object by its unique ID.
-      #
-      # The company settings system is a metadata system that you can use to store extra information
-      # about a company. Your integration or connector could use this data storage to keep track of
-      # preference information, reminders, or any other storage that would need to persist even if
-      # the customer uninstalls your application.
-      #
-      # A setting can refer to any type of data you need to remember about this company object.
-      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
-      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param companyId [Integer] The ID of the company that owns this setting
-      # @param id [Integer] The primary key of this setting
-      # @return [Object]
-      def get_setting(companyId, id)
-        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        get(path)
-      end
-
-
-      # Retrieve all settings for this company
-      #
-      # List all setting objects attached to this company.
-      #
-      # The company settings system is a metadata system that you can use to store extra information
-      # about a company. Your integration or connector could use this data storage to keep track of
-      # preference information, reminders, or any other storage that would need to persist even if
-      # the customer uninstalls your application.
-      #
-      # A setting can refer to any type of data you need to remember about this company object.
-      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
-      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
-      #
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param companyId [Integer] The ID of the company that owns these settings
-      # @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 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. 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 list_settings_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/settings"
-        get(path, options)
-      end
-
-
-      # Retrieve all settings
-      #
-      # Get multiple setting objects across all companies.
-      #
-      # The company settings system is a metadata system that you can use to store extra information
-      # about a company. Your integration or connector could use this data storage to keep track of
-      # preference information, reminders, or any other storage that would need to persist even if
-      # the customer uninstalls your application.
-      #
-      # A setting can refer to any type of data you need to remember about this company object.
-      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
-      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
-      #
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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 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. 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_settings(options={})
-        path = "/api/v2/settings"
-        get(path, options)
-      end
-
-
-      # Update a single setting
-      #
-      # Replace the existing setting object at this URL with an updated object.
-      #
-      # The company settings system is a metadata system that you can use to store extra information
-      # about a company. Your integration or connector could use this data storage to keep track of
-      # preference information, reminders, or any other storage that would need to persist even if
-      # the customer uninstalls your application.
-      #
-      # A setting can refer to any type of data you need to remember about this company object.
-      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
-      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
-      #
-      # All data from the existing object will be replaced with data in the object you `PUT`.
-      #
-      # To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param companyId [Integer] The ID of the company that this setting belongs to.
-      # @param id [Integer] The ID of the setting you wish to update
-      # @param model [Object] The setting you wish to update.
-      # @return [Object]
-      def update_setting(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        put(path, model)
-      end
-
-    end
-  end
+module AvaTax
+  class Client
+    module Settings 
+
+
+      # Create a new setting
+      #
+      # Create one or more new setting objects attached to this company.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this setting.
+      # @param model [SettingModel[]] The setting you wish to create.
+      # @return [SettingModel[]]
+      def create_settings(companyId, model)
+        path = "/api/v2/companies/#{companyId}/settings"
+        post(path, model)
+      end
+
+
+      # Delete a single setting
+      #
+      # Mark the setting object at this URL as deleted.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this setting.
+      # @param id [Integer] The ID of the setting you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_setting(companyId, id)
+        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        delete(path)
+      end
+
+
+      # Retrieve a single setting
+      #
+      # Get a single setting object by its unique ID.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The ID of the company that owns this setting
+      # @param id [Integer] The primary key of this setting
+      # @return [Object]
+      def get_setting(companyId, id)
+        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        get(path)
+      end
+
+
+      # Retrieve all settings for this company
+      #
+      # List all setting objects attached to this company.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # 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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The ID of the company that owns these settings
+      # @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 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. 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 list_settings_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/settings"
+        get(path, options)
+      end
+
+
+      # Retrieve all settings
+      #
+      # Get multiple setting objects across all companies.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # 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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @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 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. 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_settings(options={})
+        path = "/api/v2/settings"
+        get(path, options)
+      end
+
+
+      # Update a single setting
+      #
+      # Replace the existing setting object at this URL with an updated object.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # All data from the existing object will be replaced with data in the object you `PUT`.
+      #
+      # To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that this setting belongs to.
+      # @param id [Integer] The ID of the setting you wish to update
+      # @param model [Object] The setting you wish to update.
+      # @return [Object]
+      def update_setting(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        put(path, model)
+      end
+
+    end
+  end
 end