Class: Frame::Invoice

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/frame/resources/invoice.rb

Constant Summary collapse

OBJECT_NAME = 
"invoice"

Instance Attribute Summary

Attributes inherited from FrameObject

#id, #original_values

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

#serialize_params

Methods inherited from APIResource

class_name, #refresh, resource_url, #resource_url

Methods included from APIOperations::Request

included

Methods inherited from FrameObject

#[], #[]=, construct_from, #each, #initialize, #initialize_from, #inspect, #keys, #serialize_params, #to_hash, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Frame::FrameObject

Class Method Details

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



16
17
18
19
20
21
22
23
 
# File 'lib/frame/resources/invoice.rb', line 16

def self.create(params = {}, opts = {})
  request_object(
    :post,
    "/v1/invoices",
    params,
    opts
  )
end

.delete(id, params = {}, opts = {}) ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'lib/frame/resources/invoice.rb', line 44

def self.delete(id, params = {}, opts = {})
  request_object(
    :delete,
    "/v1/invoices/#{CGI.escape(id)}",
    params,
    opts
  )
end

.issue(id, params = {}, opts = {}) ⇒ Object 



89
90
91
92
93
94
95
96
 
# File 'lib/frame/resources/invoice.rb', line 89

def self.issue(id, params = {}, opts = {})
  request_object(
    :post,
    "/v1/invoices/#{CGI.escape(id)}/issue",
    params,
    opts
  )
end

.list(params = {}, opts = {}) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/frame/resources/invoice.rb', line 25

def self.list(params = {}, opts = {})
  request_object(
    :get,
    "/v1/invoices",
    params,
    opts
  )
end

.object_name ⇒ Object 



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

def self.object_name
  OBJECT_NAME
end

.retrieve(id, opts = {}) ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/frame/resources/invoice.rb', line 34

def self.retrieve(id, opts = {})
  id = Util.normalize_id(id)
  request_object(
    :get,
    "/v1/invoices/#{CGI.escape(id)}",
    {},
    opts
  )
end

Instance Method Details

#delete(params = {}, opts = {}) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/frame/resources/invoice.rb', line 71

def delete(params = {}, opts = {})
  request_object(
    :delete,
    "/v1/invoices/#{CGI.escape(self["id"])}",
    params,
    opts
  )
end

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



80
81
82
83
84
85
86
87
 
# File 'lib/frame/resources/invoice.rb', line 80

def issue(params = {}, opts = {})
  request_object(
    :post,
    "/v1/invoices/#{CGI.escape(self["id"])}/issue",
    params,
    opts
  )
end

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/frame/resources/invoice.rb', line 53

def save(params = {}, opts = {})
  values = serialize_params(self).merge(params)

  if values.empty?
    return self
  end

  updated = request_object(
    :patch,
    "/v1/invoices/#{CGI.escape(self["id"])}",
    values,
    opts
  )

  initialize_from(updated)
  self
end