Class: KatelloApi::Resources::Subscription

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/subscription.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from KatelloApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/katello_api/resources/subscription.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["subscriptions"]
end

Instance Method Details

#available(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • system_id (String) —

    uuid of the system

  • match_installed (String) —

    return subscriptions that match installed

  • match_system (String) —

    return subscriptions that match system

  • no_overlap (String) —

    return subscriptions that don’t overlap

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



37
38
39
 
# File 'lib/katello_api/resources/subscription.rb', line 37

def available(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#create(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • system_id (String) —

    uuid of the system

  • subscription (Hash) —

    allowed keys are:

    • pool [String] subscription pool uuid

    • quantity [String] number of subscription to use

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



50
51
52
 
# File 'lib/katello_api/resources/subscription.rb', line 50

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    entitlement id

  • system_id (String) —

    uuid of the system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



60
61
62
 
# File 'lib/katello_api/resources/subscription.rb', line 60

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy_all(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • system_id (String) —

    uuid of the system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



69
70
71
 
# File 'lib/katello_api/resources/subscription.rb', line 69

def destroy_all(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • organization_id (String) —

    organization id

  • system_id (String) —

    uuid of the system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



14
15
16
 
# File 'lib/katello_api/resources/subscription.rb', line 14

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    subscription identifier

  • organization_id (String) —

    organization identifier

  • system_id (String) —

    system uuid

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



25
26
27
 
# File 'lib/katello_api/resources/subscription.rb', line 25

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#upload(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • organization_id (String) —

    organization id

  • system_id (String) —

    system uuid

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



79
80
81
 
# File 'lib/katello_api/resources/subscription.rb', line 79

def upload(params = {}, headers = {})
  perform_call(__method__, params, headers)
end