Class: ChargeBee::Quote

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

Defined Under Namespace

Classes: BillingAddress, Discount, LineItem, LineItemDiscount, LineItemTax, LineItemTier, 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, #replace_white_space_with_underscore, #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.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def amount_due
  @amount_due
end

#amount_paidObject

Returns the value of attribute amount_paid.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def amount_paid
  @amount_paid
end

#billing_addressObject

Returns the value of attribute billing_address.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def billing_address
  @billing_address
end

#business_entity_idObject

Returns the value of attribute business_entity_id.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def business_entity_id
  @business_entity_id
end

#charge_on_acceptanceObject

Returns the value of attribute charge_on_acceptance.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def charge_on_acceptance
  @charge_on_acceptance
end

#contract_term_endObject

Returns the value of attribute contract_term_end.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def contract_term_end
  @contract_term_end
end

#contract_term_startObject

Returns the value of attribute contract_term_start.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def contract_term_start
  @contract_term_start
end

#contract_term_termination_feeObject

Returns the value of attribute contract_term_termination_fee.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def contract_term_termination_fee
  @contract_term_termination_fee
end

#credits_appliedObject

Returns the value of attribute credits_applied.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def credits_applied
  @credits_applied
end

#currency_codeObject

Returns the value of attribute currency_code.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def currency_code
  @currency_code
end

#customer_idObject

Returns the value of attribute customer_id.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def customer_id
  @customer_id
end

#dateObject

Returns the value of attribute date.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def date
  @date
end

#discountsObject

Returns the value of attribute discounts.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def discounts
  @discounts
end

#idObject

Returns the value of attribute id.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def id
  @id
end

#invoice_idObject

Returns the value of attribute invoice_id.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def invoice_id
  @invoice_id
end

#line_item_discountsObject

Returns the value of attribute line_item_discounts.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def line_item_discounts
  @line_item_discounts
end

#line_item_taxesObject

Returns the value of attribute line_item_taxes.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def line_item_taxes
  @line_item_taxes
end

#line_item_tiersObject

Returns the value of attribute line_item_tiers.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def line_item_tiers
  @line_item_tiers
end

#line_itemsObject

Returns the value of attribute line_items.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def line_items
  @line_items
end

#nameObject

Returns the value of attribute name.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def name
  @name
end

#notesObject

Returns the value of attribute notes.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def notes
  @notes
end

#operation_typeObject

Returns the value of attribute operation_type.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def operation_type
  @operation_type
end

#po_numberObject

Returns the value of attribute po_number.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def po_number
  @po_number
end

#price_typeObject

Returns the value of attribute price_type.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def price_type
  @price_type
end

#resource_versionObject

Returns the value of attribute resource_version.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def resource_version
  @resource_version
end

#shipping_addressObject

Returns the value of attribute shipping_address.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def shipping_address
  @shipping_address
end

#statusObject

Returns the value of attribute status.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def status
  @status
end

#sub_totalObject

Returns the value of attribute sub_total.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def sub_total
  @sub_total
end

#subscription_idObject

Returns the value of attribute subscription_id.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def subscription_id
  @subscription_id
end

#tax_categoryObject

Returns the value of attribute tax_category.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def tax_category
  @tax_category
end

#taxesObject

Returns the value of attribute taxes.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def taxes
  @taxes
end

#totalObject

Returns the value of attribute total.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def total
  @total
end

#total_payableObject

Returns the value of attribute total_payable.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def total_payable
  @total_payable
end

#updated_atObject

Returns the value of attribute updated_at.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def updated_at
  @updated_at
end

#valid_tillObject

Returns the value of attribute valid_till.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def valid_till
  @valid_till
end

#vat_numberObject

Returns the value of attribute vat_number.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def vat_number
  @vat_number
end

#vat_number_prefixObject

Returns the value of attribute vat_number_prefix.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def vat_number_prefix
  @vat_number_prefix
end

#versionObject

Returns the value of attribute version.



36
37
38
# File 'lib/chargebee/models/quote.rb', line 36

def version
  @version
end

Class Method Details

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



106
107
108
# File 'lib/chargebee/models/quote.rb', line 106

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

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



90
91
92
# File 'lib/chargebee/models/quote.rb', line 90

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

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



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

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



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

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

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



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

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

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



118
119
120
# File 'lib/chargebee/models/quote.rb', line 118

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

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



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

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

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



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

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

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



94
95
96
# File 'lib/chargebee/models/quote.rb', line 94

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

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



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

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

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



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

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

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



86
87
88
# File 'lib/chargebee/models/quote.rb', line 86

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

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



114
115
116
# File 'lib/chargebee/models/quote.rb', line 114

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

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



98
99
100
# File 'lib/chargebee/models/quote.rb', line 98

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



122
123
124
# File 'lib/chargebee/models/quote.rb', line 122

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



102
103
104
# File 'lib/chargebee/models/quote.rb', line 102

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




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

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



110
111
112
# File 'lib/chargebee/models/quote.rb', line 110

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



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

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

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



82
83
84
# File 'lib/chargebee/models/quote.rb', line 82

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