class BillForward::MutableEntity

Public Class Methods

new(*args) click to toggle source
Calls superclass method BillForward::InsertableEntity::new
# File lib/bill_forward/mutable_entity.rb, line 3
    def initialize(*args)
  raise AbstractInstantiateError.new('This abstract class cannot be instantiated!') if self.class == MutableEntity
  super
end

Public Instance Methods

delete(query_params = {}) click to toggle source

Asks API to retire existing instance of this entity. @note Many BillForward entities do not support RETIRE @note As-yet untested

@return [self] The retired Entity

# File lib/bill_forward/mutable_entity.rb, line 21
def delete(query_params = {})
        self.class.request_first('delete', ERB::Util.url_encode(id), query_params, nil, _client)
end
Also aliased as: retire
retire(query_params = {})
Alias for: delete
save() click to toggle source

Asks API to update existing instance of this entity, based on current model.

@return [self] The updated Entity

# File lib/bill_forward/mutable_entity.rb, line 12
def save()
        self.class.request_first('put', '', self, nil, _client)
end