Class: KillBillClient::Model::Payment

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

Constant Summary collapse

KILLBILL_API_PAYMENTS_PREFIX = 
"#{KILLBILL_API_PREFIX}/payments"

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

Methods included from AuditLogWithHistoryHelper

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

.attempt_audit_logs_with_history(payment_attempt_id, options = {}) ⇒ Object 



66
67
68
69
70
71
 
# File 'lib/killbill_client/models/payment.rb', line 66

def attempt_audit_logs_with_history(payment_attempt_id, options = {})
  get "#{KILLBILL_API_PAYMENTS_PREFIX}/attempts/#{payment_attempt_id}/auditLogsWithHistory",
                 {},
                 options,
                 AuditLog
end

.find_by_external_key(external_key, with_plugin_info = false, with_attempts = false, options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/killbill_client/models/payment.rb', line 29

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 



20
21
22
23
24
25
26
27
 
# File 'lib/killbill_client/models/payment.rb', line 20

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 



39
40
41
42
43
44
45
46
 
# File 'lib/killbill_client/models/payment.rb', line 39

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 



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

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 



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

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