Skip to content

Instantly share code, notes, and snippets.

@NullVoxPopuli
Created October 22, 2012 11:53
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save NullVoxPopuli/3931189 to your computer and use it in GitHub Desktop.
Save NullVoxPopuli/3931189 to your computer and use it in GitHub Desktop.
YARD tab only... directive tags not working
##
#@api public
#@!attribute allow_accept
# @return [Boolean] allow the proposal to be accepted
#@!attribute allow_decline
# @return [Boolean] allow the proposal to be declined
#@!attribute allow_downloads
# @return [Boolean] allow the pdf of this proposal to be downloaded
#@!attribute archived
# @return [Boolean] the state of archival
#@!attribute category_id
# @return [Integer] the id of the associated {Category}
#@!attribute client
# @return [String] the name of the client that this proposal is intended for
#@!attribute closed_at
# @return [DateTime] the date and time that the proposal was closed
#@!attribute closed_comment_id
# @return [Integer] if the proposal is closed with the standard TinderBox esignature process, there will be an
# associated object containing the name, email, and ip address of the signer
#@!attribute created_at
# @return [DateTime] the date and time that the proposal was created
#@!attribute deleted_at
# @return [DateTime] the date and time that the proposal was deleted
#@!attribute description
# @return [String] Short description of what the proposal is for
#@!attribute downloads
# @return [Integer] number of times that the PDF of this proposal has been downloaded from the view URL
#@!attribute enable_access_code
# @return [Boolean] enable a password for viewing the proposal once published
#@!attribute enable_cover_page
# @return [Boolean] display a cover page
#@!attribute enable_public_redlining
# @return [Boolean] enable redlining from the public view once published
#@!attribute enable_redlining
# @return [Boolean] enable redlining internally
#@!attribute esignable
# @return [Boolean] let this proposal use the {Account}'s current esignature provider
#@!attribute expires_at
# @return [DateTime] the date and time that the proposal expires (no longer is viewable to the public)
# only matters if the proposal is publish, as the URL to this proposal becomes dead
#@!attribute ext_integration_id
# @return [String] Could be used for storing an external id for keeping track of this proposal within
# some external system
#@!attribute id
# @return [Integer] Can't be changed
#@!attribute last_viewed_at
# @return [DateTime] the date and time that the proposal was last viewed (only valid after publish)
#@!attribute name
# @return [String] the name of the proposal
#@!attribute metadata
# @return [Hash] metadata
#@!attribute password
# @return [String] the code used for accessing the public view of this proposal
#@!attribute proposal_template_id
# @return [Integer] the id of the {Proposal::Template} that was used to populate content and attributes of this proposal
#@!attribute published_at
# @return [DateTime] the date and time that this proposal was published
#@!attribute status
# @return [Integer] status of this proposal. see statuses below
#@!attribute updated_at
# @return [DateTime] the date and time that the proposal was last updated
#@!attribute user_id
# @return [Integer] the id of the owner of this proposal
#@!attribute value
# @return [Decimal] the monetary value of this proposal
#@!attribute variable_data
# @return [Hash] variables
#@!attribute views
# @return [Integer] the number of public views (post publish)
#@!attribute visibility
# @return [Integer] see visibility in {Shared}
#
#@association sections [Array<Proposal::Section>]
#@association contents [Array<Proposal::Content>]
#@association attachments [Array<Proposal::Attachment>]
#@association hard_copies [Array<Proposal::PDF>]
#@association category [Category]
#@association user [User]
#
#
#@note
# For visibility, see {Shared} <br/>
# To safely add / remove variables from the variable_data field, see {ProposalsController}
class Proposal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment