vsphere-automation-content 0.1.0 → 0.2.0

data/docs/LibraryItemStorageApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get**](LibraryItemStorageApi.md#get) | **POST** /com/vmware/content/library/item/storage/id:{library_item_id}?~action=get | Retrieves the storage information for a specific file in a library item.
+[**get**](LibraryItemStorageApi.md#get) | **POST** /com/vmware/content/library/item/storage/id:{library_item_id} | Retrieves the storage information for a specific file in a library item.
 [**list**](LibraryItemStorageApi.md#list) | **GET** /com/vmware/content/library/item/storage | Lists all storage items for a given library item.
 
 
 # **get**
-> ContentLibraryItemStorageResult get(library_item_id, content_library_item_storage_get)
+> ContentLibraryItemStorageResult get(library_item_id, action, request_body)
 
 Retrieves the storage information for a specific file in a library item.
 
@@ -17,14 +17,22 @@ Retrieves the storage information for a specific file in a library item.
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemStorageApi.new
 library_item_id = 'library_item_id_example' # String | Identifier of the library item whose storage information should be retrieved.
-content_library_item_storage_get = VSphereAutomation::ContentLibraryItemStorageGet.new # ContentLibraryItemStorageGet | 
+action = 'action_example' # String | ~action=get
+request_body = Content::ContentLibraryItemStorageGet.new # ContentLibraryItemStorageGet | 
 
 begin
   #Retrieves the storage information for a specific file in a library item.
-  result = api_instance.get(library_item_id, content_library_item_storage_get)
+  result = api_instance.get(library_item_id, action, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemStorageApi->get: #{e}"
@@ -36,7 +44,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **library_item_id** | **String**| Identifier of the library item whose storage information should be retrieved. | 
- **content_library_item_storage_get** | [**ContentLibraryItemStorageGet**](ContentLibraryItemStorageGet.md)|  | 
+ **action** | **String**| ~action=get | 
+ **request_body** | [**ContentLibraryItemStorageGet**](ContentLibraryItemStorageGet.md)|  | 
 
 ### Return type
 
@@ -44,12 +53,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -62,6 +71,13 @@ Lists all storage items for a given library item.
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemStorageApi.new
 library_item_id = 'library_item_id_example' # String | Identifier of the library item whose storage information should be listed.
@@ -87,12 +103,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 

data/docs/LibraryItemUpdateSessionApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://<vcenter>/rest*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**cancel**](LibraryItemUpdateSessionApi.md#cancel) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=cancel | Cancels the update session and sets its state to {@link UpdateSessionModel.State#CANCELED}. This {@term operation} will free up any temporary resources currently associated with the session. <p> This {@term operation} is not allowed if the session has been already completed. <p> Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.
-[**complete**](LibraryItemUpdateSessionApi.md#complete) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=complete | Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
+[**complete**](LibraryItemUpdateSessionApi.md#complete) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id} | Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
 [**create**](LibraryItemUpdateSessionApi.md#create) | **POST** /com/vmware/content/library/item/update-session | Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. <p> Content Library Service allows only one single update session to be active for a specific library item.
 [**delete**](LibraryItemUpdateSessionApi.md#delete) | **DELETE** /com/vmware/content/library/item/update-session/id:{update_session_id} | Deletes an update session. This removes the session and all information associated with it. <p> Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item. <p> Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time.
 [**fail**](LibraryItemUpdateSessionApi.md#fail) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail | Terminates the update session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.
@@ -24,6 +24,13 @@ Cancels the update session and sets its state to {@link UpdateSessionModel.State
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifier of the update session that should be canceled.
@@ -48,17 +55,17 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **complete**
-> complete(update_session_id)
+> complete(update_session_id, action)
 
 Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
 
@@ -66,13 +73,21 @@ Completes the update session. This indicates that the client has finished making
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifier of the update session that should be completed.
+action = 'action_example' # String | ~action=complete
 
 begin
   #Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
-  api_instance.complete(update_session_id)
+  api_instance.complete(update_session_id, action)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemUpdateSessionApi->complete: #{e}"
 end
@@ -83,6 +98,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **update_session_id** | **String**| Identifier of the update session that should be completed. | 
+ **action** | **String**| ~action&#x3D;complete | 
 
 ### Return type
 
@@ -90,17 +106,17 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **create**
-> ContentLibraryItemUpdateSessionCreateResult create(content_library_item_update_session_create)
+> ContentLibraryItemUpdateSessionCreateResult create(request_body)
 
 Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. <p> Content Library Service allows only one single update session to be active for a specific library item.
 
@@ -108,13 +124,20 @@ Creates a new update session. An update session is used to make modifications to
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
-content_library_item_update_session_create = VSphereAutomation::ContentLibraryItemUpdateSessionCreate.new # ContentLibraryItemUpdateSessionCreate | 
+request_body = Content::ContentLibraryItemUpdateSessionCreate.new # ContentLibraryItemUpdateSessionCreate | 
 
 begin
   #Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. <p> Content Library Service allows only one single update session to be active for a specific library item.
-  result = api_instance.create(content_library_item_update_session_create)
+  result = api_instance.create(request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemUpdateSessionApi->create: #{e}"
@@ -125,7 +148,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_library_item_update_session_create** | [**ContentLibraryItemUpdateSessionCreate**](ContentLibraryItemUpdateSessionCreate.md)|  | 
+ **request_body** | [**ContentLibraryItemUpdateSessionCreate**](ContentLibraryItemUpdateSessionCreate.md)|  | 
 
 ### Return type
 
@@ -133,12 +156,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -151,6 +174,13 @@ Deletes an update session. This removes the session and all information associat
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifer of the update session to delete.
@@ -175,17 +205,17 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **fail**
-> fail(update_session_id, content_library_item_update_session_fail)
+> fail(update_session_id, request_body)
 
 Terminates the update session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.
 
@@ -193,14 +223,21 @@ Terminates the update session with a client specified error message. <p> This is
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifier of the update session to fail.
-content_library_item_update_session_fail = VSphereAutomation::ContentLibraryItemUpdateSessionFail.new # ContentLibraryItemUpdateSessionFail | 
+request_body = Content::ContentLibraryItemUpdateSessionFail.new # ContentLibraryItemUpdateSessionFail | 
 
 begin
   #Terminates the update session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.
-  api_instance.fail(update_session_id, content_library_item_update_session_fail)
+  api_instance.fail(update_session_id, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemUpdateSessionApi->fail: #{e}"
 end
@@ -211,7 +248,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **update_session_id** | **String**| Identifier of the update session to fail. | 
- **content_library_item_update_session_fail** | [**ContentLibraryItemUpdateSessionFail**](ContentLibraryItemUpdateSessionFail.md)|  | 
+ **request_body** | [**ContentLibraryItemUpdateSessionFail**](ContentLibraryItemUpdateSessionFail.md)|  | 
 
 ### Return type
 
@@ -219,12 +256,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -237,6 +274,13 @@ Gets the update session with the specified identifier, including the most up-to-
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifier of the update session to retrieve.
@@ -262,12 +306,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -280,11 +324,18 @@ Keeps an update session alive. <p> If there is no activity for an update session
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifier of the update session whose lifetime should be extended.
 opts = {
-  content_library_item_update_session_keep_alive: VSphereAutomation::ContentLibraryItemUpdateSessionKeepAlive.new # ContentLibraryItemUpdateSessionKeepAlive | 
+  request_body: Content::ContentLibraryItemUpdateSessionKeepAlive.new # ContentLibraryItemUpdateSessionKeepAlive | 
 }
 
 begin
@@ -300,7 +351,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **update_session_id** | **String**| Identifier of the update session whose lifetime should be extended. | 
- **content_library_item_update_session_keep_alive** | [**ContentLibraryItemUpdateSessionKeepAlive**](ContentLibraryItemUpdateSessionKeepAlive.md)|  | [optional] 
+ **request_body** | [**ContentLibraryItemUpdateSessionKeepAlive**](ContentLibraryItemUpdateSessionKeepAlive.md)|  | [optional] 
 
 ### Return type
 
@@ -308,12 +359,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -326,6 +377,13 @@ Lists the identifiers of the update session created by the calling user. Optiona
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 opts = {
@@ -353,17 +411,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **update**
-> update(update_session_id, content_library_item_update_session_update)
+> update(update_session_id, request_body)
 
 Updates the properties of an update session. <p> This is an incremental update to the update session. Any {@term field} in the {@link UpdateSessionModel} {@term structure} that is {@term unset} will not be modified. <p> This {@term operation} will only update the property {@link UpdateSessionModel#warningBehavior} of the update session. This will not, for example, update the {@link UpdateSessionModel#libraryItemId} or {@link UpdateSessionModel#state} of an update session. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state.
 
@@ -371,14 +429,21 @@ Updates the properties of an update session. <p> This is an incremental update t
 ```ruby
 # load the gem
 require 'vsphere-automation-content'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
 update_session_id = 'update_session_id_example' # String | Identifer of the update session that should be updated.
-content_library_item_update_session_update = VSphereAutomation::ContentLibraryItemUpdateSessionUpdate.new # ContentLibraryItemUpdateSessionUpdate | 
+request_body = Content::ContentLibraryItemUpdateSessionUpdate.new # ContentLibraryItemUpdateSessionUpdate | 
 
 begin
   #Updates the properties of an update session. <p> This is an incremental update to the update session. Any {@term field} in the {@link UpdateSessionModel} {@term structure} that is {@term unset} will not be modified. <p> This {@term operation} will only update the property {@link UpdateSessionModel#warningBehavior} of the update session. This will not, for example, update the {@link UpdateSessionModel#libraryItemId} or {@link UpdateSessionModel#state} of an update session. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state.
-  api_instance.update(update_session_id, content_library_item_update_session_update)
+  api_instance.update(update_session_id, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemUpdateSessionApi->update: #{e}"
 end
@@ -389,7 +454,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **update_session_id** | **String**| Identifer of the update session that should be updated. | 
- **content_library_item_update_session_update** | [**ContentLibraryItemUpdateSessionUpdate**](ContentLibraryItemUpdateSessionUpdate.md)|  | 
+ **request_body** | [**ContentLibraryItemUpdateSessionUpdate**](ContentLibraryItemUpdateSessionUpdate.md)|  | 
 
 ### Return type
 
@@ -397,12 +462,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json