Class: ChargeBee::Customer

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

Defined Under Namespace

Classes: Balance, BillingAddress, ChildAccountAccess, Contact, EntityIdentifier, ParentAccountAccess, PaymentMethod, ReferralUrl, Relationship, TaxProvidersField

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

#active_id ⇒ Object

Returns the value of attribute active_id.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def active_id
  @active_id
end

#allow_direct_debit ⇒ Object

Returns the value of attribute allow_direct_debit.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def allow_direct_debit
  @allow_direct_debit
end

#auto_close_invoices ⇒ Object

Returns the value of attribute auto_close_invoices.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def auto_close_invoices
  @auto_close_invoices
end

#auto_collection ⇒ Object

Returns the value of attribute auto_collection.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def auto_collection
  @auto_collection
end

#backup_payment_source_id ⇒ Object

Returns the value of attribute backup_payment_source_id.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def backup_payment_source_id
  @backup_payment_source_id
end

#balances ⇒ Object

Returns the value of attribute balances.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def balances
  @balances
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def billing_address
  @billing_address
end

#billing_date ⇒ Object

Returns the value of attribute billing_date.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def billing_date
  @billing_date
end

#billing_date_mode ⇒ Object

Returns the value of attribute billing_date_mode.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def billing_date_mode
  @billing_date_mode
end

#billing_day_of_week ⇒ Object

Returns the value of attribute billing_day_of_week.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

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.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def billing_day_of_week_mode
  @billing_day_of_week_mode
end

#billing_month ⇒ Object

Returns the value of attribute billing_month.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def billing_month
  @billing_month
end

#business_customer_without_vat_number ⇒ Object

Returns the value of attribute business_customer_without_vat_number.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def business_customer_without_vat_number
  @business_customer_without_vat_number
end

#business_entity_id ⇒ Object

Returns the value of attribute business_entity_id.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def business_entity_id
  @business_entity_id
end

#card_status ⇒ Object

Returns the value of attribute card_status.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def card_status
  @card_status
end

#channel ⇒ Object

Returns the value of attribute channel.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def channel
  @channel
end

#child_account_access ⇒ Object

Returns the value of attribute child_account_access.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def 
  @child_account_access
end

#client_profile_id ⇒ Object

Returns the value of attribute client_profile_id.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def client_profile_id
  @client_profile_id
end

#company ⇒ Object

Returns the value of attribute company.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def company
  @company
end

#consolidated_invoicing ⇒ Object

Returns the value of attribute consolidated_invoicing.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def consolidated_invoicing
  @consolidated_invoicing
end

#contacts ⇒ Object

Returns the value of attribute contacts.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def contacts
  @contacts
end

#created_at ⇒ Object

Returns the value of attribute created_at.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def created_at
  @created_at
end

#created_from_ip ⇒ Object

Returns the value of attribute created_from_ip.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def created_from_ip
  @created_from_ip
end

#customer_type ⇒ Object

Returns the value of attribute customer_type.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def customer_type
  @customer_type
end

#deleted ⇒ Object

Returns the value of attribute deleted.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def deleted
  @deleted
end

#einvoicing_method ⇒ Object

Returns the value of attribute einvoicing_method.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def einvoicing_method
  @einvoicing_method
end

#email ⇒ Object

Returns the value of attribute email.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def email
  @email
end

#entity_code ⇒ Object

Returns the value of attribute entity_code.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def entity_code
  @entity_code
end

#entity_identifier_scheme ⇒ Object

Returns the value of attribute entity_identifier_scheme.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def entity_identifier_scheme
  @entity_identifier_scheme
end

#entity_identifier_standard ⇒ Object

Returns the value of attribute entity_identifier_standard.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def entity_identifier_standard
  @entity_identifier_standard
end

#entity_identifiers ⇒ Object

Returns the value of attribute entity_identifiers.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def entity_identifiers
  @entity_identifiers
end

#excess_payments ⇒ Object

Returns the value of attribute excess_payments.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def excess_payments
  @excess_payments
end

#exempt_number ⇒ Object

Returns the value of attribute exempt_number.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def exempt_number
  @exempt_number
end

#exemption_details ⇒ Object

Returns the value of attribute exemption_details.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def exemption_details
  @exemption_details
end

#first_name ⇒ Object

Returns the value of attribute first_name.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def first_name
  @first_name
end

#fraud_flag ⇒ Object

Returns the value of attribute fraud_flag.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def fraud_flag
  @fraud_flag
end

#id ⇒ Object

Returns the value of attribute id.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def id
  @id
end

#invoice_notes ⇒ Object

Returns the value of attribute invoice_notes.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def invoice_notes
  @invoice_notes
end

#is_einvoice_enabled ⇒ Object

Returns the value of attribute is_einvoice_enabled.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def is_einvoice_enabled
  @is_einvoice_enabled
end

#is_location_valid ⇒ Object

Returns the value of attribute is_location_valid.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def is_location_valid
  @is_location_valid
end

#last_name ⇒ Object

Returns the value of attribute last_name.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def last_name
  @last_name
end

#locale ⇒ Object

Returns the value of attribute locale.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def locale
  @locale
end

#meta_data ⇒ Object

Returns the value of attribute meta_data.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def meta_data
  @meta_data
end

#net_term_days ⇒ Object

Returns the value of attribute net_term_days.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def net_term_days
  @net_term_days
end

#offline_payment_method ⇒ Object

Returns the value of attribute offline_payment_method.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def offline_payment_method
  @offline_payment_method
end

#parent_account_access ⇒ Object

Returns the value of attribute parent_account_access.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def 
  @parent_account_access
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def payment_method
  @payment_method
end

#phone ⇒ Object

Returns the value of attribute phone.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def phone
  @phone
end

#pii_cleared ⇒ Object

Returns the value of attribute pii_cleared.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def pii_cleared
  @pii_cleared
end

#preferred_currency_code ⇒ Object

Returns the value of attribute preferred_currency_code.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def preferred_currency_code
  @preferred_currency_code
end

#primary_payment_source_id ⇒ Object

Returns the value of attribute primary_payment_source_id.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def primary_payment_source_id
  @primary_payment_source_id
end

#promotional_credits ⇒ Object

Returns the value of attribute promotional_credits.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def promotional_credits
  @promotional_credits
end

#referral_urls ⇒ Object

Returns the value of attribute referral_urls.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def referral_urls
  @referral_urls
end

#refundable_credits ⇒ Object

Returns the value of attribute refundable_credits.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def refundable_credits
  @refundable_credits
end

#registered_for_gst ⇒ Object

Returns the value of attribute registered_for_gst.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def registered_for_gst
  @registered_for_gst
end

#relationship ⇒ Object

Returns the value of attribute relationship.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def relationship
  @relationship
end

#resource_version ⇒ Object

Returns the value of attribute resource_version.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def resource_version
  @resource_version
end

#tax_providers_fields ⇒ Object

Returns the value of attribute tax_providers_fields.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def tax_providers_fields
  @tax_providers_fields
end

#taxability ⇒ Object

Returns the value of attribute taxability.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def taxability
  @taxability
end

#unbilled_charges ⇒ Object

Returns the value of attribute unbilled_charges.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def unbilled_charges
  @unbilled_charges
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def updated_at
  @updated_at
end

#use_default_hierarchy_settings ⇒ Object

Returns the value of attribute use_default_hierarchy_settings.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def use_default_hierarchy_settings
  @use_default_hierarchy_settings
end

#vat_number ⇒ Object

Returns the value of attribute vat_number.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def vat_number
  @vat_number
end

#vat_number_prefix ⇒ Object

Returns the value of attribute vat_number_prefix.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def vat_number_prefix
  @vat_number_prefix
end

#vat_number_status ⇒ Object

Returns the value of attribute vat_number_status.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def vat_number_status
  @vat_number_status
end

#vat_number_validated_time ⇒ Object

Returns the value of attribute vat_number_validated_time.



44
45
46
 
# File 'lib/chargebee/models/customer.rb', line 44

def vat_number_validated_time
  @vat_number_validated_time
end

Class Method Details

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



115
116
117
118
119
 
# File 'lib/chargebee/models/customer.rb', line 115

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

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



133
134
135
136
137
 
# File 'lib/chargebee/models/customer.rb', line 133

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

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



109
110
111
112
113
 
# File 'lib/chargebee/models/customer.rb', line 109

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

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



176
177
178
179
180
 
# File 'lib/chargebee/models/customer.rb', line 176

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

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



188
189
190
191
192
 
# File 'lib/chargebee/models/customer.rb', line 188

def self.clear_personal_data(id, env=nil, headers={})
  jsonKeys = { 
  }
  Request.send('post', uri_path("customers",id.to_s,"clear_personal_data"), {}, env, headers,nil, false, jsonKeys)
end

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



157
158
159
160
161
162
 
# File 'lib/chargebee/models/customer.rb', line 157

def self.collect_payment(id, params, env=nil, headers={})
  jsonKeys = { 
      :additional_information => 1,
  }
  Request.send('post', uri_path("customers",id.to_s,"collect_payment"), params, env, headers,nil, false, jsonKeys)
end

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



103
104
105
106
107
 
# File 'lib/chargebee/models/customer.rb', line 103

def self.contacts_for_customer(id, params={}, env=nil, headers={})
  jsonKeys = { 
  }
  Request.send('get', uri_path("customers",id.to_s,"contacts"), params, env, headers,nil, false, jsonKeys)
end

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

OPERATIONS



60
61
62
63
64
65
66
67
68
 
# File 'lib/chargebee/models/customer.rb', line 60

def self.create(params={}, env=nil, headers={})
  jsonKeys = { 
      :exemption_details => 0,
      :meta_data => 0,
      :additional_information => 1,
      :billing_address => 1,
  }
  Request.send('post', uri_path("customers"), params, env, headers,nil, false, jsonKeys)
end

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



139
140
141
142
143
 
# File 'lib/chargebee/models/customer.rb', line 139

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

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



164
165
166
167
168
 
# File 'lib/chargebee/models/customer.rb', line 164

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

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



127
128
129
130
131
 
# File 'lib/chargebee/models/customer.rb', line 127

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

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



200
201
202
203
204
 
# File 'lib/chargebee/models/customer.rb', line 200

def self.delete_relationship(id, env=nil, headers={})
  jsonKeys = { 
  }
  Request.send('post', uri_path("customers",id.to_s,"delete_relationship"), {}, env, headers,nil, false, jsonKeys)
end

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



206
207
208
209
210
 
# File 'lib/chargebee/models/customer.rb', line 206

def self.hierarchy(id, params, env=nil, headers={})
  jsonKeys = { 
  }
  Request.send('get', uri_path("customers",id.to_s,"hierarchy"), params, env, headers,nil, false, jsonKeys)
end

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



70
71
72
73
74
 
# File 'lib/chargebee/models/customer.rb', line 70

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

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



182
183
184
185
186
 
# File 'lib/chargebee/models/customer.rb', line 182

def self.merge(params, env=nil, headers={})
  jsonKeys = { 
  }
  Request.send('post', uri_path("customers","merge"), params, env, headers,nil, false, jsonKeys)
end

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



170
171
172
173
174
 
# File 'lib/chargebee/models/customer.rb', line 170

def self.move(params, env=nil, headers={})
  jsonKeys = { 
  }
  Request.send('post', uri_path("customers","move"), params, env, headers,nil, false, jsonKeys)
end

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



151
152
153
154
155
 
# File 'lib/chargebee/models/customer.rb', line 151

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

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



194
195
196
197
198
 
# File 'lib/chargebee/models/customer.rb', line 194

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

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



76
77
78
79
80
 
# File 'lib/chargebee/models/customer.rb', line 76

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

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



145
146
147
148
149
 
# File 'lib/chargebee/models/customer.rb', line 145

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

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



82
83
84
85
86
87
88
 
# File 'lib/chargebee/models/customer.rb', line 82

def self.update(id, params={}, env=nil, headers={})
  jsonKeys = { 
      :exemption_details => 0,
      :meta_data => 0,
  }
  Request.send('post', uri_path("customers",id.to_s), params, env, headers,nil, false, jsonKeys)
end

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



97
98
99
100
101
 
# File 'lib/chargebee/models/customer.rb', line 97

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

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



121
122
123
124
125
 
# File 'lib/chargebee/models/customer.rb', line 121

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

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



212
213
214
215
216
 
# File 'lib/chargebee/models/customer.rb', line 212

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

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



90
91
92
93
94
95
 
# File 'lib/chargebee/models/customer.rb', line 90

def self.update_payment_method(id, params, env=nil, headers={})
  jsonKeys = { 
      :additional_information => 1,
  }
  Request.send('post', uri_path("customers",id.to_s,"update_payment_method"), params, env, headers,nil, false, jsonKeys)
end