autosde_openapi_client 1.0.0 → 1.0.21

data/docs/AutoSDERole.md

@@ -1,19 +1,20 @@
-# OpenapiClient::AutoSDERole
+# AutosdeOpenapiClient::AutoSDERole
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | name | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::AutoSDERole.new(name: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::AutoSDERole.new(
+  name: null,
+  uuid: null
+)
 ```
 
-

data/docs/AutoSDERoleApi.md

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

data/docs/CapabilityTranslation.md

@@ -1,35 +1,36 @@
-# OpenapiClient::CapabilityTranslation
+# AutosdeOpenapiClient::CapabilityTranslation
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**abstract_capability** | [**AbstractCapability**](AbstractCapability.md) |  | [optional] 
-**abstract_capability_name** | **String** | abstract_capability_name | [optional] 
-**default_value** | **String** | default_value | [optional] [default to ' ']
-**native_capability** | [**NativeCapability**](NativeCapability.md) |  | [optional] 
-**native_capability_name** | **String** | native_capability_name | [optional] 
-**published** | **Boolean** | published | [optional] 
-**system_type_id** | **String** | system_type_id | [optional] 
-**to_abstract_value_mapper** | **String** | Maximum value length is 32 characters. | [optional] 
-**to_native_value_mapper** | **String** | Maximum value length is 32 characters. | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abstract_capability** | [**AbstractCapability**](AbstractCapability.md) |  | [optional] |
+| **abstract_capability_name** | **String** | abstract_capability_name | [optional] |
+| **default_value** | **String** | default_value | [optional][default to ' '] |
+| **native_capability** | [**NativeCapability**](NativeCapability.md) |  | [optional] |
+| **native_capability_name** | **String** | native_capability_name | [optional] |
+| **published** | **Boolean** | published | [optional] |
+| **system_type_id** | **String** | system_type_id | [optional] |
+| **to_abstract_value_mapper** | **String** | Maximum value length is 32 characters. | [optional] |
+| **to_native_value_mapper** | **String** | Maximum value length is 32 characters. | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::CapabilityTranslation.new(abstract_capability: null,
-                                 abstract_capability_name: null,
-                                 default_value: null,
-                                 native_capability: null,
-                                 native_capability_name: null,
-                                 published: null,
-                                 system_type_id: null,
-                                 to_abstract_value_mapper: null,
-                                 to_native_value_mapper: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::CapabilityTranslation.new(
+  abstract_capability: null,
+  abstract_capability_name: null,
+  default_value: null,
+  native_capability: null,
+  native_capability_name: null,
+  published: null,
+  system_type_id: null,
+  to_abstract_value_mapper: null,
+  to_native_value_mapper: null,
+  uuid: null
+)
 ```
 
-

data/docs/CapabilityTranslationApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::CapabilityTranslationApi
+# AutosdeOpenapiClient::CapabilityTranslationApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**capability_translations_get**](CapabilityTranslationApi.md#capability_translations_get) | **GET** /capability-translations/ | 
-[**capability_translations_pk_delete**](CapabilityTranslationApi.md#capability_translations_pk_delete) | **DELETE** /capability-translations/{pk} | 
-[**capability_translations_pk_get**](CapabilityTranslationApi.md#capability_translations_pk_get) | **GET** /capability-translations/{pk} | 
-[**capability_translations_post**](CapabilityTranslationApi.md#capability_translations_post) | **POST** /capability-translations/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**capability_translations_get**](CapabilityTranslationApi.md#capability_translations_get) | **GET** /capability-translations/ |  |
+| [**capability_translations_pk_delete**](CapabilityTranslationApi.md#capability_translations_pk_delete) | **DELETE** /capability-translations/{pk} |  |
+| [**capability_translations_pk_get**](CapabilityTranslationApi.md#capability_translations_pk_get) | **GET** /capability-translations/{pk} |  |
+| [**capability_translations_post**](CapabilityTranslationApi.md#capability_translations_post) | **POST** /capability-translations/ |  |
 
 
 ## capability_translations_get
 
-> Array<CapabilityTranslation> capability_translations_get
+> <Array<CapabilityTranslation>> capability_translations_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::CapabilityTranslationApi.new
+api_instance = AutosdeOpenapiClient::CapabilityTranslationApi.new
 
 begin
+  
   result = api_instance.capability_translations_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling CapabilityTranslationApi->capability_translations_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_get: #{e}"
+end
+```
+
+#### Using the capability_translations_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CapabilityTranslation>>, Integer, Hash)> capability_translations_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.capability_translations_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CapabilityTranslation>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## capability_translations_pk_delete
 
-> Array&lt;CapabilityTranslation&gt; capability_translations_pk_delete(pk)
+> <Array<CapabilityTranslation>> capability_translations_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::CapabilityTranslationApi.new
+api_instance = AutosdeOpenapiClient::CapabilityTranslationApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.capability_translations_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling CapabilityTranslationApi->capability_translations_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the capability_translations_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<CapabilityTranslation>>, Integer, Hash)> capability_translations_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.capability_translations_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CapabilityTranslation>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## capability_translations_pk_get
 
-> Array&lt;CapabilityTranslation&gt; capability_translations_pk_get(pk)
+> <Array<CapabilityTranslation>> capability_translations_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::CapabilityTranslationApi.new
+api_instance = AutosdeOpenapiClient::CapabilityTranslationApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.capability_translations_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling CapabilityTranslationApi->capability_translations_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the capability_translations_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<CapabilityTranslation>>, Integer, Hash)> capability_translations_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.capability_translations_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CapabilityTranslation>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,42 +210,60 @@ Name | Type | Description  | Notes
 
 ## capability_translations_post
 
-> Array&lt;CapabilityTranslation&gt; capability_translations_post(capability_translation_create)
+> <CapabilityTranslation> capability_translations_post(capability_translation_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::CapabilityTranslationApi.new
-capability_translation_create = OpenapiClient::CapabilityTranslationCreate.new # CapabilityTranslationCreate | 
+api_instance = AutosdeOpenapiClient::CapabilityTranslationApi.new
+capability_translation_create = AutosdeOpenapiClient::CapabilityTranslationCreate.new # CapabilityTranslationCreate | 
 
 begin
+  
   result = api_instance.capability_translations_post(capability_translation_create)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling CapabilityTranslationApi->capability_translations_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the capability_translations_post_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **capability_translation_create** | [**CapabilityTranslationCreate**](CapabilityTranslationCreate.md)|  | 
+> <Array(<CapabilityTranslation>, Integer, Hash)> capability_translations_post_with_http_info(capability_translation_create)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.capability_translations_post_with_http_info(capability_translation_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CapabilityTranslation>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling CapabilityTranslationApi->capability_translations_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capability_translation_create** | [**CapabilityTranslationCreate**](CapabilityTranslationCreate.md) |  |  |
 
 ### Return type
 
-[**Array&lt;CapabilityTranslation&gt;**](CapabilityTranslation.md)
+[**CapabilityTranslation**](CapabilityTranslation.md)
 
 ### Authorization