Class: KatelloApi::Resources::Subscription

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

Constant Summary

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

+ (Object) doc



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

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

Instance Method Details

- (Array) available_system(params = {}, headers = {})

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



89
90
91
# File 'lib/katello_api/resources/subscription.rb', line 89

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

- (Array) create(params = {}, headers = {})

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

  • activation_key_id (String)

    id of the activation key

  • system_id (String)

    uuid of the system

  • quantity (String)

    quantity of this subscriptions to add

  • subscriptions (String)

    array of subscriptions to add

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) delete_manifest(params = {}, headers = {})

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



77
78
79
# File 'lib/katello_api/resources/subscription.rb', line 77

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

- (Array) destroy(params = {}, headers = {})

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 id

  • activation_key_id (String)

    activation key id

  • system_id (String)

    uuid of the system

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) index(params = {}, headers = {})

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

  • activation_key_id (String)

    activation key id

  • organization_id (String)

    organization id

  • system_id (String)

    uuid of the system

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) refresh_manifest(params = {}, headers = {})

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) show(params = {}, headers = {})

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

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

- (Array) upload(params = {}, headers = {})

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

  • content (String)

    subscription manifest file

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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