Class: ChargeBee::Order

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

Defined Under Namespace

Classes: BillingAddress, LineItemDiscount, LineItemTax, LinkedCreditNote, OrderLineItem, ResentOrder, ShippingAddress

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_adjusted ⇒ Object

Returns the value of attribute amount_adjusted.



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

def amount_adjusted
  @amount_adjusted
end

#amount_paid ⇒ Object

Returns the value of attribute amount_paid.



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

def amount_paid
  @amount_paid
end

#batch_id ⇒ Object

Returns the value of attribute batch_id.



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

def batch_id
  @batch_id
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#cancellation_reason ⇒ Object

Returns the value of attribute cancellation_reason.



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

def cancellation_reason
  @cancellation_reason
end

#cancelled_at ⇒ Object

Returns the value of attribute cancelled_at.



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

def cancelled_at
  @cancelled_at
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



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

def customer_id
  @customer_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



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

def deleted
  @deleted
end

#delivered_at ⇒ Object

Returns the value of attribute delivered_at.



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

def delivered_at
  @delivered_at
end

#discount ⇒ Object

Returns the value of attribute discount.



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

def discount
  @discount
end

#document_number ⇒ Object

Returns the value of attribute document_number.



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

def document_number
  @document_number
end

#fulfillment_status ⇒ Object

Returns the value of attribute fulfillment_status.



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

def fulfillment_status
  @fulfillment_status
end

#gift_id ⇒ Object

Returns the value of attribute gift_id.



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

def gift_id
  @gift_id
end

#gift_note ⇒ Object

Returns the value of attribute gift_note.



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

def gift_note
  @gift_note
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_id ⇒ Object

Returns the value of attribute invoice_id.



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

def invoice_id
  @invoice_id
end

#invoice_round_off_amount ⇒ Object

Returns the value of attribute invoice_round_off_amount.



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

def invoice_round_off_amount
  @invoice_round_off_amount
end

#is_gifted ⇒ Object

Returns the value of attribute is_gifted.



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

def is_gifted
  @is_gifted
end

#is_resent ⇒ Object

Returns the value of attribute is_resent.



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

def is_resent
  @is_resent
end

#line_item_discounts ⇒ Object

Returns the value of attribute line_item_discounts.



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

def line_item_discounts
  @line_item_discounts
end

#line_item_taxes ⇒ Object

Returns the value of attribute line_item_taxes.



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

def line_item_taxes
  @line_item_taxes
end

#linked_credit_notes ⇒ Object

Returns the value of attribute linked_credit_notes.



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

def linked_credit_notes
  @linked_credit_notes
end

#note ⇒ Object

Returns the value of attribute note.



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

def note
  @note
end

#order_date ⇒ Object

Returns the value of attribute order_date.



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

def order_date
  @order_date
end

#order_line_items ⇒ Object

Returns the value of attribute order_line_items.



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

def order_line_items
  @order_line_items
end

#order_type ⇒ Object

Returns the value of attribute order_type.



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

def order_type
  @order_type
end

#original_order_id ⇒ Object

Returns the value of attribute original_order_id.



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

def original_order_id
  @original_order_id
end

Returns the value of attribute paid_on.



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

def paid_on
  @paid_on
end

#payment_status ⇒ Object

Returns the value of attribute payment_status.



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

def payment_status
  @payment_status
end

#price_type ⇒ Object

Returns the value of attribute price_type.



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

def price_type
  @price_type
end

#reference_id ⇒ Object

Returns the value of attribute reference_id.



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

def reference_id
  @reference_id
end

#refundable_credits ⇒ Object

Returns the value of attribute refundable_credits.



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

def refundable_credits
  @refundable_credits
end

#refundable_credits_issued ⇒ Object

Returns the value of attribute refundable_credits_issued.



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

def refundable_credits_issued
  @refundable_credits_issued
end

#resend_reason ⇒ Object

Returns the value of attribute resend_reason.



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

def resend_reason
  @resend_reason
end

#resent_orders ⇒ Object

Returns the value of attribute resent_orders.



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

def resent_orders
  @resent_orders
end

#resent_status ⇒ Object

Returns the value of attribute resent_status.



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

def resent_status
  @resent_status
end

#resource_version ⇒ Object

Returns the value of attribute resource_version.



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

def resource_version
  @resource_version
end

#rounding_adjustement ⇒ Object

Returns the value of attribute rounding_adjustement.



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

def rounding_adjustement
  @rounding_adjustement
end

#shipment_carrier ⇒ Object

Returns the value of attribute shipment_carrier.



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

def shipment_carrier
  @shipment_carrier
end

#shipped_at ⇒ Object

Returns the value of attribute shipped_at.



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

def shipped_at
  @shipped_at
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#shipping_cut_off_date ⇒ Object

Returns the value of attribute shipping_cut_off_date.



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

def shipping_cut_off_date
  @shipping_cut_off_date
end

#shipping_date ⇒ Object

Returns the value of attribute shipping_date.



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

def shipping_date
  @shipping_date
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#status_update_at ⇒ Object

Returns the value of attribute status_update_at.



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

def status_update_at
  @status_update_at
end

#sub_total ⇒ Object

Returns the value of attribute sub_total.



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

def sub_total
  @sub_total
end

#subscription_id ⇒ Object

Returns the value of attribute subscription_id.



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

def subscription_id
  @subscription_id
end

#tax ⇒ Object

Returns the value of attribute tax.



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

def tax
  @tax
end

#total ⇒ Object

Returns the value of attribute total.



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

def total
  @total
end

#tracking_id ⇒ Object

Returns the value of attribute tracking_id.



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

def tracking_id
  @tracking_id
end

#tracking_url ⇒ Object

Returns the value of attribute tracking_url.



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

def tracking_url
  @tracking_url
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



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

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

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



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

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

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

OPERATIONS



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

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

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



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

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

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



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

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

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



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

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

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



81
82
83
 
# File 'lib/chargebee/models/order.rb', line 81

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

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



85
86
87
 
# File 'lib/chargebee/models/order.rb', line 85

def self.orders_for_invoice(id, params={}, env=nil, headers={})
  Request.send('get', uri_path("invoices",id.to_s,"orders"), params, env, headers)
end

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



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

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

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



89
90
91
 
# File 'lib/chargebee/models/order.rb', line 89

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

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



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

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

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



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

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