autosde_openapi_client 1.0.0 → 1.0.21

data/docs/HostVolumeConnection.md

@@ -1,23 +1,24 @@
-# OpenapiClient::HostVolumeConnection
+# AutosdeOpenapiClient::HostVolumeConnection
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**component_state** | **String** | component_state | [optional] 
-**host** | [**Host**](Host.md) |  | [optional] 
-**uuid** | **String** | uuid | [optional] 
-**volume** | [**Volume**](Volume.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component_state** | **String** | component_state | [optional] |
+| **host** | [**Host**](Host.md) |  | [optional] |
+| **uuid** | **String** | uuid | [optional] |
+| **volume** | [**Volume**](Volume.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::HostVolumeConnection.new(component_state: null,
-                                 host: null,
-                                 uuid: null,
-                                 volume: null)
+instance = AutosdeOpenapiClient::HostVolumeConnection.new(
+  component_state: null,
+  host: null,
+  uuid: null,
+  volume: null
+)
 ```
 
-

data/docs/HostVolumeConnectionApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::HostVolumeConnectionApi
+# AutosdeOpenapiClient::HostVolumeConnectionApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**host_volume_connection_get**](HostVolumeConnectionApi.md#host_volume_connection_get) | **GET** /host-volume-connection/ | 
-[**host_volume_connection_pk_delete**](HostVolumeConnectionApi.md#host_volume_connection_pk_delete) | **DELETE** /host-volume-connection/{pk} | 
-[**host_volume_connection_pk_get**](HostVolumeConnectionApi.md#host_volume_connection_pk_get) | **GET** /host-volume-connection/{pk} | 
-[**host_volume_connection_post**](HostVolumeConnectionApi.md#host_volume_connection_post) | **POST** /host-volume-connection/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**host_volume_connection_get**](HostVolumeConnectionApi.md#host_volume_connection_get) | **GET** /host-volume-connection/ |  |
+| [**host_volume_connection_pk_delete**](HostVolumeConnectionApi.md#host_volume_connection_pk_delete) | **DELETE** /host-volume-connection/{pk} |  |
+| [**host_volume_connection_pk_get**](HostVolumeConnectionApi.md#host_volume_connection_pk_get) | **GET** /host-volume-connection/{pk} |  |
+| [**host_volume_connection_post**](HostVolumeConnectionApi.md#host_volume_connection_post) | **POST** /host-volume-connection/ |  |
 
 
 ## host_volume_connection_get
 
-> Array<HostVolumeConnection> host_volume_connection_get
+> <Array<HostVolumeConnection>> host_volume_connection_get
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'autosde_openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+AutosdeOpenapiClient.configure do |config|
   # Configure Bearer authorization: bearerAuth
   config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
-api_instance = OpenapiClient::HostVolumeConnectionApi.new
+api_instance = AutosdeOpenapiClient::HostVolumeConnectionApi.new
 
 begin
+  
   result = api_instance.host_volume_connection_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling HostVolumeConnectionApi->host_volume_connection_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_get: #{e}"
+end
+```
+
+#### Using the host_volume_connection_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<HostVolumeConnection>>, Integer, Hash)> host_volume_connection_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.host_volume_connection_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<HostVolumeConnection>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## host_volume_connection_pk_delete
 
-> Array&lt;HostVolumeConnection&gt; host_volume_connection_pk_delete(pk)
+> <Array<HostVolumeConnection>> host_volume_connection_pk_delete(pk)
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'autosde_openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+AutosdeOpenapiClient.configure do |config|
   # Configure Bearer authorization: bearerAuth
   config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
-api_instance = OpenapiClient::HostVolumeConnectionApi.new
+api_instance = AutosdeOpenapiClient::HostVolumeConnectionApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.host_volume_connection_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling HostVolumeConnectionApi->host_volume_connection_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the host_volume_connection_pk_delete_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pk** | **Integer**|  | 
+> <Array(<Array<HostVolumeConnection>>, Integer, Hash)> host_volume_connection_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.host_volume_connection_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<HostVolumeConnection>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## host_volume_connection_pk_get
 
-> Array&lt;HostVolumeConnection&gt; host_volume_connection_pk_get(pk)
+> <Array<HostVolumeConnection>> host_volume_connection_pk_get(pk)
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'autosde_openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+AutosdeOpenapiClient.configure do |config|
   # Configure Bearer authorization: bearerAuth
   config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
-api_instance = OpenapiClient::HostVolumeConnectionApi.new
+api_instance = AutosdeOpenapiClient::HostVolumeConnectionApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.host_volume_connection_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling HostVolumeConnectionApi->host_volume_connection_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the host_volume_connection_pk_get_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pk** | **Integer**|  | 
+> <Array(<Array<HostVolumeConnection>>, Integer, Hash)> host_volume_connection_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.host_volume_connection_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<HostVolumeConnection>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,42 +210,60 @@ Name | Type | Description  | Notes
 
 ## host_volume_connection_post
 
-> Array&lt;HostVolumeConnection&gt; host_volume_connection_post(host_volume_connection_create)
+> <HostVolumeConnection> host_volume_connection_post(host_volume_connection_create)
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'autosde_openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+AutosdeOpenapiClient.configure do |config|
   # Configure Bearer authorization: bearerAuth
   config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
-api_instance = OpenapiClient::HostVolumeConnectionApi.new
-host_volume_connection_create = OpenapiClient::HostVolumeConnectionCreate.new # HostVolumeConnectionCreate | 
+api_instance = AutosdeOpenapiClient::HostVolumeConnectionApi.new
+host_volume_connection_create = AutosdeOpenapiClient::HostVolumeConnectionCreate.new # HostVolumeConnectionCreate | 
 
 begin
+  
   result = api_instance.host_volume_connection_post(host_volume_connection_create)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling HostVolumeConnectionApi->host_volume_connection_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the host_volume_connection_post_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **host_volume_connection_create** | [**HostVolumeConnectionCreate**](HostVolumeConnectionCreate.md)|  | 
+> <Array(<HostVolumeConnection>, Integer, Hash)> host_volume_connection_post_with_http_info(host_volume_connection_create)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.host_volume_connection_post_with_http_info(host_volume_connection_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HostVolumeConnection>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling HostVolumeConnectionApi->host_volume_connection_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host_volume_connection_create** | [**HostVolumeConnectionCreate**](HostVolumeConnectionCreate.md) |  |  |
 
 ### Return type
 
-[**Array&lt;HostVolumeConnection&gt;**](HostVolumeConnection.md)
+[**HostVolumeConnection**](HostVolumeConnection.md)
 
 ### Authorization
 

data/docs/HostVolumeConnectionCreate.md

@@ -1,21 +1,22 @@
-# OpenapiClient::HostVolumeConnectionCreate
+# AutosdeOpenapiClient::HostVolumeConnectionCreate
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**component_state** | **String** | component_state | [optional] 
-**host** | [**Host**](Host.md) |  | [optional] 
-**volume** | [**Volume**](Volume.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component_state** | **String** | component_state | [optional] |
+| **host** | [**Host**](Host.md) |  | [optional] |
+| **volume** | [**Volume**](Volume.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::HostVolumeConnectionCreate.new(component_state: null,
-                                 host: null,
-                                 volume: null)
+instance = AutosdeOpenapiClient::HostVolumeConnectionCreate.new(
+  component_state: null,
+  host: null,
+  volume: null
+)
 ```
 
-

data/docs/Job.md

@@ -0,0 +1,30 @@
+# AutosdeOpenapiClient::Job
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_finished** | **Time** | date_finished | [optional] |
+| **date_started** | **Time** | date_started | [optional] |
+| **status** | **String** | status | [optional] |
+| **task_args** | **String** | task_args | [optional] |
+| **task_id** | **String** | task_id | [optional] |
+| **task_kwargs** | **String** | task_kwargs | [optional] |
+| **task_name** | **String** | task_name | [optional] |
+
+## Example
+
+```ruby
+require 'autosde_openapi_client'
+
+instance = AutosdeOpenapiClient::Job.new(
+  date_finished: null,
+  date_started: null,
+  status: null,
+  task_args: null,
+  task_id: null,
+  task_kwargs: null,
+  task_name: null
+)
+```
+

data/docs/JobApi.md

@@ -0,0 +1,140 @@
+# AutosdeOpenapiClient::JobApi
+
+All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**jobs_get**](JobApi.md#jobs_get) | **GET** /jobs |  |
+| [**jobs_post**](JobApi.md#jobs_post) | **POST** /jobs |  |
+
+
+## jobs_get
+
+> <Array<Job>> jobs_get
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'autosde_openapi_client'
+# setup authorization
+AutosdeOpenapiClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AutosdeOpenapiClient::JobApi.new
+
+begin
+  
+  result = api_instance.jobs_get
+  p result
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_get: #{e}"
+end
+```
+
+#### Using the jobs_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Job>>, Integer, Hash)> jobs_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.jobs_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Job>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Job&gt;**](Job.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## jobs_post
+
+> <Job> jobs_post(job_create)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'autosde_openapi_client'
+# setup authorization
+AutosdeOpenapiClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AutosdeOpenapiClient::JobApi.new
+job_create = AutosdeOpenapiClient::JobCreate.new # JobCreate | 
+
+begin
+  
+  result = api_instance.jobs_post(job_create)
+  p result
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_post: #{e}"
+end
+```
+
+#### Using the jobs_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Job>, Integer, Hash)> jobs_post_with_http_info(job_create)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.jobs_post_with_http_info(job_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Job>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_create** | [**JobCreate**](JobCreate.md) |  |  |
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+