Package ch.aaap.harvestclient.api

Interface EstimateMessagesApi

All Known Implementing Classes:
EstimateMessagesApiImpl
public interface EstimateMessagesApi
See Also:

  • Method Details

    • list

      List<EstimateMessage> list(Reference<Estimate> estimateReference, Instant updatedSince)
      Parameters:
      updatedSince - return only EstimateMessages that have been updated at least 1 second after updatedSince. Set to null to disable filtering.
      estimateReference - the estimate containing the messages
      Returns:
      a list of all EstimateMessages in the estimate, sorted by creation date, newest first.

    • list

      Pagination<EstimateMessage> list(Reference<Estimate> estimateReference, Instant updatedSince, int page, int perPage)
      Parameters:
      updatedSince - return only EstimateMessages that have been updated at least 1 second after updatedSince. Set to null to disable filtering.
      estimateReference - the estimate containing the messages
      page - the page number
      perPage - how many results to return for one page. Max 100
      Returns:
      a list of all EstimateMessages in the estimate, sorted by creation date, newest first.

    • create

      EstimateMessage create(Reference<Estimate> estimateReference, EstimateMessage creationInfo)
      Create a new EstimateMessage
      Parameters:
      estimateReference - the estimate that will contain the message
      creationInfo - creation information
      Returns:
      the created EstimateMessage

    • markAs

      EstimateMessage markAs(Reference<Estimate> estimateReference, EstimateMessage.EventType eventType)
      Change the state of an estimate to the given eventType. Not all transitions are allowed: see the web interface for more information
      Parameters:
      estimateReference - the estimate against which to record the event
      eventType - the event you want to record for this estimate
      Returns:
      the updated Estimate

    • delete

      void delete(Reference<Estimate> estimateReference, Reference<EstimateMessage> estimateMessageReference)
      Delete an existing EstimateMessage. Deleting an Accept Message does not change the status of the Estimate.
      Parameters:
      estimateReference - the estimate that contains the message
      estimateMessageReference - An existing EstimateMessage to be deleted