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

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

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

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

Constructor Details

This class inherits a constructor from KillBillClient::Model::Resource

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_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 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/killbill_client/models/account.rb', line 201

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_tags(object_type, included_deleted, audit = 'NONE', options = {}) ⇒ Object 



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

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) 


141
142
143
 
# File 'lib/killbill_client/models/account.rb', line 141

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

#auto_pay_off?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


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

def auto_pay_off?(options = {})
  control_tag?(AUTO_PAY_OFF_ID, options)
end

#bundles(options = {}) ⇒ Object 



99
100
101
102
103
104
 
# File 'lib/killbill_client/models/account.rb', line 99

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

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



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

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

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



227
228
229
230
231
232
233
234
 
# File 'lib/killbill_client/models/account.rb', line 227

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

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



106
107
108
109
110
111
112
113
 
# File 'lib/killbill_client/models/account.rb', line 106

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) 


177
178
179
 
# File 'lib/killbill_client/models/account.rb', line 177

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

#overdue(options = {}) ⇒ Object 



122
123
124
125
126
127
 
# File 'lib/killbill_client/models/account.rb', line 122

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

#overdue_enforcement_off?(options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#payments(options = {}) ⇒ Object 



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

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 



149
150
151
 
# File 'lib/killbill_client/models/account.rb', line 149

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 



137
138
139
 
# File 'lib/killbill_client/models/account.rb', line 137

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 



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/killbill_client/models/account.rb', line 216

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 



185
186
187
 
# File 'lib/killbill_client/models/account.rb', line 185

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 



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

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 



197
198
199
 
# File 'lib/killbill_client/models/account.rb', line 197

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 



173
174
175
 
# File 'lib/killbill_client/models/account.rb', line 173

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 



145
146
147
 
# File 'lib/killbill_client/models/account.rb', line 145

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 



133
134
135
 
# File 'lib/killbill_client/models/account.rb', line 133

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_manual_pay(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



181
182
183
 
# File 'lib/killbill_client/models/account.rb', line 181

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 



157
158
159
 
# File 'lib/killbill_client/models/account.rb', line 157

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 



193
194
195
 
# File 'lib/killbill_client/models/account.rb', line 193

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 



169
170
171
 
# File 'lib/killbill_client/models/account.rb', line 169

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) 


189
190
191
 
# File 'lib/killbill_client/models/account.rb', line 189

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

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



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/killbill_client/models/account.rb', line 87

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 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/killbill_client/models/account.rb', line 70

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 



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/killbill_client/models/account.rb', line 236

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) 


165
166
167
 
# File 'lib/killbill_client/models/account.rb', line 165

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