Class: KillBillClient::Model::Invoice

Inherits:
InvoiceAttributes show all
Defined in:
lib/killbill_client/models/invoice.rb

Constant Summary collapse

KILLBILL_API_INVOICES_PREFIX = 
"#{KILLBILL_API_PREFIX}/invoices"
KILLBILL_API_DRY_RUN_INVOICES_PREFIX = 
"#{KILLBILL_API_INVOICES_PREFIX}/dryRun"

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 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, #to_hash, #to_json

Constructor Details

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

Class Method Details

.as_html(invoice_id, options = {}) ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/killbill_client/models/invoice.rb', line 41

def as_html(invoice_id, options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/html",
      {},
      {
          :accept => 'text/html'
      }.merge(options)
end

.cancel_subscription_dry_run(account_id, bundle_id, subscription_id, target_date, effective_date, billing_policy, options = {}) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/killbill_client/models/invoice.rb', line 158

def cancel_subscription_dry_run(, bundle_id, subscription_id, target_date,
    effective_date, billing_policy,  options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_action = 'STOP_BILLING'
  dry_run.effective_date = effective_date
  dry_run.billing_policy = billing_policy
  dry_run.bundle_id = bundle_id
  dry_run.subscription_id = subscription_id


  begin
    res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
               dry_run.to_json,
               query_map,
               {
                   :user    => 'cancel_subscription_dry_run',
                   :reason  => '',
                   :comment => '',
               }.merge(options),
               Invoice

    res.refresh(options)

  rescue KillBillClient::API::NotFound => e
    nil
  end
end

.change_plan_dry_run(account_id, bundle_id, subscription_id, target_date, product_name, product_category, billing_period, price_list_name, effective_date, billing_policy, options = {}) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/killbill_client/models/invoice.rb', line 124

def change_plan_dry_run(, bundle_id, subscription_id, target_date, product_name, product_category, billing_period, price_list_name,
    effective_date, billing_policy, options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_action = 'CHANGE'
  dry_run.product_name = product_name
  dry_run.product_category = product_category
  dry_run.billing_period = billing_period
  dry_run.price_list_name = price_list_name
  dry_run.effective_date = effective_date
  dry_run.billing_policy = billing_policy
  dry_run.bundle_id = bundle_id
  dry_run.subscription_id = subscription_id

  begin
    res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
               dry_run.to_json,
               query_map,
               {
                   :user    => 'change_plan_dry_run',
                   :reason  => '',
                   :comment => '',
               }.merge(options),
               Invoice

    res.refresh(options)
  rescue KillBillClient::API::NotFound => e
    nil
  end
end

.create_subscription_dry_run(account_id, bundle_id, target_date, product_name, product_category, billing_period, price_list_name, options = {}) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/killbill_client/models/invoice.rb', line 94

def create_subscription_dry_run(, bundle_id, target_date, product_name, product_category,
    billing_period, price_list_name,  options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_action = 'START_BILLING'
  dry_run.product_name = product_name
  dry_run.product_category = product_category
  dry_run.billing_period = billing_period
  dry_run.price_list_name = price_list_name
  dry_run.bundle_id = bundle_id

  begin
    res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
               dry_run.to_json,
               query_map,
               {
                   :user    => 'create_subscription_dry_run',
                   :reason  => '',
                   :comment => '',
               }.merge(options),
               Invoice

    res.refresh(options)
  rescue KillBillClient::API::NotFound => e
    nil
  end
end

.find_by_id_or_number(id_or_number, with_items = true, audit = "NONE", options = {}) ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/killbill_client/models/invoice.rb', line 14

def find_by_id_or_number(id_or_number, with_items = true, audit = "NONE", options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/#{id_or_number}",
      {
          :withItems => with_items,
          :audit     => audit
      },
      options
end

.find_in_batches(offset = 0, limit = 100, options = {}) ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/killbill_client/models/invoice.rb', line 23

def find_in_batches(offset = 0, limit = 100, options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/#{Resource::KILLBILL_API_PAGINATION_PREFIX}",
      {
          :offset => offset,
          :limit  => limit
      },
      options
end

.find_in_batches_by_search_key(search_key, offset = 0, limit = 100, options = {}) ⇒ Object 



32
33
34
35
36
37
38
39
 
# File 'lib/killbill_client/models/invoice.rb', line 32

def find_in_batches_by_search_key(search_key, offset = 0, limit = 100, options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/search/#{search_key}",
      {
          :offset => offset,
          :limit  => limit
      },
      options
end

.get_catalog_translation(locale, options = {}) ⇒ Object 



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

def get_catalog_translation(locale, options = {})
  if options[:api_key].nil? || options[:api_secret].nil?
    raise ArgumentError, "Retrieving a catalog translation is only supported in multi-tenant mode"
  end

  get "#{KILLBILL_API_INVOICES_PREFIX}/catalogTranslation/#{locale}",
      {},
      {
          :head => {'Accept' => 'text/plain'},
      }.merge(options)
end

.get_invoice_template(is_manual_pay, options = {}) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/killbill_client/models/invoice.rb', line 190

def get_invoice_template(is_manual_pay, options = {})
  if options[:api_key].nil? || options[:api_secret].nil?
    raise ArgumentError, "Retrieving an invoice template supported in multi-tenant mode"
  end

  get "#{KILLBILL_API_INVOICES_PREFIX}/#{is_manual_pay ? "manualPayTemplate" : "template"}",
      {},
      {
          :head => {'Accept' => 'text/html'},
      }.merge(options)
end

.get_invoice_translation(locale, options = {}) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/killbill_client/models/invoice.rb', line 223

def get_invoice_translation(locale, options = {})
  if options[:api_key].nil? || options[:api_secret].nil?
    raise ArgumentError, "Retrieving an invoice template supported in multi-tenant mode"
  end

  get "#{KILLBILL_API_INVOICES_PREFIX}/translation/#{locale}",
      {},
      {
          :head => {'Accept' => 'text/plain'},
      }.merge(options)
end

.trigger_invoice(account_id, target_date, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/killbill_client/models/invoice.rb', line 49

def trigger_invoice(, target_date, user = nil, reason = nil, comment = nil, options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  begin
    res = post "#{KILLBILL_API_INVOICES_PREFIX}/",
               {},
               query_map,
               {
                   :user    => user,
                   :reason  => reason,
                   :comment => comment,
               }.merge(options),
               Invoice

    res.refresh(options)

  rescue KillBillClient::API::BadRequest => e
    # No invoice to generate : TODO parse json to verify this is indeed the case
  end
end

.trigger_invoice_dry_run(account_id, target_date, options = {}) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/killbill_client/models/invoice.rb', line 71

def trigger_invoice_dry_run(, target_date, options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  begin
    res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
               {},
               query_map,
               {
                   :user    => 'trigger_invoice_dry_run',
                   :reason  => '',
                   :comment => '',
               }.merge(options),
               Invoice

    res.refresh(options)

  rescue KillBillClient::API::NotFound => e
    nil
  end
end

.upload_catalog_translation(catalog_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/killbill_client/models/invoice.rb', line 269

def upload_catalog_translation(catalog_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {})
  if options[:api_key].nil? || options[:api_secret].nil?
    raise ArgumentError, "Uploading a catalog translation is only supported in multi-tenant mode"
  end

  params                  = {}
  params[:deleteIfExists] = delete_if_exists if delete_if_exists

  post "#{KILLBILL_API_INVOICES_PREFIX}/catalogTranslation/#{locale}",
       catalog_translation,
       params,
       {
           :head => {'Accept' => 'text/plain'},
           :content_type => 'text/plain',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_catalog_translation(locale, options)
end

.upload_invoice_template(invoice_template, is_manual_pay, delete_if_exists, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/killbill_client/models/invoice.rb', line 202

def upload_invoice_template(invoice_template, is_manual_pay, delete_if_exists, user = nil, reason = nil, comment = nil, options = {})
  if options[:api_key].nil? || options[:api_secret].nil?
    raise ArgumentError, "Uploading a invoice template is only supported in multi-tenant mode"
  end

  params                  = {}
  params[:deleteIfExists] = delete_if_exists if delete_if_exists

  post "#{KILLBILL_API_INVOICES_PREFIX}/#{is_manual_pay ? "manualPayTemplate" : "template"}",
       invoice_template,
       params,
       {
           :head => {'Accept' => 'text/html'},
           :content_type => 'text/html',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_invoice_template(is_manual_pay, options)
end

.upload_invoice_translation(invoice_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/killbill_client/models/invoice.rb', line 235

def upload_invoice_translation(invoice_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {})
  if options[:api_key].nil? || options[:api_secret].nil?
    raise ArgumentError, "Uploading a invoice template is only supported in multi-tenant mode"
  end

  params                  = {}
  params[:deleteIfExists] = delete_if_exists if delete_if_exists

  post "#{KILLBILL_API_INVOICES_PREFIX}/translation/#{locale}",
       invoice_translation,
       params,
       {
           :head => {'Accept' => 'text/plain'},
           :content_type => 'text/plain',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_invoice_translation(locale, options)
end

Instance Method Details

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



294
295
296
297
298
299
300
301
302
 
# File 'lib/killbill_client/models/invoice.rb', line 294

def payments(with_plugin_info = false, audit = 'NONE', options = {})
  self.class.get "#{KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/payments",
                 {
                     :withPluginInfo => with_plugin_info,
                     :audit          => audit
                 },
                 options,
                 InvoicePayment
end