Class: KoronaClient::SectorsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/sectors_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SectorsApi

Returns a new instance of SectorsApi.



19
20
21
 
# File 'lib/korona_client/api/sectors_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/korona_client/api/sectors_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_sector(korona_account_id, sector_id, opts = {}) ⇒ Sector

returns the single sector

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • sector_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/korona_client/api/sectors_api.rb', line 28

def get_sector(, sector_id, opts = {})
  data, _status_code, _headers = get_sector_with_http_info(, sector_id, opts)
  data
end

#get_sector_with_http_info(korona_account_id, sector_id, opts = {}) ⇒ Array<(Sector, Fixnum, Hash)>

returns the single sector

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • sector_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (Array<(Sector, Fixnum, Hash)>) —

    Sector data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/korona_client/api/sectors_api.rb', line 39

def get_sector_with_http_info(, sector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.get_sector ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling SectorsApi.get_sector"
  end
  # verify the required parameter 'sector_id' is set
  if @api_client.config.client_side_validation && sector_id.nil?
    fail ArgumentError, "Missing the required parameter 'sector_id' when calling SectorsApi.get_sector"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors/{sectorId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'sectorId' + '}', sector_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Sector')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SectorsApi#get_sector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sectors(korona_account_id, opts = {}) ⇒ ResultListSector

lists all sectors

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



93
94
95
96
 
# File 'lib/korona_client/api/sectors_api.rb', line 93

def get_sectors(, opts = {})
  data, _status_code, _headers = get_sectors_with_http_info(, opts)
  data
end

#get_sectors_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListSector, Fixnum, Hash)>

lists all sectors

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:

  • (Array<(ResultListSector, Fixnum, Hash)>) —

    ResultListSector data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/korona_client/api/sectors_api.rb', line 109

def get_sectors_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SectorsApi.get_sectors ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling SectorsApi.get_sectors"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/sectors'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListSector')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SectorsApi#get_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end