Class: Paid::Invoice

Inherits:
APIResource show all
Defined in:
lib/paid/invoice.rb

Instance Attribute Summary collapse

Attributes inherited from APIResource

#api_method, #json

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from APIResource

api_attribute_names, #api_attributes, api_subclass_fetch, api_subclasses, #changed_api_attributes, #clear_api_attributes, #determine_api_attribute_value, determine_api_attribute_value, #initialize, #inspect, #inspect_api_attributes, #inspect_nested, #refresh_from, register_api_subclass, #to_json

Constructor Details

This class inherits a constructor from Paid::APIResource

Instance Attribute Details

#chase_schedule ⇒ Object

Returns the value of attribute chase_schedule.



6
7
8
 
# File 'lib/paid/invoice.rb', line 6

def chase_schedule
  @chase_schedule
end

#customer ⇒ Object

Returns the value of attribute customer.



8
9
10
 
# File 'lib/paid/invoice.rb', line 8

def customer
  @customer
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



3
4
5
 
# File 'lib/paid/invoice.rb', line 3

def id
  @id
end

#issued_at ⇒ Object

Returns the value of attribute issued_at.



9
10
11
 
# File 'lib/paid/invoice.rb', line 9

def issued_at
  @issued_at
end

#metadata ⇒ Object

Returns the value of attribute metadata.



11
12
13
 
# File 'lib/paid/invoice.rb', line 11

def metadata
  @metadata
end

#next_chase_on ⇒ Object

Returns the value of attribute next_chase_on.



7
8
9
 
# File 'lib/paid/invoice.rb', line 7

def next_chase_on
  @next_chase_on
end

#object ⇒ Object (readonly)

Returns the value of attribute object.



4
5
6
 
# File 'lib/paid/invoice.rb', line 4

def object
  @object
end

#summary ⇒ Object

Returns the value of attribute summary.



5
6
7
 
# File 'lib/paid/invoice.rb', line 5

def summary
  @summary
end

#terms ⇒ Object

Returns the value of attribute terms.



10
11
12
 
# File 'lib/paid/invoice.rb', line 10

def terms
  @terms
end

#url ⇒ Object

Returns the value of attribute url.



12
13
14
 
# File 'lib/paid/invoice.rb', line 12

def url
  @url
end

Class Method Details

.all(params = {}, headers = {}) ⇒ Object 



14
15
16
17
 
# File 'lib/paid/invoice.rb', line 14

def self.all(params={}, headers={})
  method = APIMethod.new(:get, "/invoices", params, headers, self)
  APIList.new(self, method.execute, method)
end

.create(params = {}, headers = {}) ⇒ Object 



27
28
29
30
 
# File 'lib/paid/invoice.rb', line 27

def self.create(params={}, headers={})
  method = APIMethod.new(:post, "/invoices", params, headers, self)
  self.new(method.execute, method)
end

.retrieve(id, params = {}, headers = {}) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/paid/invoice.rb', line 19

def self.retrieve(id, params={}, headers={})
  params = ParamsBuilder.merge(params, {
    :id => id
  })
  method = APIMethod.new(:get, "/invoices/:id", params, headers, self)
  self.new(method.execute, method)
end

Instance Method Details

#issue(params = {}, headers = {}) ⇒ Object 



43
44
45
46
 
# File 'lib/paid/invoice.rb', line 43

def issue(params={}, headers={})
  method = APIMethod.new(:post, "/invoices/:id/issue", params, headers, self)
  self.refresh_from(method.execute, method)
end

#mark_as_paid(params = {}, headers = {}) ⇒ Object 



48
49
50
51
 
# File 'lib/paid/invoice.rb', line 48

def mark_as_paid(params={}, headers={})
  method = APIMethod.new(:post, "/invoices/:id/mark_as_paid", params, headers, self)
  self.refresh_from(method.execute, method)
end

#refresh(params = {}, headers = {}) ⇒ Object 



32
33
34
35
 
# File 'lib/paid/invoice.rb', line 32

def refresh(params={}, headers={})
  method = APIMethod.new(:get, "/invoices/:id", params, headers, self)
  self.refresh_from(method.execute, method)
end

#save(params = {}, headers = {}) ⇒ Object 



37
38
39
40
41
 
# File 'lib/paid/invoice.rb', line 37

def save(params={}, headers={})
  params = ParamsBuilder.merge(params, changed_api_attributes)
  method = APIMethod.new(:put, "/invoices/:id", params, headers, self)
  self.refresh_from(method.execute, method)
end

#void(params = {}, headers = {}) ⇒ Object 



53
54
55
56
 
# File 'lib/paid/invoice.rb', line 53

def void(params={}, headers={})
  method = APIMethod.new(:post, "/invoices/:id/void", params, headers, self)
  self.refresh_from(method.execute, method)
end