ibm_cloud_resource_controller 1.0.1

data/docs/ResourceInstancesList.md

@@ -0,0 +1,21 @@
+# IbmCloudResourceController::ResourceInstancesList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_url** | **String** | The URL for requesting the next page of results. | 
+**resources** | [**Array<ResourceInstance>**](ResourceInstance.md) | A list of resource instances. | 
+**rows_count** | **Integer** | The number of resource instances in `resources`. | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceInstancesList.new(next_url: null,
+                                 resources: null,
+                                 rows_count: null)
+```
+
+

data/docs/ResourceKey.md

@@ -0,0 +1,53 @@
+# IbmCloudResourceController::ResourceKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID associated with the key. | [optional] 
+**guid** | **String** | When you create a new key, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the key. | [optional] 
+**crn** | **String** | The full Cloud Resource Name (CRN) associated with the key. For more information about this format, see [Cloud Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn). | [optional] 
+**url** | **String** | When you created a new key, a relative URL path is created identifying the location of the key. | [optional] 
+**name** | **String** | The human-readable name of the key. | [optional] 
+**account_id** | **String** | An alpha-numeric value identifying the account ID. | [optional] 
+**resource_group_id** | **String** | The short ID of the resource group. | [optional] 
+**source_crn** | **String** | The CRN of resource instance or alias associated to the key. | [optional] 
+**role** | **String** | The role CRN. | [optional] 
+**state** | **String** | The state of the key. | [optional] 
+**credentials** | [**Credentials**](Credentials.md) | The credentials for the key. Additional key-value pairs are passed through from the resource brokers.  Refer to service’s documentation for additional details. | [optional] 
+**iam_compatible** | **Boolean** | Specifies whether the key’s credentials support IAM. | [optional] 
+**resource_instance_url** | **String** | The relative path to the resource. | [optional] 
+**created_at** | **DateTime** | The date when the key was created. | [optional] 
+**updated_at** | **DateTime** | The date when the key was last updated. | [optional] 
+**deleted_at** | **DateTime** | The date when the key was deleted. | [optional] 
+**created_by** | **String** | The subject who created the key. | [optional] 
+**updated_by** | **String** | The subject who updated the key. | [optional] 
+**deleted_by** | **String** | The subject who deleted the key. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceKey.new(id: null,
+                                 guid: null,
+                                 crn: null,
+                                 url: null,
+                                 name: null,
+                                 account_id: null,
+                                 resource_group_id: null,
+                                 source_crn: null,
+                                 role: null,
+                                 state: null,
+                                 credentials: null,
+                                 iam_compatible: null,
+                                 resource_instance_url: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 deleted_at: null,
+                                 created_by: null,
+                                 updated_by: null,
+                                 deleted_by: null)
+```
+
+

data/docs/ResourceKeyPatch.md

@@ -0,0 +1,17 @@
+# IbmCloudResourceController::ResourceKeyPatch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The new name of the key. Must be 180 characters or less and cannot include any special characters other than `(space) - . _ :`. | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceKeyPatch.new(name: my-new-key-name)
+```
+
+

data/docs/ResourceKeyPost.md

@@ -0,0 +1,23 @@
+# IbmCloudResourceController::ResourceKeyPost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the key. | 
+**source** | **String** | The short or long ID of resource instance or alias. | 
+**parameters** | [**ResourceBindingPostParameters**](ResourceBindingPostParameters.md) |  | [optional] 
+**role** | **String** | The role name or it's CRN. | [optional] [default to 'Writer']
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceKeyPost.new(name: my-key,
+                                 source: 25eba2a9-beef-450b-82cf-f5ad5e36c6dd,
+                                 parameters: null,
+                                 role: Writer)
+```
+
+

data/docs/ResourceKeysApi.md

@@ -0,0 +1,298 @@
+# IbmCloudResourceController::ResourceKeysApi
+
+All URIs are relative to *https://resource-controller.cloud.ibm.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_resource_key**](ResourceKeysApi.md#create_resource_key) | **POST** /v2/resource_keys | Create a new resource key
+[**delete_resource_key**](ResourceKeysApi.md#delete_resource_key) | **DELETE** /v2/resource_keys/{id} | Delete a resource key by ID
+[**get_resource_key**](ResourceKeysApi.md#get_resource_key) | **GET** /v2/resource_keys/{id} | Get resource key by ID
+[**list_resource_keys**](ResourceKeysApi.md#list_resource_keys) | **GET** /v2/resource_keys | Get a list of all of the resource keys.
+[**update_resource_key**](ResourceKeysApi.md#update_resource_key) | **PATCH** /v2/resource_keys/{id} | Update a resource key
+
+
+
+## create_resource_key
+
+> ResourceKey create_resource_key(resource_key_post)
+
+Create a new resource key
+
+Create a new resource key.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceKeysApi.new
+resource_key_post = IbmCloudResourceController::ResourceKeyPost.new # ResourceKeyPost | 
+
+begin
+  #Create a new resource key
+  result = api_instance.create_resource_key(resource_key_post)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceKeysApi->create_resource_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resource_key_post** | [**ResourceKeyPost**](ResourceKeyPost.md)|  | 
+
+### Return type
+
+[**ResourceKey**](ResourceKey.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_resource_key
+
+> delete_resource_key(id)
+
+Delete a resource key by ID
+
+Delete a resource key by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceKeysApi.new
+id = 'id_example' # String | The short or long ID of the key.
+
+begin
+  #Delete a resource key by ID
+  api_instance.delete_resource_key(id)
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceKeysApi->delete_resource_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the key. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_resource_key
+
+> ResourceKey get_resource_key(id)
+
+Get resource key by ID
+
+Get resource key by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceKeysApi.new
+id = 'id_example' # String | The short or long ID of the key.
+
+begin
+  #Get resource key by ID
+  result = api_instance.get_resource_key(id)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceKeysApi->get_resource_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the key. | 
+
+### Return type
+
+[**ResourceKey**](ResourceKey.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_resource_keys
+
+> ResourceKeysList list_resource_keys(opts)
+
+Get a list of all of the resource keys.
+
+List all resource keys.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceKeysApi.new
+opts = {
+  guid: 'guid_example', # String | When you create a new key, a GUID (globally unique identifier) is assigned. This is a unique internal GUID managed by Resource controller that corresponds to the key.
+  name: 'name_example', # String | The human-readable name of the key.
+  resource_group_id: 'resource_group_id_example', # String | The short ID of the resource group.
+  resource_id: 'resource_id_example', # String | The unique ID of the offering. This value is provided by and stored in the global catalog.
+  limit: 'limit_example', # String | Limit on how many items should be returned.
+  updated_from: '2019-01-08T00:00:00.000Z', # String | Start date inclusive filter.
+  updated_to: '2019-01-08T00:00:00.000Z' # String | End date inclusive filter.
+}
+
+begin
+  #Get a list of all of the resource keys.
+  result = api_instance.list_resource_keys(opts)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceKeysApi->list_resource_keys: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **guid** | **String**| When you create a new key, a GUID (globally unique identifier) is assigned. This is a unique internal GUID managed by Resource controller that corresponds to the key. | [optional] 
+ **name** | **String**| The human-readable name of the key. | [optional] 
+ **resource_group_id** | **String**| The short ID of the resource group. | [optional] 
+ **resource_id** | **String**| The unique ID of the offering. This value is provided by and stored in the global catalog. | [optional] 
+ **limit** | **String**| Limit on how many items should be returned. | [optional] 
+ **updated_from** | **String**| Start date inclusive filter. | [optional] 
+ **updated_to** | **String**| End date inclusive filter. | [optional] 
+
+### Return type
+
+[**ResourceKeysList**](ResourceKeysList.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_resource_key
+
+> ResourceKey update_resource_key(id, resource_key_patch)
+
+Update a resource key
+
+Update a resource key by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceKeysApi.new
+id = 'id_example' # String | The short or long ID of the key.
+resource_key_patch = IbmCloudResourceController::ResourceKeyPatch.new # ResourceKeyPatch | 
+
+begin
+  #Update a resource key
+  result = api_instance.update_resource_key(id, resource_key_patch)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceKeysApi->update_resource_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the key. | 
+ **resource_key_patch** | [**ResourceKeyPatch**](ResourceKeyPatch.md)|  | 
+
+### Return type
+
+[**ResourceKey**](ResourceKey.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ResourceKeysList.md

@@ -0,0 +1,21 @@
+# IbmCloudResourceController::ResourceKeysList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_url** | **String** | The URL for requesting the next page of results. | 
+**resources** | [**Array<ResourceKey>**](ResourceKey.md) | A list of resource keys. | 
+**rows_count** | **Integer** | The number of resource keys in `resources`. | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceKeysList.new(next_url: null,
+                                 resources: null,
+                                 rows_count: null)
+```
+
+

data/docs/ResourceReclamationsApi.md

@@ -0,0 +1,128 @@
+# IbmCloudResourceController::ResourceReclamationsApi
+
+All URIs are relative to *https://resource-controller.cloud.ibm.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_reclamations**](ResourceReclamationsApi.md#list_reclamations) | **GET** /v1/reclamations | Get a list of all reclamations
+[**run_reclamation_action**](ResourceReclamationsApi.md#run_reclamation_action) | **POST** /v1/reclamations/{id}/actions/{action_name} | Perform a reclamation action
+
+
+
+## list_reclamations
+
+> ReclamationsList list_reclamations(opts)
+
+Get a list of all reclamations
+
+Get a list of all reclamations.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceReclamationsApi.new
+opts = {
+  account_id: 'account_id_example', # String | An alpha-numeric value identifying the account ID.
+  resource_instance_id: 'resource_instance_id_example' # String | The short ID of the resource instance.
+}
+
+begin
+  #Get a list of all reclamations
+  result = api_instance.list_reclamations(opts)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceReclamationsApi->list_reclamations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| An alpha-numeric value identifying the account ID. | [optional] 
+ **resource_instance_id** | **String**| The short ID of the resource instance. | [optional] 
+
+### Return type
+
+[**ReclamationsList**](ReclamationsList.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## run_reclamation_action
+
+> Reclamation run_reclamation_action(id, action_name, opts)
+
+Perform a reclamation action
+
+Reclaim (provisionally delete) a resource so that it can no longer be used, or restore a resource so that it's usable again.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceReclamationsApi.new
+id = 'id_example' # String | The ID associated with the reclamation.
+action_name = 'action_name_example' # String | The reclamation action name. Specify `reclaim` to delete a resource, or `restore` to restore a resource.
+opts = {
+  reclamation_actions_post: IbmCloudResourceController::ReclamationActionsPost.new # ReclamationActionsPost | 
+}
+
+begin
+  #Perform a reclamation action
+  result = api_instance.run_reclamation_action(id, action_name, opts)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceReclamationsApi->run_reclamation_action: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The ID associated with the reclamation. | 
+ **action_name** | **String**| The reclamation action name. Specify `reclaim` to delete a resource, or `restore` to restore a resource. | 
+ **reclamation_actions_post** | [**ReclamationActionsPost**](ReclamationActionsPost.md)|  | [optional] 
+
+### Return type
+
+[**Reclamation**](Reclamation.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+