module AvaTax
  class Client
    module Batches 


      # Create a new batch
      #
      # Create one or more new batch objects attached to this company.
      # When you create a batch, it is added to the AvaTaxBatch.Batch table and will be processed in the order it was received.
      # 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[]]
      def create_batches(companyId, model)
        path = "/api/v2/companies/#{companyId}/batches"
        post(path, model)
      end


      # Delete a single batch
      #
      # 
      # @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[]]
      def delete_batch(companyId, id)
        path = "/api/v2/companies/#{companyId}/batches/#{id}"
        delete(path)
      end


      # Download a single batch file
      #
      # Download a single batch file identified by this URL.
      # @param companyId [Integer] The ID of the company that owns this batch
      # @param batchId [Integer] The ID of the batch object
      # @param id [Integer] The primary key of this batch file object
      # @return [Object]
      def download_batch(companyId, batchId, id)
        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
        get(path)
      end


      # Retrieve a single batch
      #
      # Get the batch object identified by this URL.
      # A batch object is a large collection of API calls stored in a compact file.
      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
      # @param companyId [Integer] The ID of the company that owns this batch
      # @param id [Integer] The primary key of this batch
      # @return [Object]
      def get_batch(companyId, id)
        path = "/api/v2/companies/#{companyId}/batches/#{id}"
        get(path)
      end


      # Retrieve all batches for this company
      #
      # List all batch objects attached to the specified company.
      # A batch object is a large collection of API calls stored in a compact file.
      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
      # 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 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 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_batches_by_company(companyId, options={})
        path = "/api/v2/companies/#{companyId}/batches"
        get(path, options)
      end


      # Retrieve all batches
      #
      # Get multiple batch objects across all companies.
      # A batch object is a large collection of API calls stored in a compact file.
      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
      #
      # 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 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_batches(options={})
        path = "/api/v2/batches"
        get(path, options)
      end

    end
  end
end