swagger_aem 3.8.0 → 4.0.0

data/docs/CrxApi.md

@@ -2,16 +2,15 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_crxde_status**](CrxApi.md#get_crxde_status) | **GET** /crx/server/crx.default/jcr:root/.1.json | 
-[**get_install_status**](CrxApi.md#get_install_status) | **GET** /crx/packmgr/installstatus.jsp | 
-[**get_package_manager_servlet**](CrxApi.md#get_package_manager_servlet) | **GET** /crx/packmgr/service/script.html | 
-[**post_package_service**](CrxApi.md#post_package_service) | **POST** /crx/packmgr/service.jsp | 
-[**post_package_service_json**](CrxApi.md#post_package_service_json) | **POST** /crx/packmgr/service/.json/{path} | 
-[**post_package_update**](CrxApi.md#post_package_update) | **POST** /crx/packmgr/update.jsp | 
-[**post_set_password**](CrxApi.md#post_set_password) | **POST** /crx/explorer/ui/setpassword.jsp | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_crxde_status**](CrxApi.md#get_crxde_status) | **GET** /crx/server/crx.default/jcr:root/.1.json |  |
+| [**get_install_status**](CrxApi.md#get_install_status) | **GET** /crx/packmgr/installstatus.jsp |  |
+| [**get_package_manager_servlet**](CrxApi.md#get_package_manager_servlet) | **GET** /crx/packmgr/service/script.html |  |
+| [**post_package_service**](CrxApi.md#post_package_service) | **POST** /crx/packmgr/service.jsp |  |
+| [**post_package_service_json**](CrxApi.md#post_package_service_json) | **POST** /crx/packmgr/service/.json/{path} |  |
+| [**post_package_update**](CrxApi.md#post_package_update) | **POST** /crx/packmgr/update.jsp |  |
+| [**post_set_password**](CrxApi.md#post_set_password) | **POST** /crx/explorer/ui/setpassword.jsp |  |
 
 
 ## get_crxde_status
@@ -20,10 +19,10 @@ Method | HTTP request | Description
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -35,10 +34,29 @@ end
 api_instance = SwaggerAemClient::CrxApi.new
 
 begin
+  
   result = api_instance.get_crxde_status
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->get_crxde_status: #{e}"
+  puts "Error when calling CrxApi->get_crxde_status: #{e}"
+end
+```
+
+#### Using the get_crxde_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_crxde_status_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_crxde_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->get_crxde_status_with_http_info: #{e}"
 end
 ```
 
@@ -62,14 +80,14 @@ This endpoint does not need any parameter.
 
 ## get_install_status
 
-> InstallStatus get_install_status
+> <InstallStatus> get_install_status
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -81,10 +99,29 @@ end
 api_instance = SwaggerAemClient::CrxApi.new
 
 begin
+  
   result = api_instance.get_install_status
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->get_install_status: #{e}"
+  puts "Error when calling CrxApi->get_install_status: #{e}"
+end
+```
+
+#### Using the get_install_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InstallStatus>, Integer, Hash)> get_install_status_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_install_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InstallStatus>
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->get_install_status_with_http_info: #{e}"
 end
 ```
 
@@ -112,10 +149,10 @@ This endpoint does not need any parameter.
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -127,9 +164,28 @@ end
 api_instance = SwaggerAemClient::CrxApi.new
 
 begin
+  
   api_instance.get_package_manager_servlet
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->get_package_manager_servlet: #{e}"
+  puts "Error when calling CrxApi->get_package_manager_servlet: #{e}"
+end
+```
+
+#### Using the get_package_manager_servlet_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> get_package_manager_servlet_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_package_manager_servlet_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->get_package_manager_servlet_with_http_info: #{e}"
 end
 ```
 
@@ -157,10 +213,10 @@ nil (empty response body)
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -173,19 +229,37 @@ api_instance = SwaggerAemClient::CrxApi.new
 cmd = 'cmd_example' # String | 
 
 begin
+  
   result = api_instance.post_package_service(cmd)
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->post_package_service: #{e}"
+  puts "Error when calling CrxApi->post_package_service: #{e}"
 end
 ```
 
-### Parameters
+#### Using the post_package_service_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> post_package_service_with_http_info(cmd)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.post_package_service_with_http_info(cmd)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->post_package_service_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **cmd** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmd** | **String** |  |  |
 
 ### Return type
 
@@ -207,10 +281,10 @@ Name | Type | Description  | Notes
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -229,31 +303,49 @@ opts = {
   _charset_: '_charset__example', # String | 
   force: true, # Boolean | 
   recursive: true, # Boolean | 
-  package: File.new('/path/to/file') # File | 
+  package: File.new('/path/to/some/file') # File | 
 }
 
 begin
+  
   result = api_instance.post_package_service_json(path, cmd, opts)
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->post_package_service_json: #{e}"
+  puts "Error when calling CrxApi->post_package_service_json: #{e}"
 end
 ```
 
-### Parameters
+#### Using the post_package_service_json_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **String**|  | 
- **cmd** | **String**|  | 
- **group_name** | **String**|  | [optional] 
- **package_name** | **String**|  | [optional] 
- **package_version** | **String**|  | [optional] 
- **_charset_** | **String**|  | [optional] 
- **force** | **Boolean**|  | [optional] 
- **recursive** | **Boolean**|  | [optional] 
- **package** | **File**|  | [optional] 
+> <Array(String, Integer, Hash)> post_package_service_json_with_http_info(path, cmd, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.post_package_service_json_with_http_info(path, cmd, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->post_package_service_json_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **cmd** | **String** |  |  |
+| **group_name** | **String** |  | [optional] |
+| **package_name** | **String** |  | [optional] |
+| **package_version** | **String** |  | [optional] |
+| **_charset_** | **String** |  | [optional] |
+| **force** | **Boolean** |  | [optional] |
+| **recursive** | **Boolean** |  | [optional] |
+| **package** | **File** |  | [optional] |
 
 ### Return type
 
@@ -275,10 +367,10 @@ Name | Type | Description  | Notes
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -298,24 +390,42 @@ opts = {
 }
 
 begin
+  
   result = api_instance.post_package_update(group_name, package_name, version, path, opts)
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->post_package_update: #{e}"
+  puts "Error when calling CrxApi->post_package_update: #{e}"
 end
 ```
 
-### Parameters
+#### Using the post_package_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> post_package_update_with_http_info(group_name, package_name, version, path, opts)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.post_package_update_with_http_info(group_name, package_name, version, path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->post_package_update_with_http_info: #{e}"
+end
+```
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_name** | **String**|  | 
- **package_name** | **String**|  | 
- **version** | **String**|  | 
- **path** | **String**|  | 
- **filter** | **String**|  | [optional] 
- **_charset_** | **String**|  | [optional] 
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_name** | **String** |  |  |
+| **package_name** | **String** |  |  |
+| **version** | **String** |  |  |
+| **path** | **String** |  |  |
+| **filter** | **String** |  | [optional] |
+| **_charset_** | **String** |  | [optional] |
 
 ### Return type
 
@@ -337,10 +447,10 @@ Name | Type | Description  | Notes
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -355,21 +465,39 @@ plain = 'plain_example' # String |
 verify = 'verify_example' # String | 
 
 begin
+  
   result = api_instance.post_set_password(old, plain, verify)
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CrxApi->post_set_password: #{e}"
+  puts "Error when calling CrxApi->post_set_password: #{e}"
 end
 ```
 
-### Parameters
+#### Using the post_set_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(String, Integer, Hash)> post_set_password_with_http_info(old, plain, verify)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.post_set_password_with_http_info(old, plain, verify)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CrxApi->post_set_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **old** | **String**|  | 
- **plain** | **String**|  | 
- **verify** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **old** | **String** |  |  |
+| **plain** | **String** |  |  |
+| **verify** | **String** |  |  |
 
 ### Return type
 

data/docs/CustomApi.md

@@ -2,12 +2,11 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_aem_health_check**](CustomApi.md#get_aem_health_check) | **GET** /system/health | 
-[**post_config_aem_health_check_servlet**](CustomApi.md#post_config_aem_health_check_servlet) | **POST** /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck | 
-[**post_config_aem_password_reset**](CustomApi.md#post_config_aem_password_reset) | **POST** /apps/system/config/com.shinesolutions.aem.passwordreset.Activator | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_aem_health_check**](CustomApi.md#get_aem_health_check) | **GET** /system/health |  |
+| [**post_config_aem_health_check_servlet**](CustomApi.md#post_config_aem_health_check_servlet) | **POST** /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck |  |
+| [**post_config_aem_password_reset**](CustomApi.md#post_config_aem_password_reset) | **POST** /apps/system/config/com.shinesolutions.aem.passwordreset.Activator |  |
 
 
 ## get_aem_health_check
@@ -16,10 +15,10 @@ Method | HTTP request | Description
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -35,20 +34,38 @@ opts = {
 }
 
 begin
+  
   result = api_instance.get_aem_health_check(opts)
   p result
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CustomApi->get_aem_health_check: #{e}"
+  puts "Error when calling CustomApi->get_aem_health_check: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_aem_health_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_aem_health_check_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_aem_health_check_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CustomApi->get_aem_health_check_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **tags** | **String**|  | [optional] 
- **combine_tags_or** | **Boolean**|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tags** | **String** |  | [optional] |
+| **combine_tags_or** | **Boolean** |  | [optional] |
 
 ### Return type
 
@@ -70,10 +87,10 @@ Name | Type | Description  | Notes
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -84,24 +101,42 @@ end
 
 api_instance = SwaggerAemClient::CustomApi.new
 opts = {
-  bundles_ignored: ['bundles_ignored_example'], # Array<String> | 
+  bundles_ignored: ['inner_example'], # Array<String> | 
   bundles_ignored_type_hint: 'bundles_ignored_type_hint_example' # String | 
 }
 
 begin
+  
   api_instance.post_config_aem_health_check_servlet(opts)
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CustomApi->post_config_aem_health_check_servlet: #{e}"
+  puts "Error when calling CustomApi->post_config_aem_health_check_servlet: #{e}"
 end
 ```
 
-### Parameters
+#### Using the post_config_aem_health_check_servlet_with_http_info variant
 
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bundles_ignored** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
- **bundles_ignored_type_hint** | **String**|  | [optional] 
+> <Array(nil, Integer, Hash)> post_config_aem_health_check_servlet_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.post_config_aem_health_check_servlet_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CustomApi->post_config_aem_health_check_servlet_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bundles_ignored** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **bundles_ignored_type_hint** | **String** |  | [optional] |
 
 ### Return type
 
@@ -123,10 +158,10 @@ nil (empty response body)
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'swagger_aem'
 # setup authorization
 SwaggerAemClient.configure do |config|
@@ -137,24 +172,42 @@ end
 
 api_instance = SwaggerAemClient::CustomApi.new
 opts = {
-  pwdreset_authorizables: ['pwdreset_authorizables_example'], # Array<String> | 
+  pwdreset_authorizables: ['inner_example'], # Array<String> | 
   pwdreset_authorizables_type_hint: 'pwdreset_authorizables_type_hint_example' # String | 
 }
 
 begin
+  
   api_instance.post_config_aem_password_reset(opts)
 rescue SwaggerAemClient::ApiError => e
-  puts "Exception when calling CustomApi->post_config_aem_password_reset: #{e}"
+  puts "Error when calling CustomApi->post_config_aem_password_reset: #{e}"
 end
 ```
 
-### Parameters
+#### Using the post_config_aem_password_reset_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_config_aem_password_reset_with_http_info(opts)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.post_config_aem_password_reset_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue SwaggerAemClient::ApiError => e
+  puts "Error when calling CustomApi->post_config_aem_password_reset_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pwdreset_authorizables** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
- **pwdreset_authorizables_type_hint** | **String**|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pwdreset_authorizables** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **pwdreset_authorizables_type_hint** | **String** |  | [optional] |
 
 ### Return type