Class: ChargeBee::Quote
Defined Under Namespace
Classes: BillingAddress, Discount, LineItem, LineItemDiscount, LineItemTax, LineItemTier, ShippingAddress, Tax
Instance Attribute Summary collapse
-
#amount_due ⇒ Object
Returns the value of attribute amount_due.
-
#amount_paid ⇒ Object
Returns the value of attribute amount_paid.
-
#billing_address ⇒ Object
Returns the value of attribute billing_address.
-
#business_entity_id ⇒ Object
Returns the value of attribute business_entity_id.
-
#charge_on_acceptance ⇒ Object
Returns the value of attribute charge_on_acceptance.
-
#contract_term_end ⇒ Object
Returns the value of attribute contract_term_end.
-
#contract_term_start ⇒ Object
Returns the value of attribute contract_term_start.
-
#contract_term_termination_fee ⇒ Object
Returns the value of attribute contract_term_termination_fee.
-
#credits_applied ⇒ Object
Returns the value of attribute credits_applied.
-
#currency_code ⇒ Object
Returns the value of attribute currency_code.
-
#customer_id ⇒ Object
Returns the value of attribute customer_id.
-
#date ⇒ Object
Returns the value of attribute date.
-
#deleted ⇒ Object
Returns the value of attribute deleted.
-
#discounts ⇒ Object
Returns the value of attribute discounts.
-
#id ⇒ Object
Returns the value of attribute id.
-
#invoice_id ⇒ Object
Returns the value of attribute invoice_id.
-
#line_item_discounts ⇒ Object
Returns the value of attribute line_item_discounts.
-
#line_item_taxes ⇒ Object
Returns the value of attribute line_item_taxes.
-
#line_item_tiers ⇒ Object
Returns the value of attribute line_item_tiers.
-
#line_items ⇒ Object
Returns the value of attribute line_items.
-
#name ⇒ Object
Returns the value of attribute name.
-
#notes ⇒ Object
Returns the value of attribute notes.
-
#operation_type ⇒ Object
Returns the value of attribute operation_type.
-
#po_number ⇒ Object
Returns the value of attribute po_number.
-
#price_type ⇒ Object
Returns the value of attribute price_type.
-
#resource_version ⇒ Object
Returns the value of attribute resource_version.
-
#shipping_address ⇒ Object
Returns the value of attribute shipping_address.
-
#status ⇒ Object
Returns the value of attribute status.
-
#sub_total ⇒ Object
Returns the value of attribute sub_total.
-
#subscription_id ⇒ Object
Returns the value of attribute subscription_id.
-
#tax_category ⇒ Object
Returns the value of attribute tax_category.
-
#taxes ⇒ Object
Returns the value of attribute taxes.
-
#total ⇒ Object
Returns the value of attribute total.
-
#total_payable ⇒ Object
Returns the value of attribute total_payable.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
-
#valid_till ⇒ Object
Returns the value of attribute valid_till.
-
#vat_number ⇒ Object
Returns the value of attribute vat_number.
-
#vat_number_prefix ⇒ Object
Returns the value of attribute vat_number_prefix.
-
#version ⇒ Object
Returns the value of attribute version.
Class Method Summary collapse
- .convert(id, params = {}, env = nil, headers = {}) ⇒ Object
- .create_for_charge_items_and_charges(params, env = nil, headers = {}) ⇒ Object
- .create_for_onetime_charges(params, env = nil, headers = {}) ⇒ Object
- .create_sub_for_customer_quote(id, params, env = nil, headers = {}) ⇒ Object
- .create_sub_items_for_customer_quote(id, params, env = nil, headers = {}) ⇒ Object
- .delete(id, params = {}, env = nil, headers = {}) ⇒ Object
- .edit_create_sub_customer_quote_for_items(id, params, env = nil, headers = {}) ⇒ Object
- .edit_create_sub_for_customer_quote(id, params, env = nil, headers = {}) ⇒ Object
- .edit_for_charge_items_and_charges(id, params, env = nil, headers = {}) ⇒ Object
- .edit_one_time_quote(id, params = {}, env = nil, headers = {}) ⇒ Object
- .edit_update_subscription_quote(id, params = {}, env = nil, headers = {}) ⇒ Object
- .edit_update_subscription_quote_for_items(id, params, env = nil, headers = {}) ⇒ Object
- .extend_expiry_date(id, params, env = nil, headers = {}) ⇒ Object
- .list(params = {}, env = nil, headers = {}) ⇒ Object
- .pdf(id, params = {}, env = nil, headers = {}) ⇒ Object
- .quote_line_groups_for_quote(id, params = {}, env = nil, headers = {}) ⇒ Object
-
.retrieve(id, env = nil, headers = {}) ⇒ Object
OPERATIONS ———–.
- .update_status(id, params, env = nil, headers = {}) ⇒ Object
- .update_subscription_quote(params, env = nil, headers = {}) ⇒ Object
- .update_subscription_quote_for_items(params, env = nil, headers = {}) ⇒ Object
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_due ⇒ Object
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_paid ⇒ Object
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_address ⇒ Object
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_id ⇒ Object
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_acceptance ⇒ Object
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_end ⇒ Object
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_start ⇒ Object
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_fee ⇒ Object
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_applied ⇒ Object
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_code ⇒ Object
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_id ⇒ Object
Returns the value of attribute customer_id.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def customer_id @customer_id end |
#date ⇒ Object
Returns the value of attribute date.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def date @date end |
#deleted ⇒ Object
Returns the value of attribute deleted.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def deleted @deleted end |
#discounts ⇒ Object
Returns the value of attribute discounts.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def discounts @discounts end |
#id ⇒ Object
Returns the value of attribute id.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def id @id end |
#invoice_id ⇒ Object
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_discounts ⇒ Object
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_taxes ⇒ Object
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_tiers ⇒ Object
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_items ⇒ Object
Returns the value of attribute line_items.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def line_items @line_items end |
#name ⇒ Object
Returns the value of attribute name.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def name @name end |
#notes ⇒ Object
Returns the value of attribute notes.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def notes @notes end |
#operation_type ⇒ Object
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_number ⇒ Object
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_type ⇒ Object
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_version ⇒ Object
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_address ⇒ Object
Returns the value of attribute shipping_address.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def shipping_address @shipping_address end |
#status ⇒ Object
Returns the value of attribute status.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def status @status end |
#sub_total ⇒ Object
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_id ⇒ Object
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_category ⇒ Object
Returns the value of attribute tax_category.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def tax_category @tax_category end |
#taxes ⇒ Object
Returns the value of attribute taxes.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def taxes @taxes end |
#total ⇒ Object
Returns the value of attribute total.
36 37 38 |
# File 'lib/chargebee/models/quote.rb', line 36 def total @total end |
#total_payable ⇒ Object
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_at ⇒ Object
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_till ⇒ Object
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_number ⇒ Object
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_prefix ⇒ Object
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 |
#version ⇒ Object
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
107 108 109 |
# File 'lib/chargebee/models/quote.rb', line 107 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
91 92 93 |
# File 'lib/chargebee/models/quote.rb', line 91 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
67 68 69 |
# File 'lib/chargebee/models/quote.rb', line 67 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
51 52 53 |
# File 'lib/chargebee/models/quote.rb', line 51 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
75 76 77 |
# File 'lib/chargebee/models/quote.rb', line 75 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
119 120 121 |
# File 'lib/chargebee/models/quote.rb', line 119 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
79 80 81 |
# File 'lib/chargebee/models/quote.rb', line 79 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
55 56 57 |
# File 'lib/chargebee/models/quote.rb', line 55 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
95 96 97 |
# File 'lib/chargebee/models/quote.rb', line 95 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
71 72 73 |
# File 'lib/chargebee/models/quote.rb', line 71 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
63 64 65 |
# File 'lib/chargebee/models/quote.rb', line 63 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
87 88 89 |
# File 'lib/chargebee/models/quote.rb', line 87 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
115 116 117 |
# File 'lib/chargebee/models/quote.rb', line 115 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
99 100 101 |
# File 'lib/chargebee/models/quote.rb', line 99 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
123 124 125 |
# File 'lib/chargebee/models/quote.rb', line 123 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
103 104 105 |
# File 'lib/chargebee/models/quote.rb', line 103 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
47 48 49 |
# File 'lib/chargebee/models/quote.rb', line 47 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
111 112 113 |
# File 'lib/chargebee/models/quote.rb', line 111 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
59 60 61 |
# File 'lib/chargebee/models/quote.rb', line 59 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
83 84 85 |
# File 'lib/chargebee/models/quote.rb', line 83 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 |