Class: SwaggerAemClient::ConsoleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_aem/api/console_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConsoleApi

Returns a new instance of ConsoleApi.



19
20
21
 
# File 'lib/swagger_aem/api/console_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/swagger_aem/api/console_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_aem_product_info(opts = {}) ⇒ Array<String>

Parameters:

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

    the optional parameters

Returns:

  • (Array<String>) 


24
25
26
27
 
# File 'lib/swagger_aem/api/console_api.rb', line 24

def get_aem_product_info(opts = {})
  data, _status_code, _headers = get_aem_product_info_with_http_info(opts)
  data
end

#get_aem_product_info_with_http_info(opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

Returns Array<String> data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<String>, Integer, Hash)>) —

    Array<String> data, response status code and response headers



31
32
33
34
35
36
37
38
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
 
# File 'lib/swagger_aem/api/console_api.rb', line 31

def get_aem_product_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConsoleApi.get_aem_product_info ...'
  end
  # resource path
  local_var_path = '/system/console/status-productinfo.json'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<String>' 

  # auth_names
  auth_names = opts[:auth_names] || ['aemAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConsoleApi#get_aem_product_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bundle_info(name, opts = {}) ⇒ BundleInfo

Parameters:

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/swagger_aem/api/console_api.rb', line 77

def get_bundle_info(name, opts = {})
  data, _status_code, _headers = get_bundle_info_with_http_info(name, opts)
  data
end

#get_bundle_info_with_http_info(name, opts = {}) ⇒ Array<(BundleInfo, Integer, Hash)>

Returns BundleInfo data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(BundleInfo, Integer, Hash)>) —

    BundleInfo data, response status code and response headers



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/swagger_aem/api/console_api.rb', line 85

def get_bundle_info_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConsoleApi.get_bundle_info ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ConsoleApi.get_bundle_info"
  end
  # resource path
  local_var_path = '/system/console/bundles/{name}.json'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BundleInfo' 

  # auth_names
  auth_names = opts[:auth_names] || ['aemAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConsoleApi#get_bundle_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_config_mgr(opts = {}) ⇒ String

Parameters:

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

    the optional parameters

Returns:

  • (String) 


134
135
136
137
 
# File 'lib/swagger_aem/api/console_api.rb', line 134

def get_config_mgr(opts = {})
  data, _status_code, _headers = get_config_mgr_with_http_info(opts)
  data
end

#get_config_mgr_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/swagger_aem/api/console_api.rb', line 141

def get_config_mgr_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConsoleApi.get_config_mgr ...'
  end
  # resource path
  local_var_path = '/system/console/configMgr'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['aemAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConsoleApi#get_config_mgr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_bundle(name, action, opts = {}) ⇒ nil

Parameters:

  • name (String)
  • action (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


188
189
190
191
 
# File 'lib/swagger_aem/api/console_api.rb', line 188

def post_bundle(name, action, opts = {})
  post_bundle_with_http_info(name, action, opts)
  nil
end

#post_bundle_with_http_info(name, action, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • name (String)
  • action (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/swagger_aem/api/console_api.rb', line 197

def post_bundle_with_http_info(name, action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConsoleApi.post_bundle ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ConsoleApi.post_bundle"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling ConsoleApi.post_bundle"
  end
  # resource path
  local_var_path = '/system/console/bundles/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = action

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['aemAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConsoleApi#post_bundle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_jmx_repository(action, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


250
251
252
253
 
# File 'lib/swagger_aem/api/console_api.rb', line 250

def post_jmx_repository(action, opts = {})
  post_jmx_repository_with_http_info(action, opts)
  nil
end

#post_jmx_repository_with_http_info(action, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/swagger_aem/api/console_api.rb', line 258

def post_jmx_repository_with_http_info(action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConsoleApi.post_jmx_repository ...'
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling ConsoleApi.post_jmx_repository"
  end
  # resource path
  local_var_path = '/system/console/jmx/com.adobe.granite:type=Repository/op/{action}'.sub('{' + 'action' + '}', CGI.escape(action.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['aemAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConsoleApi#post_jmx_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_saml_configuration(opts = {}) ⇒ SamlConfigurationInfo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :post (Boolean)
  • :apply (Boolean)
  • :delete (Boolean)
  • :action (String)
  • :location (String)
  • :path (Array<String>)
  • :service_ranking (Integer)
  • :idp_url (String)
  • :idp_cert_alias (String)
  • :idp_http_redirect (Boolean)
  • :service_provider_entity_id (String)
  • :assertion_consumer_service_url (String)
  • :sp_private_key_alias (String)
  • :key_store_password (String)
  • :default_redirect_url (String)
  • :user_id_attribute (String)
  • :use_encryption (Boolean)
  • :create_user (Boolean)
  • :add_group_memberships (Boolean)
  • :group_membership_attribute (String)
  • :default_groups (Array<String>)
  • :name_id_format (String)
  • :synchronize_attributes (Array<String>)
  • :handle_logout (Boolean)
  • :logout_url (String)
  • :clock_tolerance (Integer)
  • :digest_method (String)
  • :signature_method (String)
  • :user_intermediate_path (String)
  • :propertylist (Array<String>)

Returns:



335
336
337
338
 
# File 'lib/swagger_aem/api/console_api.rb', line 335

def post_saml_configuration(opts = {})
  data, _status_code, _headers = post_saml_configuration_with_http_info(opts)
  data
end

#post_saml_configuration_with_http_info(opts = {}) ⇒ Array<(SamlConfigurationInfo, Integer, Hash)>

Returns SamlConfigurationInfo data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :post (Boolean)
  • :apply (Boolean)
  • :delete (Boolean)
  • :action (String)
  • :location (String)
  • :path (Array<String>)
  • :service_ranking (Integer)
  • :idp_url (String)
  • :idp_cert_alias (String)
  • :idp_http_redirect (Boolean)
  • :service_provider_entity_id (String)
  • :assertion_consumer_service_url (String)
  • :sp_private_key_alias (String)
  • :key_store_password (String)
  • :default_redirect_url (String)
  • :user_id_attribute (String)
  • :use_encryption (Boolean)
  • :create_user (Boolean)
  • :add_group_memberships (Boolean)
  • :group_membership_attribute (String)
  • :default_groups (Array<String>)
  • :name_id_format (String)
  • :synchronize_attributes (Array<String>)
  • :handle_logout (Boolean)
  • :logout_url (String)
  • :clock_tolerance (Integer)
  • :digest_method (String)
  • :signature_method (String)
  • :user_intermediate_path (String)
  • :propertylist (Array<String>)

Returns:

  • (Array<(SamlConfigurationInfo, Integer, Hash)>) —

    SamlConfigurationInfo data, response status code and response headers



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/swagger_aem/api/console_api.rb', line 372

def post_saml_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConsoleApi.post_saml_configuration ...'
  end
  # resource path
  local_var_path = '/system/console/configMgr/com.adobe.granite.auth.saml.SamlAuthenticationHandler'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'post'] = opts[:'post'] if !opts[:'post'].nil?
  query_params[:'apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'delete'] = opts[:'delete'] if !opts[:'delete'].nil?
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'$location'] = opts[:'location'] if !opts[:'location'].nil?
  query_params[:'path'] = @api_client.build_collection_param(opts[:'path'], :multi) if !opts[:'path'].nil?
  query_params[:'service.ranking'] = opts[:'service_ranking'] if !opts[:'service_ranking'].nil?
  query_params[:'idpUrl'] = opts[:'idp_url'] if !opts[:'idp_url'].nil?
  query_params[:'idpCertAlias'] = opts[:'idp_cert_alias'] if !opts[:'idp_cert_alias'].nil?
  query_params[:'idpHttpRedirect'] = opts[:'idp_http_redirect'] if !opts[:'idp_http_redirect'].nil?
  query_params[:'serviceProviderEntityId'] = opts[:'service_provider_entity_id'] if !opts[:'service_provider_entity_id'].nil?
  query_params[:'assertionConsumerServiceURL'] = opts[:'assertion_consumer_service_url'] if !opts[:'assertion_consumer_service_url'].nil?
  query_params[:'spPrivateKeyAlias'] = opts[:'sp_private_key_alias'] if !opts[:'sp_private_key_alias'].nil?
  query_params[:'keyStorePassword'] = opts[:'key_store_password'] if !opts[:'key_store_password'].nil?
  query_params[:'defaultRedirectUrl'] = opts[:'default_redirect_url'] if !opts[:'default_redirect_url'].nil?
  query_params[:'userIDAttribute'] = opts[:'user_id_attribute'] if !opts[:'user_id_attribute'].nil?
  query_params[:'useEncryption'] = opts[:'use_encryption'] if !opts[:'use_encryption'].nil?
  query_params[:'createUser'] = opts[:'create_user'] if !opts[:'create_user'].nil?
  query_params[:'addGroupMemberships'] = opts[:'add_group_memberships'] if !opts[:'add_group_memberships'].nil?
  query_params[:'groupMembershipAttribute'] = opts[:'group_membership_attribute'] if !opts[:'group_membership_attribute'].nil?
  query_params[:'defaultGroups'] = @api_client.build_collection_param(opts[:'default_groups'], :multi) if !opts[:'default_groups'].nil?
  query_params[:'nameIdFormat'] = opts[:'name_id_format'] if !opts[:'name_id_format'].nil?
  query_params[:'synchronizeAttributes'] = @api_client.build_collection_param(opts[:'synchronize_attributes'], :multi) if !opts[:'synchronize_attributes'].nil?
  query_params[:'handleLogout'] = opts[:'handle_logout'] if !opts[:'handle_logout'].nil?
  query_params[:'logoutUrl'] = opts[:'logout_url'] if !opts[:'logout_url'].nil?
  query_params[:'clockTolerance'] = opts[:'clock_tolerance'] if !opts[:'clock_tolerance'].nil?
  query_params[:'digestMethod'] = opts[:'digest_method'] if !opts[:'digest_method'].nil?
  query_params[:'signatureMethod'] = opts[:'signature_method'] if !opts[:'signature_method'].nil?
  query_params[:'userIntermediatePath'] = opts[:'user_intermediate_path'] if !opts[:'user_intermediate_path'].nil?
  query_params[:'propertylist'] = @api_client.build_collection_param(opts[:'propertylist'], :csv) if !opts[:'propertylist'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'SamlConfigurationInfo' 

  # auth_names
  auth_names = opts[:auth_names] || ['aemAuth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConsoleApi#post_saml_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end