Class: ChargeBee::Customer
- Defined in:
- lib/chargebee/models/customer.rb
Defined Under Namespace
Classes: BillingAddress, Contact, PaymentMethod, ReferralUrl
Instance Attribute Summary collapse
-
#allow_direct_debit ⇒ Object
Returns the value of attribute allow_direct_debit.
-
#auto_collection ⇒ Object
Returns the value of attribute auto_collection.
-
#backup_payment_source_id ⇒ Object
Returns the value of attribute backup_payment_source_id.
-
#billing_address ⇒ Object
Returns the value of attribute billing_address.
-
#card_status ⇒ Object
Returns the value of attribute card_status.
-
#company ⇒ Object
Returns the value of attribute company.
-
#consolidated_invoicing ⇒ Object
Returns the value of attribute consolidated_invoicing.
-
#contacts ⇒ Object
Returns the value of attribute contacts.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#created_from_ip ⇒ Object
Returns the value of attribute created_from_ip.
-
#deleted ⇒ Object
Returns the value of attribute deleted.
-
#email ⇒ Object
Returns the value of attribute email.
-
#entity_code ⇒ Object
Returns the value of attribute entity_code.
-
#excess_payments ⇒ Object
Returns the value of attribute excess_payments.
-
#exempt_number ⇒ Object
Returns the value of attribute exempt_number.
-
#first_name ⇒ Object
Returns the value of attribute first_name.
-
#fraud_flag ⇒ Object
Returns the value of attribute fraud_flag.
-
#id ⇒ Object
Returns the value of attribute id.
-
#invoice_notes ⇒ Object
Returns the value of attribute invoice_notes.
-
#last_name ⇒ Object
Returns the value of attribute last_name.
-
#locale ⇒ Object
Returns the value of attribute locale.
-
#meta_data ⇒ Object
Returns the value of attribute meta_data.
-
#net_term_days ⇒ Object
Returns the value of attribute net_term_days.
-
#payment_method ⇒ Object
Returns the value of attribute payment_method.
-
#phone ⇒ Object
Returns the value of attribute phone.
-
#preferred_currency_code ⇒ Object
Returns the value of attribute preferred_currency_code.
-
#primary_payment_source_id ⇒ Object
Returns the value of attribute primary_payment_source_id.
-
#promotional_credits ⇒ Object
Returns the value of attribute promotional_credits.
-
#referral_urls ⇒ Object
Returns the value of attribute referral_urls.
-
#refundable_credits ⇒ Object
Returns the value of attribute refundable_credits.
-
#resource_version ⇒ Object
Returns the value of attribute resource_version.
-
#taxability ⇒ Object
Returns the value of attribute taxability.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
-
#vat_number ⇒ Object
Returns the value of attribute vat_number.
Class Method Summary collapse
- .add_contact(id, params, env = nil, headers = {}) ⇒ Object
- .add_promotional_credits(id, params, env = nil, headers = {}) ⇒ Object
- .assign_payment_role(id, params, env = nil, headers = {}) ⇒ Object
-
.create(params = {}, env = nil, headers = {}) ⇒ Object
OPERATIONS -----------.
- .deduct_promotional_credits(id, params, env = nil, headers = {}) ⇒ Object
- .delete(id, params = {}, env = nil, headers = {}) ⇒ Object
- .delete_contact(id, params, env = nil, headers = {}) ⇒ Object
- .list(params = {}, env = nil, headers = {}) ⇒ Object
- .move(params, env = nil, headers = {}) ⇒ Object
- .record_excess_payment(id, params, env = nil, headers = {}) ⇒ Object
- .retrieve(id, env = nil, headers = {}) ⇒ Object
- .set_promotional_credits(id, params, env = nil, headers = {}) ⇒ Object
- .update(id, params = {}, env = nil, headers = {}) ⇒ Object
- .update_billing_info(id, params = {}, env = nil, headers = {}) ⇒ Object
- .update_contact(id, params, env = nil, headers = {}) ⇒ Object
- .update_payment_method(id, params, env = nil, headers = {}) ⇒ Object
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
#allow_direct_debit ⇒ Object
Returns the value of attribute allow_direct_debit.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def allow_direct_debit @allow_direct_debit end |
#auto_collection ⇒ Object
Returns the value of attribute auto_collection.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def auto_collection @auto_collection end |
#backup_payment_source_id ⇒ Object
Returns the value of attribute backup_payment_source_id.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def backup_payment_source_id @backup_payment_source_id end |
#billing_address ⇒ Object
Returns the value of attribute billing_address.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def billing_address @billing_address end |
#card_status ⇒ Object
Returns the value of attribute card_status.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def card_status @card_status end |
#company ⇒ Object
Returns the value of attribute company.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def company @company end |
#consolidated_invoicing ⇒ Object
Returns the value of attribute consolidated_invoicing.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def consolidated_invoicing @consolidated_invoicing end |
#contacts ⇒ Object
Returns the value of attribute contacts.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def contacts @contacts end |
#created_at ⇒ Object
Returns the value of attribute created_at.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def created_at @created_at end |
#created_from_ip ⇒ Object
Returns the value of attribute created_from_ip.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def created_from_ip @created_from_ip end |
#deleted ⇒ Object
Returns the value of attribute deleted.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def deleted @deleted end |
#email ⇒ Object
Returns the value of attribute email.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def email @email end |
#entity_code ⇒ Object
Returns the value of attribute entity_code.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def entity_code @entity_code end |
#excess_payments ⇒ Object
Returns the value of attribute excess_payments.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def excess_payments @excess_payments end |
#exempt_number ⇒ Object
Returns the value of attribute exempt_number.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def exempt_number @exempt_number end |
#first_name ⇒ Object
Returns the value of attribute first_name.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def first_name @first_name end |
#fraud_flag ⇒ Object
Returns the value of attribute fraud_flag.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def fraud_flag @fraud_flag end |
#id ⇒ Object
Returns the value of attribute id.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def id @id end |
#invoice_notes ⇒ Object
Returns the value of attribute invoice_notes.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def invoice_notes @invoice_notes end |
#last_name ⇒ Object
Returns the value of attribute last_name.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def last_name @last_name end |
#locale ⇒ Object
Returns the value of attribute locale.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def locale @locale end |
#meta_data ⇒ Object
Returns the value of attribute meta_data.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def @meta_data end |
#net_term_days ⇒ Object
Returns the value of attribute net_term_days.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def net_term_days @net_term_days end |
#payment_method ⇒ Object
Returns the value of attribute payment_method.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def payment_method @payment_method end |
#phone ⇒ Object
Returns the value of attribute phone.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def phone @phone end |
#preferred_currency_code ⇒ Object
Returns the value of attribute preferred_currency_code.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def preferred_currency_code @preferred_currency_code end |
#primary_payment_source_id ⇒ Object
Returns the value of attribute primary_payment_source_id.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def primary_payment_source_id @primary_payment_source_id end |
#promotional_credits ⇒ Object
Returns the value of attribute promotional_credits.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def promotional_credits @promotional_credits end |
#referral_urls ⇒ Object
Returns the value of attribute referral_urls.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def referral_urls @referral_urls end |
#refundable_credits ⇒ Object
Returns the value of attribute refundable_credits.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def refundable_credits @refundable_credits end |
#resource_version ⇒ Object
Returns the value of attribute resource_version.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def resource_version @resource_version end |
#taxability ⇒ Object
Returns the value of attribute taxability.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def taxability @taxability end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def updated_at @updated_at end |
#vat_number ⇒ Object
Returns the value of attribute vat_number.
20 21 22 |
# File 'lib/chargebee/models/customer.rb', line 20 def vat_number @vat_number end |
Class Method Details
.add_contact(id, params, env = nil, headers = {}) ⇒ Object
58 59 60 |
# File 'lib/chargebee/models/customer.rb', line 58 def self.add_contact(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"add_contact"), params, env, headers) end |
.add_promotional_credits(id, params, env = nil, headers = {}) ⇒ Object
70 71 72 |
# File 'lib/chargebee/models/customer.rb', line 70 def self.add_promotional_credits(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"add_promotional_credits"), params, env, headers) end |
.assign_payment_role(id, params, env = nil, headers = {}) ⇒ Object
54 55 56 |
# File 'lib/chargebee/models/customer.rb', line 54 def self.assign_payment_role(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"assign_payment_role"), params, env, headers) end |
.create(params = {}, env = nil, headers = {}) ⇒ Object
OPERATIONS
30 31 32 |
# File 'lib/chargebee/models/customer.rb', line 30 def self.create(params={}, env=nil, headers={}) Request.send('post', uri_path("customers"), params, env, headers) end |
.deduct_promotional_credits(id, params, env = nil, headers = {}) ⇒ Object
74 75 76 |
# File 'lib/chargebee/models/customer.rb', line 74 def self.deduct_promotional_credits(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"deduct_promotional_credits"), params, env, headers) end |
.delete(id, params = {}, env = nil, headers = {}) ⇒ Object
86 87 88 |
# File 'lib/chargebee/models/customer.rb', line 86 def self.delete(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"delete"), params, env, headers) end |
.delete_contact(id, params, env = nil, headers = {}) ⇒ Object
66 67 68 |
# File 'lib/chargebee/models/customer.rb', line 66 def self.delete_contact(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"delete_contact"), params, env, headers) end |
.list(params = {}, env = nil, headers = {}) ⇒ Object
34 35 36 |
# File 'lib/chargebee/models/customer.rb', line 34 def self.list(params={}, env=nil, headers={}) Request.send_list_request('get', uri_path("customers"), params, env, headers) end |
.move(params, env = nil, headers = {}) ⇒ Object
90 91 92 |
# File 'lib/chargebee/models/customer.rb', line 90 def self.move(params, env=nil, headers={}) Request.send('post', uri_path("customers","move"), params, env, headers) end |
.record_excess_payment(id, params, env = nil, headers = {}) ⇒ Object
82 83 84 |
# File 'lib/chargebee/models/customer.rb', line 82 def self.record_excess_payment(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"record_excess_payment"), params, env, headers) end |
.retrieve(id, env = nil, headers = {}) ⇒ Object
38 39 40 |
# File 'lib/chargebee/models/customer.rb', line 38 def self.retrieve(id, env=nil, headers={}) Request.send('get', uri_path("customers",id.to_s), {}, env, headers) end |
.set_promotional_credits(id, params, env = nil, headers = {}) ⇒ Object
78 79 80 |
# File 'lib/chargebee/models/customer.rb', line 78 def self.set_promotional_credits(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"set_promotional_credits"), params, env, headers) end |
.update(id, params = {}, env = nil, headers = {}) ⇒ Object
42 43 44 |
# File 'lib/chargebee/models/customer.rb', line 42 def self.update(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s), params, env, headers) end |
.update_billing_info(id, params = {}, env = nil, headers = {}) ⇒ Object
50 51 52 |
# File 'lib/chargebee/models/customer.rb', line 50 def self.update_billing_info(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"update_billing_info"), params, env, headers) end |