ibm_cloud_resource_controller 1.0.1 → 2.0.0

data/docs/Credentials.md

@@ -1,25 +0,0 @@
-# IbmCloudResourceController::Credentials
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**apikey** | **String** | The API key for the credentials. | [optional] 
-**iam_apikey_description** | **String** | The optional description of the API key. | [optional] 
-**iam_apikey_name** | **String** | The name of the API key. | [optional] 
-**iam_role_crn** | **String** | The Cloud Resource Name for the role of the credentials. | [optional] 
-**iam_serviceid_crn** | **String** | The Cloud Resource Name for the service ID of the credentials. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::Credentials.new(apikey: null,
-                                 iam_apikey_description: null,
-                                 iam_apikey_name: null,
-                                 iam_role_crn: null,
-                                 iam_serviceid_crn: null)
-```
-
-

data/docs/ErrorReport.md

@@ -1,23 +0,0 @@
-# IbmCloudResourceController::ErrorReport
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error_code** | **String** | The error code encountered. | [optional] 
-**message** | **String** | The error message. | [optional] 
-**status_code** | **String** | The status code. | [optional] 
-**transaction_id** | **String** | The transaction-id of the request. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::ErrorReport.new(error_code: RC-CloudControllerErrorResponse,
-                                 message: null,
-                                 status_code: null,
-                                 transaction_id: null)
-```
-
-

data/docs/PlanHistoryItem.md

@@ -1,19 +0,0 @@
-# IbmCloudResourceController::PlanHistoryItem
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**resource_plan_id** | **String** | The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog. | 
-**start_date** | **DateTime** | The date on which the plan was changed. | 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::PlanHistoryItem.new(resource_plan_id: null,
-                                 start_date: null)
-```
-
-

data/docs/Reclamation.md

@@ -1,45 +0,0 @@
-# IbmCloudResourceController::Reclamation
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The ID associated with the reclamation. | [optional] 
-**entity_id** | **String** | The short ID of the entity for the reclamation. | [optional] 
-**entity_type_id** | **String** | The short ID of the entity type for the reclamation. | [optional] 
-**entity_crn** | **String** | The full Cloud Resource Name (CRN) associated with the binding. For more information about this format, see [Cloud Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn). | [optional] 
-**resource_instance_id** | **String** | The short ID of the resource instance. | [optional] 
-**resource_group_id** | **String** | The short ID of the resource group. | [optional] 
-**account_id** | **String** | An alpha-numeric value identifying the account ID. | [optional] 
-**policy_id** | **String** | The short ID of policy for the reclamation. | [optional] 
-**state** | **String** | The state of the reclamation. | [optional] 
-**target_time** | **String** | The target time that the reclamation retention period end. | [optional] 
-**custom_properties** | **Hash<String, Object>** | The custom properties of the reclamation. | [optional] 
-**created_at** | **DateTime** | The date when the reclamation was created. | [optional] 
-**created_by** | **String** | The subject who created the reclamation. | [optional] 
-**updated_at** | **DateTime** | The date when the reclamation was last updated. | [optional] 
-**updated_by** | **String** | The subject who updated the reclamation. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::Reclamation.new(id: null,
-                                 entity_id: null,
-                                 entity_type_id: null,
-                                 entity_crn: null,
-                                 resource_instance_id: null,
-                                 resource_group_id: null,
-                                 account_id: null,
-                                 policy_id: null,
-                                 state: null,
-                                 target_time: null,
-                                 custom_properties: null,
-                                 created_at: null,
-                                 created_by: null,
-                                 updated_at: null,
-                                 updated_by: null)
-```
-
-

data/docs/ReclamationActionsPost.md

@@ -1,19 +0,0 @@
-# IbmCloudResourceController::ReclamationActionsPost
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**request_by** | **String** | The request initiator, if different from the request token. | [optional] 
-**comment** | **String** | A comment to describe the action. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::ReclamationActionsPost.new(request_by: null,
-                                 comment: null)
-```
-
-

data/docs/ReclamationsList.md

@@ -1,17 +0,0 @@
-# IbmCloudResourceController::ReclamationsList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**resources** | [**Array<Reclamation>**](Reclamation.md) | A list of reclamations. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::ReclamationsList.new(resources: null)
-```
-
-

data/docs/ResourceAlias.md

@@ -1,57 +0,0 @@
-# IbmCloudResourceController::ResourceAlias
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The ID associated with the alias. | [optional] 
-**guid** | **String** | When you create a new alias, a globally unique identifier (GUID) is assigned. This GUID is a unique internal indentifier managed by the resource controller that corresponds to the alias. | [optional] 
-**crn** | **String** | The full Cloud Resource Name (CRN) associated with the alias. 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 alias, a relative URL path is created identifying the location of the alias. | [optional] 
-**name** | **String** | The human-readable name of the alias. | [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] 
-**resource_group_crn** | **String** | The long ID (full CRN) of the resource group. | [optional] 
-**target_crn** | **String** | The CRN of the target namespace in the specific environment. | [optional] 
-**state** | **String** | The state of the alias. | [optional] 
-**resource_instance_id** | **String** | The short ID of the resource instance that is being aliased. | [optional] 
-**region_instance_id** | **String** | The short ID of the instance in the specific target environment, e.g. `service_instance_id` in a given IBM Cloud environment. | [optional] 
-**resource_instance_url** | **String** | The relative path to the instance. | [optional] 
-**resource_bindings_url** | **String** | The relative path to the resource bindings for the alias. | [optional] 
-**resource_keys_url** | **String** | The relative path to the resource keys for the alias. | [optional] 
-**created_at** | **DateTime** | The date when the alias was created. | [optional] 
-**updated_at** | **DateTime** | The date when the alias was last updated. | [optional] 
-**deleted_at** | **DateTime** | The date when the alias was deleted. | [optional] 
-**created_by** | **String** | The subject who created the alias. | [optional] 
-**updated_by** | **String** | The subject who updated the alias. | [optional] 
-**deleted_by** | **String** | The subject who deleted the alias. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::ResourceAlias.new(id: null,
-                                 guid: null,
-                                 crn: null,
-                                 url: null,
-                                 name: null,
-                                 account_id: null,
-                                 resource_group_id: null,
-                                 resource_group_crn: null,
-                                 target_crn: null,
-                                 state: null,
-                                 resource_instance_id: null,
-                                 region_instance_id: null,
-                                 resource_instance_url: null,
-                                 resource_bindings_url: null,
-                                 resource_keys_url: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 deleted_at: null,
-                                 created_by: null,
-                                 updated_by: null,
-                                 deleted_by: null)
-```
-
-

data/docs/ResourceAliasPatch.md

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

data/docs/ResourceAliasPost.md

@@ -1,21 +0,0 @@
-# IbmCloudResourceController::ResourceAliasPost
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the alias. Must be 180 characters or less and cannot include any special characters other than `(space) - . _ :`. | 
-**source** | **String** | The short or long ID of resource instance. | 
-**target** | **String** | The CRN of target name(space) in a specific environment, e.g. space in Dallas YP, CFEE instance etc. | 
-
-## Code Sample
-
-```ruby
-require 'IbmCloudResourceController'
-
-instance = IbmCloudResourceController::ResourceAliasPost.new(name: my-alias,
-                                 source: a8dff6d3-d287-4668-a81d-c87c55c2656d,
-                                 target: crn:v1:cf:public:cf:us-south:o/5e939cd5-6377-4383-b9e0-9db22cd11753::cf-space:66c8b915-101a-406c-a784-e6636676e4f5)
-```
-
-

data/docs/ResourceAliasesApi.md

@@ -1,302 +0,0 @@
-# IbmCloudResourceController::ResourceAliasesApi
-
-All URIs are relative to *https://resource-controller.cloud.ibm.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_resource_alias**](ResourceAliasesApi.md#create_resource_alias) | **POST** /v2/resource_aliases | Create a new resource alias
-[**delete_resource_alias**](ResourceAliasesApi.md#delete_resource_alias) | **DELETE** /v2/resource_aliases/{id} | Delete a resource alias
-[**get_resource_alias**](ResourceAliasesApi.md#get_resource_alias) | **GET** /v2/resource_aliases/{id} | Get a resource alias
-[**list_resource_aliases**](ResourceAliasesApi.md#list_resource_aliases) | **GET** /v2/resource_aliases | Get a list of all resource aliases
-[**update_resource_alias**](ResourceAliasesApi.md#update_resource_alias) | **PATCH** /v2/resource_aliases/{id} | Update a resource alias
-
-
-
-## create_resource_alias
-
-> ResourceAlias create_resource_alias(resource_alias_post)
-
-Create a new resource alias
-
-Alias a resource instance into a targeted environment's (name)space.
-
-### 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::ResourceAliasesApi.new
-resource_alias_post = IbmCloudResourceController::ResourceAliasPost.new # ResourceAliasPost | 
-
-begin
-  #Create a new resource alias
-  result = api_instance.create_resource_alias(resource_alias_post)
-  p result
-rescue IbmCloudResourceController::ApiError => e
-  puts "Exception when calling ResourceAliasesApi->create_resource_alias: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **resource_alias_post** | [**ResourceAliasPost**](ResourceAliasPost.md)|  | 
-
-### Return type
-
-[**ResourceAlias**](ResourceAlias.md)
-
-### Authorization
-
-[IAM](../README.md#IAM)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_resource_alias
-
-> delete_resource_alias(id)
-
-Delete a resource alias
-
-Delete a resource alias 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::ResourceAliasesApi.new
-id = 'id_example' # String | The short or long ID of the alias.
-
-begin
-  #Delete a resource alias
-  api_instance.delete_resource_alias(id)
-rescue IbmCloudResourceController::ApiError => e
-  puts "Exception when calling ResourceAliasesApi->delete_resource_alias: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| The short or long ID of the alias. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[IAM](../README.md#IAM)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_resource_alias
-
-> ResourceAlias get_resource_alias(id)
-
-Get a resource alias
-
-Retrieve a resource alias 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::ResourceAliasesApi.new
-id = 'id_example' # String | The short or long ID of the alias.
-
-begin
-  #Get a resource alias
-  result = api_instance.get_resource_alias(id)
-  p result
-rescue IbmCloudResourceController::ApiError => e
-  puts "Exception when calling ResourceAliasesApi->get_resource_alias: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| The short or long ID of the alias. | 
-
-### Return type
-
-[**ResourceAlias**](ResourceAlias.md)
-
-### Authorization
-
-[IAM](../README.md#IAM)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list_resource_aliases
-
-> ResourceAliasesList list_resource_aliases(opts)
-
-Get a list of all resource aliases
-
-Get a list of all resource aliases.
-
-### 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::ResourceAliasesApi.new
-opts = {
-  guid: 'guid_example', # String | Short ID of the alias.
-  name: 'name_example', # String | The human-readable name of the alias.
-  resource_instance_id: 'resource_instance_id_example', # String | Resource instance short ID.
-  region_instance_id: 'region_instance_id_example', # String | Short ID of the instance in a specific targeted environment. For example, `service_instance_id` in a given IBM Cloud environment.
-  resource_id: 'resource_id_example', # String | The unique ID of the offering (service name). This value is provided by and stored in the global catalog.
-  resource_group_id: 'resource_group_id_example', # String | Short ID of Resource group.
-  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 resource aliases
-  result = api_instance.list_resource_aliases(opts)
-  p result
-rescue IbmCloudResourceController::ApiError => e
-  puts "Exception when calling ResourceAliasesApi->list_resource_aliases: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **guid** | **String**| Short ID of the alias. | [optional] 
- **name** | **String**| The human-readable name of the alias. | [optional] 
- **resource_instance_id** | **String**| Resource instance short ID. | [optional] 
- **region_instance_id** | **String**| Short ID of the instance in a specific targeted environment. For example, `service_instance_id` in a given IBM Cloud environment. | [optional] 
- **resource_id** | **String**| The unique ID of the offering (service name). This value is provided by and stored in the global catalog. | [optional] 
- **resource_group_id** | **String**| Short ID of Resource group. | [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
-
-[**ResourceAliasesList**](ResourceAliasesList.md)
-
-### Authorization
-
-[IAM](../README.md#IAM)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update_resource_alias
-
-> ResourceAlias update_resource_alias(id, resource_alias_patch)
-
-Update a resource alias
-
-Update a resource alias 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::ResourceAliasesApi.new
-id = 'id_example' # String | The short or long ID of the alias.
-resource_alias_patch = IbmCloudResourceController::ResourceAliasPatch.new # ResourceAliasPatch | 
-
-begin
-  #Update a resource alias
-  result = api_instance.update_resource_alias(id, resource_alias_patch)
-  p result
-rescue IbmCloudResourceController::ApiError => e
-  puts "Exception when calling ResourceAliasesApi->update_resource_alias: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| The short or long ID of the alias. | 
- **resource_alias_patch** | [**ResourceAliasPatch**](ResourceAliasPatch.md)|  | 
-
-### Return type
-
-[**ResourceAlias**](ResourceAlias.md)
-
-### Authorization
-
-[IAM](../README.md#IAM)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-