ibm_cloud_power 1.1.1 → 2.0.0

data/docs/PCloudEventsApi.md

@@ -2,23 +2,22 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**pcloud_events_get**](PCloudEventsApi.md#pcloud_events_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events/{event_id} | Get a single event
-[**pcloud_events_getsince**](PCloudEventsApi.md#pcloud_events_getsince) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events | Get events from this cloud instance since a specific timestamp
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**pcloud_events_get**](PCloudEventsApi.md#pcloud_events_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events/{event_id} | Get a single event |
+| [**pcloud_events_getsince**](PCloudEventsApi.md#pcloud_events_getsince) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events | Get events from this cloud instance since a specific timestamp |
 
 
 ## pcloud_events_get
 
-> Event pcloud_events_get(cloud_instance_id, event_id, opts)
+> <Event> pcloud_events_get(cloud_instance_id, event_id, opts)
 
 Get a single event
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ibm_cloud_power'
 
 api_instance = IbmCloudPower::PCloudEventsApi.new
@@ -29,22 +28,39 @@ opts = {
 }
 
 begin
-  #Get a single event
+  # Get a single event
   result = api_instance.pcloud_events_get(cloud_instance_id, event_id, opts)
   p result
 rescue IbmCloudPower::ApiError => e
-  puts "Exception when calling PCloudEventsApi->pcloud_events_get: #{e}"
+  puts "Error when calling PCloudEventsApi->pcloud_events_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the pcloud_events_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<Event>, Integer, Hash)> pcloud_events_get_with_http_info(cloud_instance_id, event_id, opts)
+
+```ruby
+begin
+  # Get a single event
+  data, status_code, headers = api_instance.pcloud_events_get_with_http_info(cloud_instance_id, event_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Event>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling PCloudEventsApi->pcloud_events_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
- **event_id** | **String**| Event ID | 
- **accept_language** | **String**| The language requested for the return document | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance |  |
+| **event_id** | **String** | Event ID |  |
+| **accept_language** | **String** | The language requested for the return document | [optional] |
 
 ### Return type
 
@@ -62,16 +78,16 @@ No authorization required
 
 ## pcloud_events_getsince
 
-> Events pcloud_events_getsince(cloud_instance_id, time, opts)
+> <Events> pcloud_events_getsince(cloud_instance_id, time, opts)
 
 Get events from this cloud instance since a specific timestamp
 
 You must append the '?time=' query parameter to the cURL URL to get a list of events.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ibm_cloud_power'
 
 api_instance = IbmCloudPower::PCloudEventsApi.new
@@ -82,22 +98,39 @@ opts = {
 }
 
 begin
-  #Get events from this cloud instance since a specific timestamp
+  # Get events from this cloud instance since a specific timestamp
   result = api_instance.pcloud_events_getsince(cloud_instance_id, time, opts)
   p result
 rescue IbmCloudPower::ApiError => e
-  puts "Exception when calling PCloudEventsApi->pcloud_events_getsince: #{e}"
+  puts "Error when calling PCloudEventsApi->pcloud_events_getsince: #{e}"
 end
 ```
 
-### Parameters
+#### Using the pcloud_events_getsince_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Events>, Integer, Hash)> pcloud_events_getsince_with_http_info(cloud_instance_id, time, opts)
+
+```ruby
+begin
+  # Get events from this cloud instance since a specific timestamp
+  data, status_code, headers = api_instance.pcloud_events_getsince_with_http_info(cloud_instance_id, time, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Events>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling PCloudEventsApi->pcloud_events_getsince_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
- **time** | **String**| (deprecated - use from_time) A time in either ISO 8601 or unix epoch format | 
- **accept_language** | **String**| The language requested for the return document | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance |  |
+| **time** | **String** | (deprecated - use from_time) A time in either ISO 8601 or unix epoch format |  |
+| **accept_language** | **String** | The language requested for the return document | [optional] |
 
 ### Return type