Class: ChargeBee::Customer
- Defined in:
- lib/chargebee/models/customer.rb
Defined Under Namespace
Classes: Balance, BillingAddress, ChildAccountAccess, Contact, ParentAccountAccess, PaymentMethod, ReferralUrl, Relationship
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.
-
#balances ⇒ Object
Returns the value of attribute balances.
-
#billing_address ⇒ Object
Returns the value of attribute billing_address.
-
#billing_date ⇒ Object
Returns the value of attribute billing_date.
-
#billing_date_mode ⇒ Object
Returns the value of attribute billing_date_mode.
-
#billing_day_of_week ⇒ Object
Returns the value of attribute billing_day_of_week.
-
#billing_day_of_week_mode ⇒ Object
Returns the value of attribute billing_day_of_week_mode.
-
#business_customer_without_vat_number ⇒ Object
Returns the value of attribute business_customer_without_vat_number.
-
#card_status ⇒ Object
Returns the value of attribute card_status.
-
#child_account_access ⇒ Object
Returns the value of attribute child_account_access.
-
#client_profile_id ⇒ Object
Returns the value of attribute client_profile_id.
-
#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.
-
#customer_type ⇒ Object
Returns the value of attribute customer_type.
-
#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.
-
#exemption_details ⇒ Object
Returns the value of attribute exemption_details.
-
#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.
-
#is_location_valid ⇒ Object
Returns the value of attribute is_location_valid.
-
#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.
-
#offline_payment_method ⇒ Object
Returns the value of attribute offline_payment_method.
-
#parent_account_access ⇒ Object
Returns the value of attribute parent_account_access.
-
#payment_method ⇒ Object
Returns the value of attribute payment_method.
-
#phone ⇒ Object
Returns the value of attribute phone.
-
#pii_cleared ⇒ Object
Returns the value of attribute pii_cleared.
-
#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.
-
#registered_for_gst ⇒ Object
Returns the value of attribute registered_for_gst.
-
#relationship ⇒ Object
Returns the value of attribute relationship.
-
#resource_version ⇒ Object
Returns the value of attribute resource_version.
-
#taxability ⇒ Object
Returns the value of attribute taxability.
-
#unbilled_charges ⇒ Object
Returns the value of attribute unbilled_charges.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
-
#use_default_hierarchy_settings ⇒ Object
Returns the value of attribute use_default_hierarchy_settings.
-
#vat_number ⇒ Object
Returns the value of attribute vat_number.
-
#vat_number_status ⇒ Object
Returns the value of attribute vat_number_status.
-
#vat_number_validated_time ⇒ Object
Returns the value of attribute vat_number_validated_time.
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
- .change_billing_date(id, params = {}, env = nil, headers = {}) ⇒ Object
- .clear_personal_data(id, env = nil, headers = {}) ⇒ Object
- .collect_payment(id, params = {}, env = nil, headers = {}) ⇒ Object
- .contacts_for_customer(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
- .delete_relationship(id, env = nil, headers = {}) ⇒ Object
- .hierarchy(id, params = {}, env = nil, headers = {}) ⇒ Object
- .list(params = {}, env = nil, headers = {}) ⇒ Object
- .merge(params, env = nil, headers = {}) ⇒ Object
- .move(params, env = nil, headers = {}) ⇒ Object
- .record_excess_payment(id, params, env = nil, headers = {}) ⇒ Object
- .relationships(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_hierarchy_settings(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.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def allow_direct_debit @allow_direct_debit end |
#auto_collection ⇒ Object
Returns the value of attribute auto_collection.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def auto_collection @auto_collection end |
#backup_payment_source_id ⇒ Object
Returns the value of attribute backup_payment_source_id.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def backup_payment_source_id @backup_payment_source_id end |
#balances ⇒ Object
Returns the value of attribute balances.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def balances @balances end |
#billing_address ⇒ Object
Returns the value of attribute billing_address.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def billing_address @billing_address end |
#billing_date ⇒ Object
Returns the value of attribute billing_date.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def billing_date @billing_date end |
#billing_date_mode ⇒ Object
Returns the value of attribute billing_date_mode.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def billing_date_mode @billing_date_mode end |
#billing_day_of_week ⇒ Object
Returns the value of attribute billing_day_of_week.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def billing_day_of_week @billing_day_of_week end |
#billing_day_of_week_mode ⇒ Object
Returns the value of attribute billing_day_of_week_mode.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def billing_day_of_week_mode @billing_day_of_week_mode end |
#business_customer_without_vat_number ⇒ Object
Returns the value of attribute business_customer_without_vat_number.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def business_customer_without_vat_number @business_customer_without_vat_number end |
#card_status ⇒ Object
Returns the value of attribute card_status.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def card_status @card_status end |
#child_account_access ⇒ Object
Returns the value of attribute child_account_access.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def child_account_access @child_account_access end |
#client_profile_id ⇒ Object
Returns the value of attribute client_profile_id.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def client_profile_id @client_profile_id end |
#company ⇒ Object
Returns the value of attribute company.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def company @company end |
#consolidated_invoicing ⇒ Object
Returns the value of attribute consolidated_invoicing.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def consolidated_invoicing @consolidated_invoicing end |
#contacts ⇒ Object
Returns the value of attribute contacts.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def contacts @contacts end |
#created_at ⇒ Object
Returns the value of attribute created_at.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def created_at @created_at end |
#created_from_ip ⇒ Object
Returns the value of attribute created_from_ip.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def created_from_ip @created_from_ip end |
#customer_type ⇒ Object
Returns the value of attribute customer_type.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def customer_type @customer_type end |
#deleted ⇒ Object
Returns the value of attribute deleted.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def deleted @deleted end |
#email ⇒ Object
Returns the value of attribute email.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def email @email end |
#entity_code ⇒ Object
Returns the value of attribute entity_code.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def entity_code @entity_code end |
#excess_payments ⇒ Object
Returns the value of attribute excess_payments.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def excess_payments @excess_payments end |
#exempt_number ⇒ Object
Returns the value of attribute exempt_number.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def exempt_number @exempt_number end |
#exemption_details ⇒ Object
Returns the value of attribute exemption_details.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def exemption_details @exemption_details end |
#first_name ⇒ Object
Returns the value of attribute first_name.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def first_name @first_name end |
#fraud_flag ⇒ Object
Returns the value of attribute fraud_flag.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def fraud_flag @fraud_flag end |
#id ⇒ Object
Returns the value of attribute id.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def id @id end |
#invoice_notes ⇒ Object
Returns the value of attribute invoice_notes.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def invoice_notes @invoice_notes end |
#is_location_valid ⇒ Object
Returns the value of attribute is_location_valid.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def is_location_valid @is_location_valid end |
#last_name ⇒ Object
Returns the value of attribute last_name.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def last_name @last_name end |
#locale ⇒ Object
Returns the value of attribute locale.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def locale @locale end |
#meta_data ⇒ Object
Returns the value of attribute meta_data.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def @meta_data end |
#net_term_days ⇒ Object
Returns the value of attribute net_term_days.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def net_term_days @net_term_days end |
#offline_payment_method ⇒ Object
Returns the value of attribute offline_payment_method.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def offline_payment_method @offline_payment_method end |
#parent_account_access ⇒ Object
Returns the value of attribute parent_account_access.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def parent_account_access @parent_account_access end |
#payment_method ⇒ Object
Returns the value of attribute payment_method.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def payment_method @payment_method end |
#phone ⇒ Object
Returns the value of attribute phone.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def phone @phone end |
#pii_cleared ⇒ Object
Returns the value of attribute pii_cleared.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def pii_cleared @pii_cleared end |
#preferred_currency_code ⇒ Object
Returns the value of attribute preferred_currency_code.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def preferred_currency_code @preferred_currency_code end |
#primary_payment_source_id ⇒ Object
Returns the value of attribute primary_payment_source_id.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def primary_payment_source_id @primary_payment_source_id end |
#promotional_credits ⇒ Object
Returns the value of attribute promotional_credits.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def promotional_credits @promotional_credits end |
#referral_urls ⇒ Object
Returns the value of attribute referral_urls.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def referral_urls @referral_urls end |
#refundable_credits ⇒ Object
Returns the value of attribute refundable_credits.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def refundable_credits @refundable_credits end |
#registered_for_gst ⇒ Object
Returns the value of attribute registered_for_gst.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def registered_for_gst @registered_for_gst end |
#relationship ⇒ Object
Returns the value of attribute relationship.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def relationship @relationship end |
#resource_version ⇒ Object
Returns the value of attribute resource_version.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def resource_version @resource_version end |
#taxability ⇒ Object
Returns the value of attribute taxability.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def taxability @taxability end |
#unbilled_charges ⇒ Object
Returns the value of attribute unbilled_charges.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def unbilled_charges @unbilled_charges end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def updated_at @updated_at end |
#use_default_hierarchy_settings ⇒ Object
Returns the value of attribute use_default_hierarchy_settings.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def use_default_hierarchy_settings @use_default_hierarchy_settings end |
#vat_number ⇒ Object
Returns the value of attribute vat_number.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def vat_number @vat_number end |
#vat_number_status ⇒ Object
Returns the value of attribute vat_number_status.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def vat_number_status @vat_number_status end |
#vat_number_validated_time ⇒ Object
Returns the value of attribute vat_number_validated_time.
36 37 38 |
# File 'lib/chargebee/models/customer.rb', line 36 def vat_number_validated_time @vat_number_validated_time end |
Class Method Details
.add_contact(id, params, env = nil, headers = {}) ⇒ Object
82 83 84 |
# File 'lib/chargebee/models/customer.rb', line 82 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
94 95 96 |
# File 'lib/chargebee/models/customer.rb', line 94 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
78 79 80 |
# File 'lib/chargebee/models/customer.rb', line 78 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 |
.change_billing_date(id, params = {}, env = nil, headers = {}) ⇒ Object
122 123 124 |
# File 'lib/chargebee/models/customer.rb', line 122 def self.change_billing_date(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"change_billing_date"), params, env, headers) end |
.clear_personal_data(id, env = nil, headers = {}) ⇒ Object
130 131 132 |
# File 'lib/chargebee/models/customer.rb', line 130 def self.clear_personal_data(id, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"clear_personal_data"), {}, env, headers) end |
.collect_payment(id, params = {}, env = nil, headers = {}) ⇒ Object
110 111 112 |
# File 'lib/chargebee/models/customer.rb', line 110 def self.collect_payment(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"collect_payment"), params, env, headers) end |
.contacts_for_customer(id, params = {}, env = nil, headers = {}) ⇒ Object
74 75 76 |
# File 'lib/chargebee/models/customer.rb', line 74 def self.contacts_for_customer(id, params={}, env=nil, headers={}) Request.send('get', uri_path("customers",id.to_s,"contacts"), params, env, headers) end |
.create(params = {}, env = nil, headers = {}) ⇒ Object
OPERATIONS
50 51 52 |
# File 'lib/chargebee/models/customer.rb', line 50 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
98 99 100 |
# File 'lib/chargebee/models/customer.rb', line 98 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
114 115 116 |
# File 'lib/chargebee/models/customer.rb', line 114 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
90 91 92 |
# File 'lib/chargebee/models/customer.rb', line 90 def self.delete_contact(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"delete_contact"), params, env, headers) end |
.delete_relationship(id, env = nil, headers = {}) ⇒ Object
138 139 140 |
# File 'lib/chargebee/models/customer.rb', line 138 def self.delete_relationship(id, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"delete_relationship"), {}, env, headers) end |
.hierarchy(id, params = {}, env = nil, headers = {}) ⇒ Object
142 143 144 |
# File 'lib/chargebee/models/customer.rb', line 142 def self.hierarchy(id, params={}, env=nil, headers={}) Request.send('get', uri_path("customers",id.to_s,"hierarchy"), params, env, headers) end |
.list(params = {}, env = nil, headers = {}) ⇒ Object
54 55 56 |
# File 'lib/chargebee/models/customer.rb', line 54 def self.list(params={}, env=nil, headers={}) Request.send_list_request('get', uri_path("customers"), params, env, headers) end |
.merge(params, env = nil, headers = {}) ⇒ Object
126 127 128 |
# File 'lib/chargebee/models/customer.rb', line 126 def self.merge(params, env=nil, headers={}) Request.send('post', uri_path("customers","merge"), params, env, headers) end |
.move(params, env = nil, headers = {}) ⇒ Object
118 119 120 |
# File 'lib/chargebee/models/customer.rb', line 118 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
106 107 108 |
# File 'lib/chargebee/models/customer.rb', line 106 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 |
.relationships(id, params = {}, env = nil, headers = {}) ⇒ Object
134 135 136 |
# File 'lib/chargebee/models/customer.rb', line 134 def self.relationships(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"relationships"), params, env, headers) end |
.retrieve(id, env = nil, headers = {}) ⇒ Object
58 59 60 |
# File 'lib/chargebee/models/customer.rb', line 58 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
102 103 104 |
# File 'lib/chargebee/models/customer.rb', line 102 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
62 63 64 |
# File 'lib/chargebee/models/customer.rb', line 62 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
70 71 72 |
# File 'lib/chargebee/models/customer.rb', line 70 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 |
.update_contact(id, params, env = nil, headers = {}) ⇒ Object
86 87 88 |
# File 'lib/chargebee/models/customer.rb', line 86 def self.update_contact(id, params, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"update_contact"), params, env, headers) end |
.update_hierarchy_settings(id, params = {}, env = nil, headers = {}) ⇒ Object
146 147 148 |
# File 'lib/chargebee/models/customer.rb', line 146 def self.update_hierarchy_settings(id, params={}, env=nil, headers={}) Request.send('post', uri_path("customers",id.to_s,"update_hierarchy_settings"), params, env, headers) end |