Class: ChargeBee::Quote

Inherits:
Model
  • Object
show all
Defined in:
lib/chargebee/models/quote.rb

Defined Under Namespace

Classes: BillingAddress, Discount, LineItem, LineItemDiscount, LineItemTax, ShippingAddress, Tax

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Model

construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #to_s, uri_path

Constructor Details

This class inherits a constructor from ChargeBee::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ChargeBee::Model

Instance Attribute Details

#amount_dueObject

Returns the value of attribute amount_due.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def amount_due
  @amount_due
end

#amount_paidObject

Returns the value of attribute amount_paid.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def amount_paid
  @amount_paid
end

#billing_addressObject

Returns the value of attribute billing_address.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def billing_address
  @billing_address
end

#charge_on_acceptanceObject

Returns the value of attribute charge_on_acceptance.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def charge_on_acceptance
  @charge_on_acceptance
end

#credits_appliedObject

Returns the value of attribute credits_applied.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def credits_applied
  @credits_applied
end

#currency_codeObject

Returns the value of attribute currency_code.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def currency_code
  @currency_code
end

#customer_idObject

Returns the value of attribute customer_id.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def customer_id
  @customer_id
end

#dateObject

Returns the value of attribute date.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def date
  @date
end

#discountsObject

Returns the value of attribute discounts.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def discounts
  @discounts
end

#idObject

Returns the value of attribute id.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def id
  @id
end

#invoice_idObject

Returns the value of attribute invoice_id.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def invoice_id
  @invoice_id
end

#line_item_discountsObject

Returns the value of attribute line_item_discounts.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def line_item_discounts
  @line_item_discounts
end

#line_item_taxesObject

Returns the value of attribute line_item_taxes.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def line_item_taxes
  @line_item_taxes
end

#line_itemsObject

Returns the value of attribute line_items.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def line_items
  @line_items
end

#nameObject

Returns the value of attribute name.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def name
  @name
end

#notesObject

Returns the value of attribute notes.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def notes
  @notes
end

#operation_typeObject

Returns the value of attribute operation_type.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def operation_type
  @operation_type
end

#po_numberObject

Returns the value of attribute po_number.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def po_number
  @po_number
end

#price_typeObject

Returns the value of attribute price_type.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def price_type
  @price_type
end

#resource_versionObject

Returns the value of attribute resource_version.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def resource_version
  @resource_version
end

#shipping_addressObject

Returns the value of attribute shipping_address.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def shipping_address
  @shipping_address
end

#statusObject

Returns the value of attribute status.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def status
  @status
end

#sub_totalObject

Returns the value of attribute sub_total.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def sub_total
  @sub_total
end

#subscription_idObject

Returns the value of attribute subscription_id.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def subscription_id
  @subscription_id
end

#taxesObject

Returns the value of attribute taxes.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def taxes
  @taxes
end

#totalObject

Returns the value of attribute total.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def total
  @total
end

#total_payableObject

Returns the value of attribute total_payable.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def total_payable
  @total_payable
end

#updated_atObject

Returns the value of attribute updated_at.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def updated_at
  @updated_at
end

#valid_tillObject

Returns the value of attribute valid_till.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def valid_till
  @valid_till
end

#vat_numberObject

Returns the value of attribute vat_number.



32
33
34
# File 'lib/chargebee/models/quote.rb', line 32

def vat_number
  @vat_number
end

Class Method Details

.convert(id, params = {}, env = nil, headers = {}) ⇒ Object



65
66
67
# File 'lib/chargebee/models/quote.rb', line 65

def self.convert(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("quotes",id.to_s,"convert"), params, env, headers)
end

.create_for_onetime_charges(params, env = nil, headers = {}) ⇒ Object



53
54
55
# File 'lib/chargebee/models/quote.rb', line 53

def self.create_for_onetime_charges(params, env=nil, headers={})
  Request.send('post', uri_path("quotes","create_for_onetime_charges"), params, env, headers)
end

.create_sub_for_customer_quote(id, params, env = nil, headers = {}) ⇒ Object



45
46
47
# File 'lib/chargebee/models/quote.rb', line 45

def self.create_sub_for_customer_quote(id, params, env=nil, headers={})
  Request.send('post', uri_path("customers",id.to_s,"create_subscription_quote"), params, env, headers)
end

.delete(id, params = {}, env = nil, headers = {}) ⇒ Object



73
74
75
# File 'lib/chargebee/models/quote.rb', line 73

def self.delete(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("quotes",id.to_s,"delete"), params, env, headers)
end

.list(params = {}, env = nil, headers = {}) ⇒ Object



57
58
59
# File 'lib/chargebee/models/quote.rb', line 57

def self.list(params={}, env=nil, headers={})
  Request.send_list_request('get', uri_path("quotes"), params, env, headers)
end

.pdf(id, params = {}, env = nil, headers = {}) ⇒ Object



77
78
79
# File 'lib/chargebee/models/quote.rb', line 77

def self.pdf(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("quotes",id.to_s,"pdf"), params, env, headers)
end

.quote_line_groups_for_quote(id, params = {}, env = nil, headers = {}) ⇒ Object



61
62
63
# File 'lib/chargebee/models/quote.rb', line 61

def self.quote_line_groups_for_quote(id, params={}, env=nil, headers={})
  Request.send('get', uri_path("quotes",id.to_s,"quote_line_groups"), params, env, headers)
end

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

OPERATIONS




41
42
43
# File 'lib/chargebee/models/quote.rb', line 41

def self.retrieve(id, env=nil, headers={})
  Request.send('get', uri_path("quotes",id.to_s), {}, env, headers)
end

.update_status(id, params, env = nil, headers = {}) ⇒ Object



69
70
71
# File 'lib/chargebee/models/quote.rb', line 69

def self.update_status(id, params, env=nil, headers={})
  Request.send('post', uri_path("quotes",id.to_s,"update_status"), params, env, headers)
end

.update_subscription_quote(params, env = nil, headers = {}) ⇒ Object



49
50
51
# File 'lib/chargebee/models/quote.rb', line 49

def self.update_subscription_quote(params, env=nil, headers={})
  Request.send('post', uri_path("quotes","update_subscription_quote"), params, env, headers)
end