autosde_openapi_client 1.0.0 → 1.0.21

data/docs/JobCreate.md

@@ -0,0 +1,20 @@
+# AutosdeOpenapiClient::JobCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_args** | **String** | task_args | [optional] |
+| **task_name** | **String** | task_name | [optional] |
+
+## Example
+
+```ruby
+require 'autosde_openapi_client'
+
+instance = AutosdeOpenapiClient::JobCreate.new(
+  task_args: null,
+  task_name: null
+)
+```
+

data/docs/NativeCapability.md

@@ -1,23 +1,24 @@
-# OpenapiClient::NativeCapability
+# AutosdeOpenapiClient::NativeCapability
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | name | [optional] 
-**published** | **Boolean** | published | [optional] [default to true]
-**system_type** | [**SystemType**](SystemType.md) |  | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name | [optional] |
+| **published** | **Boolean** | published | [optional][default to true] |
+| **system_type** | [**SystemType**](SystemType.md) |  | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::NativeCapability.new(name: null,
-                                 published: null,
-                                 system_type: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::NativeCapability.new(
+  name: null,
+  published: null,
+  system_type: null,
+  uuid: null
+)
 ```
 
-

data/docs/NativeCapabilityApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::NativeCapabilityApi
+# AutosdeOpenapiClient::NativeCapabilityApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**native_capabilities_get**](NativeCapabilityApi.md#native_capabilities_get) | **GET** /native-capabilities/ | 
-[**native_capabilities_pk_delete**](NativeCapabilityApi.md#native_capabilities_pk_delete) | **DELETE** /native-capabilities/{pk} | 
-[**native_capabilities_pk_get**](NativeCapabilityApi.md#native_capabilities_pk_get) | **GET** /native-capabilities/{pk} | 
-[**native_capabilities_post**](NativeCapabilityApi.md#native_capabilities_post) | **POST** /native-capabilities/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**native_capabilities_get**](NativeCapabilityApi.md#native_capabilities_get) | **GET** /native-capabilities/ |  |
+| [**native_capabilities_pk_delete**](NativeCapabilityApi.md#native_capabilities_pk_delete) | **DELETE** /native-capabilities/{pk} |  |
+| [**native_capabilities_pk_get**](NativeCapabilityApi.md#native_capabilities_pk_get) | **GET** /native-capabilities/{pk} |  |
+| [**native_capabilities_post**](NativeCapabilityApi.md#native_capabilities_post) | **POST** /native-capabilities/ |  |
 
 
 ## native_capabilities_get
 
-> Array<NativeCapability> native_capabilities_get
+> <Array<NativeCapability>> native_capabilities_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::NativeCapabilityApi.new
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
 
 begin
+  
   result = api_instance.native_capabilities_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_get: #{e}"
+end
+```
+
+#### Using the native_capabilities_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<NativeCapability>>, Integer, Hash)> native_capabilities_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<NativeCapability>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## native_capabilities_pk_delete
 
-> Array&lt;NativeCapability&gt; native_capabilities_pk_delete(pk)
+> <Array<NativeCapability>> native_capabilities_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::NativeCapabilityApi.new
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.native_capabilities_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the native_capabilities_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<NativeCapability>>, Integer, Hash)> native_capabilities_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<NativeCapability>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## native_capabilities_pk_get
 
-> Array&lt;NativeCapability&gt; native_capabilities_pk_get(pk)
+> <Array<NativeCapability>> native_capabilities_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::NativeCapabilityApi.new
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.native_capabilities_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the native_capabilities_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<NativeCapability>>, Integer, Hash)> native_capabilities_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<NativeCapability>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,42 +210,60 @@ Name | Type | Description  | Notes
 
 ## native_capabilities_post
 
-> Array&lt;NativeCapability&gt; native_capabilities_post(native_capability)
+> <NativeCapability> native_capabilities_post(native_capability)
 
 
 
-### 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::NativeCapabilityApi.new
-native_capability = OpenapiClient::NativeCapability.new # NativeCapability | 
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
+native_capability = AutosdeOpenapiClient::NativeCapability.new # NativeCapability | 
 
 begin
+  
   result = api_instance.native_capabilities_post(native_capability)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the native_capabilities_post_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **native_capability** | [**NativeCapability**](NativeCapability.md)|  | 
+> <Array(<NativeCapability>, Integer, Hash)> native_capabilities_post_with_http_info(native_capability)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_post_with_http_info(native_capability)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NativeCapability>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **native_capability** | [**NativeCapability**](NativeCapability.md) |  |  |
 
 ### Return type
 
-[**Array&lt;NativeCapability&gt;**](NativeCapability.md)
+[**NativeCapability**](NativeCapability.md)
 
 ### Authorization
 

data/docs/Profile.md

@@ -1,25 +1,26 @@
-# OpenapiClient::Profile
+# AutosdeOpenapiClient::Profile
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account** | [**Account**](Account.md) |  | [optional] 
-**description** | **String** | description | [optional] [default to '']
-**name** | **String** | name | [optional] 
-**type** | **String** | Type values are 'Native' or 'Abstract'. doc-todo:I need to know that I got these values correct. | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | [**Account**](Account.md) |  | [optional] |
+| **description** | **String** | description | [optional][default to ''] |
+| **name** | **String** | name | [optional] |
+| **type** | **String** | Type values are 'Native' or 'Abstract'. doc-todo:I need to know that I got these values correct. | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::Profile.new(account: null,
-                                 description: null,
-                                 name: null,
-                                 type: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::Profile.new(
+  account: null,
+  description: null,
+  name: null,
+  type: null,
+  uuid: null
+)
 ```
 
-

data/docs/ProfileApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::ProfileApi
+# AutosdeOpenapiClient::ProfileApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**profiles_get**](ProfileApi.md#profiles_get) | **GET** /profiles/ | 
-[**profiles_pk_delete**](ProfileApi.md#profiles_pk_delete) | **DELETE** /profiles/{pk}/ | 
-[**profiles_pk_get**](ProfileApi.md#profiles_pk_get) | **GET** /profiles/{pk}/ | 
-[**profiles_post**](ProfileApi.md#profiles_post) | **POST** /profiles/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**profiles_get**](ProfileApi.md#profiles_get) | **GET** /profiles/ |  |
+| [**profiles_pk_delete**](ProfileApi.md#profiles_pk_delete) | **DELETE** /profiles/{pk}/ |  |
+| [**profiles_pk_get**](ProfileApi.md#profiles_pk_get) | **GET** /profiles/{pk}/ |  |
+| [**profiles_post**](ProfileApi.md#profiles_post) | **POST** /profiles/ |  |
 
 
 ## profiles_get
 
-> Array<Profile> profiles_get
+> <Array<Profile>> profiles_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::ProfileApi.new
+api_instance = AutosdeOpenapiClient::ProfileApi.new
 
 begin
+  
   result = api_instance.profiles_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ProfileApi->profiles_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_get: #{e}"
+end
+```
+
+#### Using the profiles_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Profile>>, Integer, Hash)> profiles_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.profiles_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Profile>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## profiles_pk_delete
 
-> Array&lt;Profile&gt; profiles_pk_delete(pk)
+> <Array<Profile>> profiles_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::ProfileApi.new
+api_instance = AutosdeOpenapiClient::ProfileApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.profiles_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ProfileApi->profiles_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the profiles_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<Profile>>, Integer, Hash)> profiles_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.profiles_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Profile>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## profiles_pk_get
 
-> Array&lt;Profile&gt; profiles_pk_get(pk)
+> <Array<Profile>> profiles_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::ProfileApi.new
+api_instance = AutosdeOpenapiClient::ProfileApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.profiles_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ProfileApi->profiles_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the profiles_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<Profile>>, Integer, Hash)> profiles_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.profiles_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Profile>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,42 +210,60 @@ Name | Type | Description  | Notes
 
 ## profiles_post
 
-> Array&lt;Profile&gt; profiles_post(profile)
+> <Profile> profiles_post(profile)
 
 
 
-### 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::ProfileApi.new
-profile = OpenapiClient::Profile.new # Profile | 
+api_instance = AutosdeOpenapiClient::ProfileApi.new
+profile = AutosdeOpenapiClient::Profile.new # Profile | 
 
 begin
+  
   result = api_instance.profiles_post(profile)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ProfileApi->profiles_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the profiles_post_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **profile** | [**Profile**](Profile.md)|  | 
+> <Array(<Profile>, Integer, Hash)> profiles_post_with_http_info(profile)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.profiles_post_with_http_info(profile)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Profile>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ProfileApi->profiles_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile** | [**Profile**](Profile.md) |  |  |
 
 ### Return type
 
-[**Array&lt;Profile&gt;**](Profile.md)
+[**Profile**](Profile.md)
 
 ### Authorization