Class: KillBillClient::Model::Account
Constant Summary
collapse
- KILLBILL_API_ACCOUNTS_PREFIX =
"#{KILLBILL_API_PREFIX}/accounts"
Constants included
from TagHelper
TagHelper::AUTO_INVOICING_OFF_ID, TagHelper::AUTO_PAY_OFF_ID, TagHelper::MANUAL_PAY_ID, TagHelper::OVERDUE_ENFORCEMENT_OFF_ID, TagHelper::TEST_ID, TagHelper::WRITTEN_OFF_ID
Constants inherited
from Resource
Resource::KILLBILL_API_PAGINATION_PREFIX, Resource::KILLBILL_API_PREFIX
Instance Attribute Summary
Attributes inherited from Resource
#clazz, #etag, #response, #session_id, #uri
Class Method Summary
collapse
-
.blocking_state_audit_logs_with_history(blocking_state_id, options = {}) ⇒ Object
-
.find_by_external_key(external_key, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
-
.find_by_id(account_id, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
-
.find_children(account_id, with_balance = false, with_balance_and_cba = false, audit = 'NONE', options = {}) ⇒ Object
-
.find_in_batches(offset = 0, limit = 100, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
-
.find_in_batches_by_search_key(search_key, offset = 0, limit = 100, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
Instance Method Summary
collapse
-
#add_email(email, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#all_custom_fields(object_type, audit = 'NONE', options = {}) ⇒ Object
-
#all_tags(object_type, included_deleted, audit = 'NONE', options = {}) ⇒ Object
-
#audit(options = {}) ⇒ Object
-
#auto_invoicing_off?(options = {}) ⇒ Boolean
-
#auto_pay_off?(options = {}) ⇒ Boolean
-
#blocking_states(blocking_state_types, blocking_state_svcs, audit = 'NONE', options = {}) ⇒ Object
-
#bundles(options = {}) ⇒ Object
-
#cba_rebalancing(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#children(with_balance = false, with_balance_and_cba = false, audit = 'NONE', options = {}) ⇒ Object
-
#close(cancel_subscriptions, writeoff_unpaid_invoices, item_adjust_unpaid_invoices, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#create(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#email_audit_logs_with_history(account_email_id, options = {}) ⇒ Object
-
#emails(audit = 'NONE', options = {}) ⇒ Object
-
#invoice_payments(audit = 'NONE', with_plugin_info = false, with_attempts = false, options = {}) ⇒ Object
-
#invoices(options = {}) ⇒ Object
-
#manual_pay?(options = {}) ⇒ Boolean
-
#migration_invoices(options = {}) ⇒ Object
-
#overdue(options = {}) ⇒ Object
-
#overdue_enforcement_off?(options = {}) ⇒ Boolean
-
#payments(options = {}) ⇒ Object
-
#remove_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#remove_auto_pay_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#remove_email(email, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#remove_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#remove_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#remove_test(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#remove_written_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_auto_pay_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_blocking_state(state_name, service, is_block_change, is_block_entitlement, is_block_billing, requested_date = nil, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_test(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#set_written_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#test?(options = {}) ⇒ Boolean
-
#transfer_child_credit(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#update(treat_null_as_reset = false, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
-
#written_off?(options = {}) ⇒ Boolean
included
included
Methods included from TagHelper
#add_tag, #add_tag_from_definition_id, #control_tag?, included, #remove_tag, #remove_tag_from_definition_id, #set_tags
Methods inherited from Resource
#==, #_to_hash, attribute, create_alias, delete, extract_session_id, from_json, from_response, get, has_many, has_one, #hash, head, #initialize, instantiate_record_from_json, post, put, #refresh, require_multi_tenant_options!, #to_hash, #to_json
Class Method Details
.blocking_state_audit_logs_with_history(blocking_state_id, options = {}) ⇒ Object
69
70
71
72
73
74
|
# File 'lib/killbill_client/models/account.rb', line 69
def blocking_state_audit_logs_with_history(blocking_state_id, options = {})
get "#{KILLBILL_API_ACCOUNTS_PREFIX}/block/#{blocking_state_id}/auditLogsWithHistory",
{},
options,
AuditLog
end
|
.find_by_external_key(external_key, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
38
39
40
41
42
43
44
45
46
|
# File 'lib/killbill_client/models/account.rb', line 38
def find_by_external_key(external_key, with_balance = false, with_balance_and_cba = false, options = {})
get "#{KILLBILL_API_ACCOUNTS_PREFIX}",
{
:externalKey => external_key,
:accountWithBalance => with_balance,
:accountWithBalanceAndCBA => with_balance_and_cba
},
options
end
|
.find_by_id(account_id, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
29
30
31
32
33
34
35
36
|
# File 'lib/killbill_client/models/account.rb', line 29
def find_by_id(account_id, with_balance = false, with_balance_and_cba = false, options = {})
get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}",
{
:accountWithBalance => with_balance,
:accountWithBalanceAndCBA => with_balance_and_cba
},
options
end
|
.find_children(account_id, with_balance = false, with_balance_and_cba = false, audit = 'NONE', options = {}) ⇒ Object
59
60
61
62
63
64
65
66
67
|
# File 'lib/killbill_client/models/account.rb', line 59
def find_children(account_id, with_balance = false, with_balance_and_cba = false, audit='NONE', options = {})
get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/children",
{
:audit => audit,
:accountWithBalance => with_balance,
:accountWithBalanceAndCBA => with_balance_and_cba
},
options
end
|
.find_in_batches(offset = 0, limit = 100, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
18
19
20
21
22
23
24
25
26
27
|
# File 'lib/killbill_client/models/account.rb', line 18
def find_in_batches(offset = 0, limit = 100, with_balance = false, with_balance_and_cba = false, options = {})
get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{Resource::KILLBILL_API_PAGINATION_PREFIX}",
{
:offset => offset,
:limit => limit,
:accountWithBalance => with_balance,
:accountWithBalanceAndCBA => with_balance_and_cba
},
options
end
|
.find_in_batches_by_search_key(search_key, offset = 0, limit = 100, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object
48
49
50
51
52
53
54
55
56
57
|
# File 'lib/killbill_client/models/account.rb', line 48
def find_in_batches_by_search_key(search_key, offset = 0, limit = 100, with_balance = false, with_balance_and_cba = false, options = {})
get "#{KILLBILL_API_ACCOUNTS_PREFIX}/search/#{search_key}",
{
:offset => offset,
:limit => limit,
:accountWithBalance => with_balance,
:accountWithBalanceAndCBA => with_balance_and_cba
},
options
end
|
Instance Method Details
#add_email(email, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
# File 'lib/killbill_client/models/account.rb', line 253
def add_email(email, user = nil, reason = nil, = nil, options = {})
self.class.post "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/emails",
{
:accountId => account_id,
:email => email
}.to_json,
{},
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
end
|
#all_custom_fields(object_type, audit = 'NONE', options = {}) ⇒ Object
306
307
308
309
310
311
312
313
314
|
# File 'lib/killbill_client/models/account.rb', line 306
def all_custom_fields(object_type, audit = 'NONE', options = {})
params = {}
params[:objectType] = object_type if object_type
params[:audit] = audit
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/allCustomFields",
params,
options,
CustomField
end
|
295
296
297
298
299
300
301
302
303
304
|
# File 'lib/killbill_client/models/account.rb', line 295
def all_tags(object_type, included_deleted, audit = 'NONE', options = {})
params = {}
params[:objectType] = object_type if object_type
params[:includedDeleted] = included_deleted if included_deleted
params[:audit] = audit
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/allTags",
params,
options,
Tag
end
|
#audit(options = {}) ⇒ Object
373
374
375
376
377
378
|
# File 'lib/killbill_client/models/account.rb', line 373
def audit(options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/auditLogs",
{},
options,
AuditLog
end
|
#auto_invoicing_off?(options = {}) ⇒ Boolean
193
194
195
|
# File 'lib/killbill_client/models/account.rb', line 193
def auto_invoicing_off?(options = {})
control_tag?(AUTO_INVOICING_OFF_ID, options)
end
|
#auto_pay_off?(options = {}) ⇒ Boolean
181
182
183
|
# File 'lib/killbill_client/models/account.rb', line 181
def auto_pay_off?(options = {})
control_tag?(AUTO_PAY_OFF_ID, options)
end
|
#blocking_states(blocking_state_types, blocking_state_svcs, audit = 'NONE', options = {}) ⇒ Object
316
317
318
319
320
321
322
323
324
325
326
|
# File 'lib/killbill_client/models/account.rb', line 316
def blocking_states(blocking_state_types, blocking_state_svcs, audit = 'NONE', options = {})
params = {}
params[:blockingStateTypes] = blocking_state_types if blocking_state_types
params[:blockingStateSvcs] = blocking_state_svcs if blocking_state_svcs
params[:audit] = audit
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/block",
params,
options,
BlockingStateAttributes
end
|
#bundles(options = {}) ⇒ Object
139
140
141
142
143
144
|
# File 'lib/killbill_client/models/account.rb', line 139
def bundles(options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/bundles",
{},
options,
Bundle
end
|
#cba_rebalancing(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
351
352
353
354
355
356
357
358
359
360
|
# File 'lib/killbill_client/models/account.rb', line 351
def cba_rebalancing(user = nil, reason = nil, = nil, options = {})
self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/cbaRebalancing",
{},
{},
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
end
|
#children(with_balance = false, with_balance_and_cba = false, audit = 'NONE', options = {}) ⇒ Object
177
178
179
|
# File 'lib/killbill_client/models/account.rb', line 177
def children(with_balance = false, with_balance_and_cba = false, audit='NONE', options = {})
Account::find_children(self.account_id, with_balance, with_balance_and_cba, audit, options)
end
|
#close(cancel_subscriptions, writeoff_unpaid_invoices, item_adjust_unpaid_invoices, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# File 'lib/killbill_client/models/account.rb', line 109
def close(cancel_subscriptions, writeoff_unpaid_invoices, item_adjust_unpaid_invoices, user = nil, reason = nil, = nil, options = {})
created_account = self.class.delete "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}",
{},
{
:cancelAllSubscriptions => cancel_subscriptions,
:writeOffUnpaidInvoices => writeoff_unpaid_invoices,
:itemAdjustUnpaidInvoices => item_adjust_unpaid_invoices
},
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
created_account.refresh(options)
end
|
#create(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
78
79
80
81
82
83
84
85
86
87
88
|
# File 'lib/killbill_client/models/account.rb', line 78
def create(user = nil, reason = nil, = nil, options = {})
created_account = self.class.post KILLBILL_API_ACCOUNTS_PREFIX,
to_json,
{},
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
created_account.refresh(options)
end
|
#email_audit_logs_with_history(account_email_id, options = {}) ⇒ Object
288
289
290
291
292
293
|
# File 'lib/killbill_client/models/account.rb', line 288
def email_audit_logs_with_history(account_email_id, options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/emails/#{account_email_id}/auditLogsWithHistory",
{},
options,
AuditLog
end
|
#emails(audit = 'NONE', options = {}) ⇒ Object
279
280
281
282
283
284
285
286
|
# File 'lib/killbill_client/models/account.rb', line 279
def emails(audit = 'NONE', options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/emails",
{
:audit => audit
},
options,
AccountEmailAttributes
end
|
#invoice_payments(audit = 'NONE', with_plugin_info = false, with_attempts = false, options = {}) ⇒ Object
362
363
364
365
366
367
368
369
370
371
|
# File 'lib/killbill_client/models/account.rb', line 362
def invoice_payments(audit='NONE', with_plugin_info = false, with_attempts = false, options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/invoicePayments",
{
:audit => audit,
:withPluginInfo => with_plugin_info,
:withAttempts => with_attempts
},
options,
InvoicePayment
end
|
#invoices(options = {}) ⇒ Object
146
147
148
149
150
151
152
|
# File 'lib/killbill_client/models/account.rb', line 146
def invoices(options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/invoices",
{
},
options,
Invoice
end
|
#manual_pay?(options = {}) ⇒ Boolean
229
230
231
|
# File 'lib/killbill_client/models/account.rb', line 229
def manual_pay?(options = {})
control_tag?(MANUAL_PAY_ID, options)
end
|
#migration_invoices(options = {}) ⇒ Object
154
155
156
157
158
159
160
161
|
# File 'lib/killbill_client/models/account.rb', line 154
def migration_invoices(options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/invoices",
{
:withMigrationInvoices => true
},
options,
Invoice
end
|
#overdue(options = {}) ⇒ Object
#overdue_enforcement_off?(options = {}) ⇒ Boolean
205
206
207
|
# File 'lib/killbill_client/models/account.rb', line 205
def overdue_enforcement_off?(options = {})
control_tag?(OVERDUE_ENFORCEMENT_OFF_ID, options)
end
|
#payments(options = {}) ⇒ Object
163
164
165
166
167
168
|
# File 'lib/killbill_client/models/account.rb', line 163
def payments(options = {})
self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/payments",
{},
options,
Payment
end
|
#remove_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
201
202
203
|
# File 'lib/killbill_client/models/account.rb', line 201
def remove_auto_invoicing_off(user = nil, reason = nil, = nil, options = {})
remove_tag_from_definition_id(AUTO_INVOICING_OFF_ID, user, reason, , options)
end
|
#remove_auto_pay_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
189
190
191
|
# File 'lib/killbill_client/models/account.rb', line 189
def remove_auto_pay_off(user = nil, reason = nil, = nil, options = {})
remove_tag_from_definition_id(AUTO_PAY_OFF_ID, user, reason, , options)
end
|
#remove_email(email, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
268
269
270
271
272
273
274
275
276
277
|
# File 'lib/killbill_client/models/account.rb', line 268
def remove_email(email, user = nil, reason = nil, = nil, options = {})
self.class.delete "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/emails/#{email}",
{},
{},
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
end
|
#remove_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
237
238
239
|
# File 'lib/killbill_client/models/account.rb', line 237
def remove_manual_pay(user = nil, reason = nil, = nil, options = {})
remove_tag_from_definition_id(MANUAL_PAY_ID, user, reason, , options)
end
|
#remove_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
213
214
215
|
# File 'lib/killbill_client/models/account.rb', line 213
def remove_overdue_enforcement_off(user = nil, reason = nil, = nil, options = {})
remove_tag_from_definition_id(OVERDUE_ENFORCEMENT_OFF_ID, user, reason, , options)
end
|
#remove_test(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
249
250
251
|
# File 'lib/killbill_client/models/account.rb', line 249
def remove_test(user = nil, reason = nil, = nil, options = {})
remove_tag_from_definition_id(TEST_ID, user, reason, , options)
end
|
#remove_written_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
225
226
227
|
# File 'lib/killbill_client/models/account.rb', line 225
def remove_written_off(user = nil, reason = nil, = nil, options = {})
remove_tag_from_definition_id(WRITTEN_OFF_ID, user, reason, , options)
end
|
#set_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
197
198
199
|
# File 'lib/killbill_client/models/account.rb', line 197
def set_auto_invoicing_off(user = nil, reason = nil, = nil, options = {})
add_tag_from_definition_id(AUTO_INVOICING_OFF_ID, user, reason, , options)
end
|
#set_auto_pay_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
185
186
187
|
# File 'lib/killbill_client/models/account.rb', line 185
def set_auto_pay_off(user = nil, reason = nil, = nil, options = {})
add_tag_from_definition_id(AUTO_PAY_OFF_ID, user, reason, , options)
end
|
#set_blocking_state(state_name, service, is_block_change, is_block_entitlement, is_block_billing, requested_date = nil, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
# File 'lib/killbill_client/models/account.rb', line 328
def set_blocking_state(state_name, service, is_block_change, is_block_entitlement, is_block_billing, requested_date = nil, user = nil, reason = nil, = nil, options = {})
params = {}
params[:requestedDate] = requested_date if requested_date
body = KillBillClient::Model::BlockingStateAttributes.new
body.state_name = state_name
body.service = service
body.is_block_change = is_block_change
body.is_block_entitlement = is_block_entitlement
body.is_block_billing = is_block_billing
self.class.post "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/block",
body.to_json,
params,
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
blocking_states(nil, nil, 'NONE', options)
end
|
#set_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
233
234
235
|
# File 'lib/killbill_client/models/account.rb', line 233
def set_manual_pay(user = nil, reason = nil, = nil, options = {})
add_tag_from_definition_id(MANUAL_PAY_ID, user, reason, , options)
end
|
#set_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
209
210
211
|
# File 'lib/killbill_client/models/account.rb', line 209
def set_overdue_enforcement_off(user = nil, reason = nil, = nil, options = {})
add_tag_from_definition_id(OVERDUE_ENFORCEMENT_OFF_ID, user, reason, , options)
end
|
#set_test(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
245
246
247
|
# File 'lib/killbill_client/models/account.rb', line 245
def set_test(user = nil, reason = nil, = nil, options = {})
add_tag_from_definition_id(TEST_ID, user, reason, , options)
end
|
#set_written_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
221
222
223
|
# File 'lib/killbill_client/models/account.rb', line 221
def set_written_off(user = nil, reason = nil, = nil, options = {})
add_tag_from_definition_id(WRITTEN_OFF_ID, user, reason, , options)
end
|
#test?(options = {}) ⇒ Boolean
241
242
243
|
# File 'lib/killbill_client/models/account.rb', line 241
def test?(options = {})
control_tag?(TEST_ID, options)
end
|
#transfer_child_credit(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
127
128
129
130
131
132
133
134
135
136
|
# File 'lib/killbill_client/models/account.rb', line 127
def transfer_child_credit(user = nil, reason = nil, = nil, options = {})
self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/transferCredit",
{},
{},
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
end
|
#update(treat_null_as_reset = false, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
# File 'lib/killbill_client/models/account.rb', line 90
def update(treat_null_as_reset = false, user = nil, reason = nil, = nil, options = {})
params = {}
params[:treatNullAsReset] = treat_null_as_reset
self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}",
to_json,
params,
{
:user => user,
:reason => reason,
:comment => ,
}.merge(options)
self.class.find_by_id(account_id, nil, nil, options)
end
|
#written_off?(options = {}) ⇒ Boolean
217
218
219
|
# File 'lib/killbill_client/models/account.rb', line 217
def written_off?(options = {})
control_tag?(WRITTEN_OFF_ID, options)
end
|