Class: KillBillClient::Model::Tenant

Inherits:
TenantAttributes show all
Defined in:
lib/killbill_client/models/tenant.rb

Constant Summary collapse

KILLBILL_API_TENANTS_PREFIX = 
"#{KILLBILL_API_PREFIX}/tenants"

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

Constructor Details

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

Class Method Details

.delete_tenant_plugin_config(plugin_name, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



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

def delete_tenant_plugin_config(plugin_name, user = nil, reason = nil, comment = nil, options = {})

  require_multi_tenant_options!(options, "Uploading a plugin config is only supported in multi-tenant mode")

  uri =  KILLBILL_API_TENANTS_PREFIX + "/uploadPluginConfig/" + plugin_name
  delete uri,
       {},
       {
       },
       {
           :content_type => 'text/plain',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)

end

.find_by_api_key(api_key, options = {}) ⇒ Object 



15
16
17
18
19
 
# File 'lib/killbill_client/models/tenant.rb', line 15

def find_by_api_key(api_key, options = {})
  get "#{KILLBILL_API_TENANTS_PREFIX}/?apiKey=#{api_key}",
      {},
      options
end

.find_by_id(tenant_id, options = {}) ⇒ Object 



9
10
11
12
13
 
# File 'lib/killbill_client/models/tenant.rb', line 9

def find_by_id(tenant_id, options = {})
  get "#{KILLBILL_API_TENANTS_PREFIX}/#{tenant_id}",
      {},
      options
end

.get_tenant_plugin_config(plugin_name, options = {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/killbill_client/models/tenant.rb', line 21

def get_tenant_plugin_config(plugin_name, options = {})

  require_multi_tenant_options!(options, "Retrieving a plugin config is only supported in multi-tenant mode")

  uri =  KILLBILL_API_TENANTS_PREFIX + "/uploadPluginConfig/" + plugin_name
  get uri,
      {},
      {
      }.merge(options),
      KillBillClient::Model::TenantKeyAttributes
end

.upload_tenant_plugin_config(plugin_name, plugin_config, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/killbill_client/models/tenant.rb', line 33

def upload_tenant_plugin_config(plugin_name, plugin_config, user = nil, reason = nil, comment = nil, options = {})

  require_multi_tenant_options!(options, "Uploading a plugin config is only supported in multi-tenant mode")

  uri =  KILLBILL_API_TENANTS_PREFIX + "/uploadPluginConfig/" + plugin_name
  post uri,
       plugin_config,
       {
       },
       {
           :content_type => 'text/plain',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_tenant_plugin_config(plugin_name, options)
end

Instance Method Details

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



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

def create(user = nil, reason = nil, comment = nil, options = {})
  created_tenant = self.class.post KILLBILL_API_TENANTS_PREFIX,
                                   to_json,
                                   {},
                                   {
                                       :user => user,
                                       :reason => reason,
                                       :comment => comment,
                                   }.merge(options)
  #
  # Specify api_key and api_secret before making the call to retrieve the tenant object
  # otherwise that would fail with a 401
  #
  options[:api_key] = @api_key
  options[:api_secret] = @api_secret
  created_tenant.refresh(options)
end