Class: KillBillClient::Model::Account

Inherits:
AccountAttributes show all
Includes:
CustomFieldHelper, TagHelper
Defined in:
lib/killbill_client/models/account.rb

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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CustomFieldHelper

included

Methods included from TagHelper

#add_tag, #add_tag_from_definition_id, #control_tag?, included, #remove_tag, #remove_tag_from_definition_id, #set_tags

Class Method Details

.find_by_external_key(external_key, with_balance = false, with_balance_and_cba = false, options = {}) ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/killbill_client/models/account.rb', line 36

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 



27
28
29
30
31
32
33
34
 
# File 'lib/killbill_client/models/account.rb', line 27

def find_by_id(, with_balance = false, with_balance_and_cba = false, options = {})
  get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}",
      {
          :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 



57
58
59
60
61
62
63
64
65
 
# File 'lib/killbill_client/models/account.rb', line 57

def find_children(, with_balance = false, with_balance_and_cba = false, audit='NONE', options = {})
  get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/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 



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/killbill_client/models/account.rb', line 16

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 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/killbill_client/models/account.rb', line 46

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 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/killbill_client/models/account.rb', line 243

def add_email(email, user = nil, reason = nil, comment = nil, options = {})
  self.class.post "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/emails",
                  {
                      # TODO Required ATM
                      :accountId => ,
                      :email     => email
                  }.to_json,
                  {},
                  {
                      :user    => user,
                      :reason  => reason,
                      :comment => comment,
                  }.merge(options)
end

#all_custom_fields(object_type, audit = 'NONE', options = {}) ⇒ Object 



308
309
310
311
312
313
314
315
316
 
# File 'lib/killbill_client/models/account.rb', line 308

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}/#{}/allCustomFields",
                 params,
                 options,
                 CustomField
end

#all_tags(object_type, included_deleted, audit = 'NONE', options = {}) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/killbill_client/models/account.rb', line 296

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}/#{}/allTags",
                 params,
                 options,
                 Tag
end

#auto_invoicing_off?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/killbill_client/models/account.rb', line 183

def auto_invoicing_off?(options = {})
  control_tag?(AUTO_INVOICING_OFF_ID, options)
end

#auto_pay_off?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/killbill_client/models/account.rb', line 171

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 



318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/killbill_client/models/account.rb', line 318

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}/#{}/block",
                 params,
                 options,
                 BlockingStateAttributes

end

#bundles(options = {}) ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/killbill_client/models/account.rb', line 127

def bundles(options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/bundles",
                 {},
                 options,
                 Bundle
end

#cba_rebalancing(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/killbill_client/models/account.rb', line 353

def cba_rebalancing(user = nil, reason = nil, comment = nil, options = {})
  self.class.post "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/cbaRebalancing",
                  {},
                  {},
                  {
                      :user    => user,
                      :reason  => reason,
                      :comment => comment,
                  }.merge(options)
end

#children(with_balance = false, with_balance_and_cba = false, audit = 'NONE', options = {}) ⇒ Object 



167
168
169
 
# File 'lib/killbill_client/models/account.rb', line 167

def children(with_balance = false, with_balance_and_cba = false, audit='NONE', options = {})
  Account::find_children(self., 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 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/killbill_client/models/account.rb', line 97

def close(cancel_subscriptions, writeoff_unpaid_invoices,  item_adjust_unpaid_invoices, user = nil, reason = nil, comment = nil, options = {})
   = self.class.delete "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}",
                                    {},
                                    {
                                        :cancelAllSubscriptions => cancel_subscriptions,
                                        :writeOffUnpaidInvoices => writeoff_unpaid_invoices,
                                        :itemAdjustUnpaidInvoices => item_adjust_unpaid_invoices
                                    },
                                    {
                                        :user    => user,
                                        :reason  => reason,
                                        :comment => comment,
                                    }.merge(options)
  .refresh(options)
end

#create(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/killbill_client/models/account.rb', line 68

def create(user = nil, reason = nil, comment = nil, options = {})
   = self.class.post KILLBILL_API_ACCOUNTS_PREFIX,
                                    to_json,
                                    {},
                                    {
                                        :user    => user,
                                        :reason  => reason,
                                        :comment => comment,
                                    }.merge(options)
  .refresh(options)
end

#email_notifications(options = {}) ⇒ Object 



278
279
280
281
282
283
 
# File 'lib/killbill_client/models/account.rb', line 278

def email_notifications(options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/emailNotifications",
                 {},
                 options,
                 InvoiceEmailAttributes
end

#emails(audit = 'NONE', options = {}) ⇒ Object 



269
270
271
272
273
274
275
276
 
# File 'lib/killbill_client/models/account.rb', line 269

def emails(audit = 'NONE', options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/emails",
                 {
                     :audit => audit
                 },
                 options,
                 AccountEmailAttributes
end

#invoice_payments(audit = 'NONE', with_plugin_info = false, with_attempts = false, options = {}) ⇒ Object 



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/killbill_client/models/account.rb', line 364

def invoice_payments(audit='NONE', with_plugin_info = false, with_attempts = false, options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/invoicePayments",
                 {
                     :audit                    => audit,
                     :withPluginInfo       => with_plugin_info,
                     :withAttempts => with_attempts
                 },
                 options,
                 InvoicePayment
end

#invoices(with_items = false, options = {}) ⇒ Object 



134
135
136
137
138
139
140
141
 
# File 'lib/killbill_client/models/account.rb', line 134

def invoices(with_items=false, options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/invoices",
                 {
                     :withItems => with_items
                 },
                 options,
                 Invoice
end

#manual_pay?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
 
# File 'lib/killbill_client/models/account.rb', line 219

def manual_pay?(options = {})
  control_tag?(MANUAL_PAY_ID, options)
end

#migration_invoices(with_items = false, options = {}) ⇒ Object 



143
144
145
146
147
148
149
150
151
 
# File 'lib/killbill_client/models/account.rb', line 143

def migration_invoices(with_items=false, options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/invoices",
                 {
                     :withMigrationInvoices => true,
                     :withItems => with_items
                 },
                 options,
                 Invoice
end

#overdue(options = {}) ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/killbill_client/models/account.rb', line 160

def overdue(options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/overdue",
                 {},
                 options,
                 OverdueStateAttributes
end

#overdue_enforcement_off?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/killbill_client/models/account.rb', line 195

def overdue_enforcement_off?(options = {})
  control_tag?(OVERDUE_ENFORCEMENT_OFF_ID, options)
end

#payments(options = {}) ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/killbill_client/models/account.rb', line 153

def payments(options = {})
  self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/payments",
                 {},
                 options,
                 Payment
end

#remove_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



191
192
193
 
# File 'lib/killbill_client/models/account.rb', line 191

def remove_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {})
  remove_tag_from_definition_id(AUTO_INVOICING_OFF_ID, user, reason, comment, options)
end

#remove_auto_pay_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



179
180
181
 
# File 'lib/killbill_client/models/account.rb', line 179

def remove_auto_pay_off(user = nil, reason = nil, comment = nil, options = {})
  remove_tag_from_definition_id(AUTO_PAY_OFF_ID, user, reason, comment, options)
end

#remove_email(email, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/killbill_client/models/account.rb', line 258

def remove_email(email, user = nil, reason = nil, comment = nil, options = {})
  self.class.delete "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/emails/#{email}",
                    {},
                    {},
                    {
                        :user    => user,
                        :reason  => reason,
                        :comment => comment,
                    }.merge(options)
end

#remove_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



227
228
229
 
# File 'lib/killbill_client/models/account.rb', line 227

def remove_manual_pay(user = nil, reason = nil, comment = nil, options = {})
  remove_tag_from_definition_id(MANUAL_PAY_ID, user, reason, comment, options)
end

#remove_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



203
204
205
 
# File 'lib/killbill_client/models/account.rb', line 203

def remove_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {})
  remove_tag_from_definition_id(OVERDUE_ENFORCEMENT_OFF_ID, user, reason, comment, options)
end

#remove_test(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



239
240
241
 
# File 'lib/killbill_client/models/account.rb', line 239

def remove_test(user = nil, reason = nil, comment = nil, options = {})
  remove_tag_from_definition_id(TEST_ID, user, reason, comment, options)
end

#remove_written_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



215
216
217
 
# File 'lib/killbill_client/models/account.rb', line 215

def remove_written_off(user = nil, reason = nil, comment = nil, options = {})
  remove_tag_from_definition_id(WRITTEN_OFF_ID, user, reason, comment, options)
end

#set_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



187
188
189
 
# File 'lib/killbill_client/models/account.rb', line 187

def set_auto_invoicing_off(user = nil, reason = nil, comment = nil, options = {})
  add_tag_from_definition_id(AUTO_INVOICING_OFF_ID, user, reason, comment, options)
end

#set_auto_pay_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



175
176
177
 
# File 'lib/killbill_client/models/account.rb', line 175

def set_auto_pay_off(user = nil, reason = nil, comment = nil, options = {})
  add_tag_from_definition_id(AUTO_PAY_OFF_ID, user, reason, comment, options)
end

#set_blocking_state(state_name, service, block_change, block_entitlement, block_billing, requested_date = nil, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/killbill_client/models/account.rb', line 330

def set_blocking_state(state_name, service, block_change, block_entitlement, block_billing, requested_date = nil, user = nil, reason = nil, comment = nil, options = {})

  params = {}
  params[:requestedDate] = requested_date if requested_date

  body = KillBillClient::Model::BlockingStateAttributes.new
  body.state_name = state_name
  body.service = service
  body.block_change = block_change
  body.block_entitlement = block_entitlement
  body.block_billing = block_billing

  self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/block",
                 body.to_json,
                 params,
                 {
                     :user => user,
                     :reason => reason,
                     :comment => comment,
                 }.merge(options)
  blocking_states(nil, nil, 'NONE', options)
end

#set_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



223
224
225
 
# File 'lib/killbill_client/models/account.rb', line 223

def set_manual_pay(user = nil, reason = nil, comment = nil, options = {})
  add_tag_from_definition_id(MANUAL_PAY_ID, user, reason, comment, options)
end

#set_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



199
200
201
 
# File 'lib/killbill_client/models/account.rb', line 199

def set_overdue_enforcement_off(user = nil, reason = nil, comment = nil, options = {})
  add_tag_from_definition_id(OVERDUE_ENFORCEMENT_OFF_ID, user, reason, comment, options)
end

#set_test(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



235
236
237
 
# File 'lib/killbill_client/models/account.rb', line 235

def set_test(user = nil, reason = nil, comment = nil, options = {})
  add_tag_from_definition_id(TEST_ID, user, reason, comment, options)
end

#set_written_off(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



211
212
213
 
# File 'lib/killbill_client/models/account.rb', line 211

def set_written_off(user = nil, reason = nil, comment = nil, options = {})
  add_tag_from_definition_id(WRITTEN_OFF_ID, user, reason, comment, options)
end

#test?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/killbill_client/models/account.rb', line 231

def test?(options = {})
  control_tag?(TEST_ID, options)
end

#transfer_child_credit(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/killbill_client/models/account.rb', line 115

def transfer_child_credit(user = nil, reason = nil, comment = nil, options = {})
  self.class.post "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/transferCredit",
                                   {},
                                   {},
                                   {
                                       :user    => user,
                                       :reason  => reason,
                                       :comment => comment,
                                   }.merge(options)
end

#update(treat_null_as_reset = false, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/killbill_client/models/account.rb', line 80

def update(treat_null_as_reset = false, user = nil, reason = nil, comment = nil, options = {})

  params = {}
  params[:treatNullAsReset] = treat_null_as_reset

   = self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}",
                                   to_json,
                                   params,
                                   {
                                       :user    => user,
                                       :reason  => reason,
                                       :comment => comment,
                                   }.merge(options)
  .refresh(options)
end

#update_email_notifications(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/killbill_client/models/account.rb', line 285

def update_email_notifications(user = nil, reason = nil, comment = nil, options = {})
  self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{}/emailNotifications",
                 to_json,
                 {},
                 {
                     :user => user,
                     :reason => reason,
                     :comment => comment,
                 }.merge(options)
end

#written_off?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/killbill_client/models/account.rb', line 207

def written_off?(options = {})
  control_tag?(WRITTEN_OFF_ID, options)
end