vsphere-automation-content 0.1.0 → 0.2.0

data/docs/LibraryItemDownloadSessionApi.md

@@ -7,7 +7,7 @@ Method | HTTP request | Description
 [**cancel**](LibraryItemDownloadSessionApi.md#cancel) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel | Cancels the download session. This {@term operation} will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.
 [**create**](LibraryItemDownloadSessionApi.md#create) | **POST** /com/vmware/content/library/item/download-session | Creates a new download session.
 [**delete**](LibraryItemDownloadSessionApi.md#delete) | **DELETE** /com/vmware/content/library/item/download-session/id:{download_session_id} | Deletes a download session. This removes the session and all information associated with it. <p> Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item. <p> Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.
-[**fail**](LibraryItemDownloadSessionApi.md#fail) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail | Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
+[**fail**](LibraryItemDownloadSessionApi.md#fail) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id} | Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
 [**get**](LibraryItemDownloadSessionApi.md#get) | **GET** /com/vmware/content/library/item/download-session/id:{download_session_id} | Gets the download session with the specified identifier, including the most up-to-date status information for the session.
 [**keep_alive**](LibraryItemDownloadSessionApi.md#keep_alive) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive | Keeps a download session alive. This operation is allowed only if the session is in the {@link DownloadSessionModel.State#ACTIVE} state. <p> If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this {@term operation} enables a client to specifically extend the lifetime of an active download session.
 [**list**](LibraryItemDownloadSessionApi.md#list) | **GET** /com/vmware/content/library/item/download-session | Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item.
@@ -22,6 +22,13 @@ Cancels the download session. This {@term operation} will abort any ongoing tran
 ```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::LibraryItemDownloadSessionApi.new
 download_session_id = 'download_session_id_example' # String | Identifer of the download session that should be canceled.
@@ -46,17 +53,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**
-> ContentLibraryItemDownloadSessionCreateResult create(content_library_item_download_session_create)
+> ContentLibraryItemDownloadSessionCreateResult create(request_body)
 
 Creates a new download session.
 
@@ -64,13 +71,20 @@ Creates a new download 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::LibraryItemDownloadSessionApi.new
-content_library_item_download_session_create = VSphereAutomation::ContentLibraryItemDownloadSessionCreate.new # ContentLibraryItemDownloadSessionCreate | 
+request_body = Content::ContentLibraryItemDownloadSessionCreate.new # ContentLibraryItemDownloadSessionCreate | 
 
 begin
   #Creates a new download session.
-  result = api_instance.create(content_library_item_download_session_create)
+  result = api_instance.create(request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemDownloadSessionApi->create: #{e}"
@@ -81,7 +95,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_library_item_download_session_create** | [**ContentLibraryItemDownloadSessionCreate**](ContentLibraryItemDownloadSessionCreate.md)|  | 
+ **request_body** | [**ContentLibraryItemDownloadSessionCreate**](ContentLibraryItemDownloadSessionCreate.md)|  | 
 
 ### Return type
 
@@ -89,12 +103,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
 
 
 
@@ -107,6 +121,13 @@ Deletes a download session. This removes the session and all information associa
 ```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::LibraryItemDownloadSessionApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session to be deleted.
@@ -131,17 +152,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(download_session_id, content_library_item_download_session_fail)
+> fail(download_session_id, action, request_body)
 
 Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
 
@@ -149,14 +170,22 @@ Terminates the download session with a client specified error message. <p> This
 ```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::LibraryItemDownloadSessionApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session to fail.
-content_library_item_download_session_fail = VSphereAutomation::ContentLibraryItemDownloadSessionFail.new # ContentLibraryItemDownloadSessionFail | 
+action = 'action_example' # String | ~action=fail
+request_body = Content::ContentLibraryItemDownloadSessionFail.new # ContentLibraryItemDownloadSessionFail | 
 
 begin
   #Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
-  api_instance.fail(download_session_id, content_library_item_download_session_fail)
+  api_instance.fail(download_session_id, action, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemDownloadSessionApi->fail: #{e}"
 end
@@ -167,7 +196,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **download_session_id** | **String**| Identifier of the download session to fail. | 
- **content_library_item_download_session_fail** | [**ContentLibraryItemDownloadSessionFail**](ContentLibraryItemDownloadSessionFail.md)|  | 
+ **action** | **String**| ~action&#x3D;fail | 
+ **request_body** | [**ContentLibraryItemDownloadSessionFail**](ContentLibraryItemDownloadSessionFail.md)|  | 
 
 ### Return type
 
@@ -175,12 +205,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
 
 
 
@@ -193,6 +223,13 @@ Gets the download session with the specified identifier, including the most up-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::LibraryItemDownloadSessionApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session to retrieve.
@@ -218,12 +255,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
 
 
 
@@ -236,11 +273,18 @@ Keeps a download session alive. This operation is allowed only if the session 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::LibraryItemDownloadSessionApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session whose lifetime should be extended.
 opts = {
-  content_library_item_download_session_keep_alive: VSphereAutomation::ContentLibraryItemDownloadSessionKeepAlive.new # ContentLibraryItemDownloadSessionKeepAlive | 
+  request_body: Content::ContentLibraryItemDownloadSessionKeepAlive.new # ContentLibraryItemDownloadSessionKeepAlive | 
 }
 
 begin
@@ -256,7 +300,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **download_session_id** | **String**| Identifier of the download session whose lifetime should be extended. | 
- **content_library_item_download_session_keep_alive** | [**ContentLibraryItemDownloadSessionKeepAlive**](ContentLibraryItemDownloadSessionKeepAlive.md)|  | [optional] 
+ **request_body** | [**ContentLibraryItemDownloadSessionKeepAlive**](ContentLibraryItemDownloadSessionKeepAlive.md)|  | [optional] 
 
 ### Return type
 
@@ -264,12 +308,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
 
 
 
@@ -282,6 +326,13 @@ Lists the identifiers of the download sessions created by the calling user. Opti
 ```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::LibraryItemDownloadSessionApi.new
 opts = {
@@ -309,12 +360,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/LibraryItemDownloadsessionFileApi.md

@@ -6,11 +6,11 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get**](LibraryItemDownloadsessionFileApi.md#get) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=get | Retrieves file download information for a specific file.
 [**list**](LibraryItemDownloadsessionFileApi.md#list) | **GET** /com/vmware/content/library/item/downloadsession/file | Lists the information of all the files in the library item associated with the download session.
-[**prepare**](LibraryItemDownloadsessionFileApi.md#prepare) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare | Requests a file to be prepared for download.
+[**prepare**](LibraryItemDownloadsessionFileApi.md#prepare) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id} | Requests a file to be prepared for download.
 
 
 # **get**
-> ContentLibraryItemDownloadsessionFileResult get(download_session_id, content_library_item_downloadsession_file_get)
+> ContentLibraryItemDownloadsessionFileResult get(download_session_id, request_body)
 
 Retrieves file download information for a specific file.
 
@@ -18,14 +18,21 @@ Retrieves file download information for a specific file.
 ```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::LibraryItemDownloadsessionFileApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session.
-content_library_item_downloadsession_file_get = VSphereAutomation::ContentLibraryItemDownloadsessionFileGet.new # ContentLibraryItemDownloadsessionFileGet | 
+request_body = Content::ContentLibraryItemDownloadsessionFileGet.new # ContentLibraryItemDownloadsessionFileGet | 
 
 begin
   #Retrieves file download information for a specific file.
-  result = api_instance.get(download_session_id, content_library_item_downloadsession_file_get)
+  result = api_instance.get(download_session_id, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemDownloadsessionFileApi->get: #{e}"
@@ -37,7 +44,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **download_session_id** | **String**| Identifier of the download session. | 
- **content_library_item_downloadsession_file_get** | [**ContentLibraryItemDownloadsessionFileGet**](ContentLibraryItemDownloadsessionFileGet.md)|  | 
+ **request_body** | [**ContentLibraryItemDownloadsessionFileGet**](ContentLibraryItemDownloadsessionFileGet.md)|  | 
 
 ### Return type
 
@@ -45,12 +52,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
 
 
 
@@ -63,6 +70,13 @@ Lists the information of all the files in the library item associated with the d
 ```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::LibraryItemDownloadsessionFileApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session.
@@ -88,17 +102,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
 
 
 
 # **prepare**
-> ContentLibraryItemDownloadsessionFilePrepareResult prepare(download_session_id, content_library_item_downloadsession_file_prepare)
+> ContentLibraryItemDownloadsessionFilePrepareResult prepare(download_session_id, action, request_body)
 
 Requests a file to be prepared for download.
 
@@ -106,14 +120,22 @@ Requests a file to be prepared for download.
 ```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::LibraryItemDownloadsessionFileApi.new
 download_session_id = 'download_session_id_example' # String | Identifier of the download session.
-content_library_item_downloadsession_file_prepare = VSphereAutomation::ContentLibraryItemDownloadsessionFilePrepare.new # ContentLibraryItemDownloadsessionFilePrepare | 
+action = 'action_example' # String | ~action=prepare
+request_body = Content::ContentLibraryItemDownloadsessionFilePrepare.new # ContentLibraryItemDownloadsessionFilePrepare | 
 
 begin
   #Requests a file to be prepared for download.
-  result = api_instance.prepare(download_session_id, content_library_item_downloadsession_file_prepare)
+  result = api_instance.prepare(download_session_id, action, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemDownloadsessionFileApi->prepare: #{e}"
@@ -125,7 +147,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **download_session_id** | **String**| Identifier of the download session. | 
- **content_library_item_downloadsession_file_prepare** | [**ContentLibraryItemDownloadsessionFilePrepare**](ContentLibraryItemDownloadsessionFilePrepare.md)|  | 
+ **action** | **String**| ~action=prepare | 
+ **request_body** | [**ContentLibraryItemDownloadsessionFilePrepare**](ContentLibraryItemDownloadsessionFilePrepare.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
 
 
 

data/docs/LibraryItemFileApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get**](LibraryItemFileApi.md#get) | **POST** /com/vmware/content/library/item/file/id:{library_item_id}?~action=get | Retrieves the information for a single file in a library item by its name.
+[**get**](LibraryItemFileApi.md#get) | **POST** /com/vmware/content/library/item/file/id:{library_item_id} | Retrieves the information for a single file in a library item by its name.
 [**list**](LibraryItemFileApi.md#list) | **GET** /com/vmware/content/library/item/file | Lists all of the files that are stored within a given library item.
 
 
 # **get**
-> ContentLibraryItemFileResult get(library_item_id, content_library_item_file_get)
+> ContentLibraryItemFileResult get(library_item_id, action, request_body)
 
 Retrieves the information for a single file in a library item by its name.
 
@@ -17,14 +17,22 @@ Retrieves the information for a single file in a library item by its name.
 ```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::LibraryItemFileApi.new
 library_item_id = 'library_item_id_example' # String | Identifier of the library item whose file information should be returned.
-content_library_item_file_get = VSphereAutomation::ContentLibraryItemFileGet.new # ContentLibraryItemFileGet | 
+action = 'action_example' # String | ~action=get
+request_body = Content::ContentLibraryItemFileGet.new # ContentLibraryItemFileGet | 
 
 begin
   #Retrieves the information for a single file in a library item by its name.
-  result = api_instance.get(library_item_id, content_library_item_file_get)
+  result = api_instance.get(library_item_id, action, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LibraryItemFileApi->get: #{e}"
@@ -36,7 +44,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **library_item_id** | **String**| Identifier of the library item whose file information should be returned. | 
- **content_library_item_file_get** | [**ContentLibraryItemFileGet**](ContentLibraryItemFileGet.md)|  | 
+ **action** | **String**| ~action=get | 
+ **request_body** | [**ContentLibraryItemFileGet**](ContentLibraryItemFileGet.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 of the files that are stored within 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::LibraryItemFileApi.new
 library_item_id = 'library_item_id_example' # String | Identifier of the library item whose files 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