Class: KillBillClient::Model::Payment

Inherits:
PaymentAttributes show all
Includes:
CustomFieldHelper
Defined in:
lib/killbill_client/models/payment.rb

Constant Summary collapse

KILLBILL_API_PAYMENTS_PREFIX =
"#{KILLBILL_API_PREFIX}/payments"

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

Methods included from CustomFieldHelper

included

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_plugin_info = false, with_attempts = false, options = {}) ⇒ Object



25
26
27
28
29
30
31
32
33
# File 'lib/killbill_client/models/payment.rb', line 25

def find_by_external_key(external_key, with_plugin_info = false, with_attempts = false, options = {})
  get "#{KILLBILL_API_PAYMENTS_PREFIX}",
      {
          :externalKey => external_key,
          :withAttempts => with_attempts,
          :withPluginInfo => with_plugin_info
      },
      options
end

.find_by_id(payment_id, with_plugin_info = false, with_attempts = false, options = {}) ⇒ Object



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

def find_by_id(payment_id, with_plugin_info = false, with_attempts = false, options = {})
  get "#{KILLBILL_API_PAYMENTS_PREFIX}/#{payment_id}",
      {
          :withAttempts => with_attempts,
          :withPluginInfo => with_plugin_info
      },
      options
end

.find_by_transaction_id(transaction_id, with_plugin_info = false, with_attempts = false, options = {}) ⇒ Object



35
36
37
38
39
40
41
42
# File 'lib/killbill_client/models/payment.rb', line 35

def find_by_transaction_id(transaction_id, with_plugin_info = false, with_attempts = false, options = {})
  get "#{Transaction::KILLBILL_API_TRANSACTIONS_PREFIX}/#{transaction_id}",
      {
          :withAttempts => with_attempts,
          :withPluginInfo => with_plugin_info
      },
      options
end

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



44
45
46
47
48
49
50
51
# File 'lib/killbill_client/models/payment.rb', line 44

def find_in_batches(offset = 0, limit = 100, options = {})
  get "#{KILLBILL_API_PAYMENTS_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



53
54
55
56
57
58
59
60
# File 'lib/killbill_client/models/payment.rb', line 53

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