ibm_cloud_resource_controller 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0458df5ef33bef0ba53f9a8782a997676c792d9a05703546988611e4b8eb1933'
+  data.tar.gz: f10b207a0bbc10435e005266f635189ac500aeba9e7a24e6b7bebcaa099112ed
+SHA512:
+  metadata.gz: 2cec4de6319d878ff2b23b9917c7d19a3e3dd302add5ce9b33d13b6dd3b67001b9757d7591c90936350171e533ad076565f4cd71694cae44bd066e08ee1571fa
+  data.tar.gz: fbed6f3838dade61f002e7e79860fd0810476cf8c685ea9d21a40f84ae6aaa0ab135c349237260add1241dace02fa52fb5bc299aa5bb410ca3bdfe746335f1d6

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,148 @@
+# ibm_cloud_resource_controller
+
+IbmCloudResourceController - the Ruby gem for the IBM Cloud Resource Controller API
+
+Manage lifecycle of your Cloud resources using Resource Controller APIs. Resources are provisioned globally in an account scope. Supports asynchronous provisioning of resources. Enables consumption of a global resource through a Cloud Foundry space in any region.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build ibm_cloud_resource_controller.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./ibm_cloud_resource_controller-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./ibm_cloud_resource_controller-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'ibm_cloud_resource_controller', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'ibm_cloud_resource_controller', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://resource-controller.cloud.ibm.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*IbmCloudResourceController::ResourceAliasesApi* | [**create_resource_alias**](docs/ResourceAliasesApi.md#create_resource_alias) | **POST** /v2/resource_aliases | Create a new resource alias
+*IbmCloudResourceController::ResourceAliasesApi* | [**delete_resource_alias**](docs/ResourceAliasesApi.md#delete_resource_alias) | **DELETE** /v2/resource_aliases/{id} | Delete a resource alias
+*IbmCloudResourceController::ResourceAliasesApi* | [**get_resource_alias**](docs/ResourceAliasesApi.md#get_resource_alias) | **GET** /v2/resource_aliases/{id} | Get a resource alias
+*IbmCloudResourceController::ResourceAliasesApi* | [**list_resource_aliases**](docs/ResourceAliasesApi.md#list_resource_aliases) | **GET** /v2/resource_aliases | Get a list of all resource aliases
+*IbmCloudResourceController::ResourceAliasesApi* | [**update_resource_alias**](docs/ResourceAliasesApi.md#update_resource_alias) | **PATCH** /v2/resource_aliases/{id} | Update a resource alias
+*IbmCloudResourceController::ResourceBindingsApi* | [**create_resource_binding**](docs/ResourceBindingsApi.md#create_resource_binding) | **POST** /v2/resource_bindings | Create a new resource binding
+*IbmCloudResourceController::ResourceBindingsApi* | [**delete_resource_binding**](docs/ResourceBindingsApi.md#delete_resource_binding) | **DELETE** /v2/resource_bindings/{id} | Delete a resource binding
+*IbmCloudResourceController::ResourceBindingsApi* | [**get_resource_binding**](docs/ResourceBindingsApi.md#get_resource_binding) | **GET** /v2/resource_bindings/{id} | Get a resource binding
+*IbmCloudResourceController::ResourceBindingsApi* | [**list_resource_bindings**](docs/ResourceBindingsApi.md#list_resource_bindings) | **GET** /v2/resource_bindings | Get a list of all resource bindings
+*IbmCloudResourceController::ResourceBindingsApi* | [**update_resource_binding**](docs/ResourceBindingsApi.md#update_resource_binding) | **PATCH** /v2/resource_bindings/{id} | Update a resource binding
+*IbmCloudResourceController::ResourceInstancesApi* | [**create_resource_instance**](docs/ResourceInstancesApi.md#create_resource_instance) | **POST** /v2/resource_instances | Create (provision) a new resource instance
+*IbmCloudResourceController::ResourceInstancesApi* | [**delete_resource_instance**](docs/ResourceInstancesApi.md#delete_resource_instance) | **DELETE** /v2/resource_instances/{id} | Delete a resource instance
+*IbmCloudResourceController::ResourceInstancesApi* | [**get_resource_instance**](docs/ResourceInstancesApi.md#get_resource_instance) | **GET** /v2/resource_instances/{id} | Get a resource instance
+*IbmCloudResourceController::ResourceInstancesApi* | [**list_resource_instances**](docs/ResourceInstancesApi.md#list_resource_instances) | **GET** /v2/resource_instances | Get a list of all resource instances
+*IbmCloudResourceController::ResourceInstancesApi* | [**lock_resource_instance**](docs/ResourceInstancesApi.md#lock_resource_instance) | **POST** /v2/resource_instances/{id}/lock | Lock a resource instance
+*IbmCloudResourceController::ResourceInstancesApi* | [**unlock_resource_instance**](docs/ResourceInstancesApi.md#unlock_resource_instance) | **DELETE** /v2/resource_instances/{id}/lock | Unlock a resource instance
+*IbmCloudResourceController::ResourceInstancesApi* | [**update_resource_instance**](docs/ResourceInstancesApi.md#update_resource_instance) | **PATCH** /v2/resource_instances/{id} | Update a resource instance
+*IbmCloudResourceController::ResourceKeysApi* | [**create_resource_key**](docs/ResourceKeysApi.md#create_resource_key) | **POST** /v2/resource_keys | Create a new resource key
+*IbmCloudResourceController::ResourceKeysApi* | [**delete_resource_key**](docs/ResourceKeysApi.md#delete_resource_key) | **DELETE** /v2/resource_keys/{id} | Delete a resource key by ID
+*IbmCloudResourceController::ResourceKeysApi* | [**get_resource_key**](docs/ResourceKeysApi.md#get_resource_key) | **GET** /v2/resource_keys/{id} | Get resource key by ID
+*IbmCloudResourceController::ResourceKeysApi* | [**list_resource_keys**](docs/ResourceKeysApi.md#list_resource_keys) | **GET** /v2/resource_keys | Get a list of all of the resource keys.
+*IbmCloudResourceController::ResourceKeysApi* | [**update_resource_key**](docs/ResourceKeysApi.md#update_resource_key) | **PATCH** /v2/resource_keys/{id} | Update a resource key
+*IbmCloudResourceController::ResourceReclamationsApi* | [**list_reclamations**](docs/ResourceReclamationsApi.md#list_reclamations) | **GET** /v1/reclamations | Get a list of all reclamations
+*IbmCloudResourceController::ResourceReclamationsApi* | [**run_reclamation_action**](docs/ResourceReclamationsApi.md#run_reclamation_action) | **POST** /v1/reclamations/{id}/actions/{action_name} | Perform a reclamation action
+
+
+## Documentation for Models
+
+ - [IbmCloudResourceController::Credentials](docs/Credentials.md)
+ - [IbmCloudResourceController::ErrorReport](docs/ErrorReport.md)
+ - [IbmCloudResourceController::PlanHistoryItem](docs/PlanHistoryItem.md)
+ - [IbmCloudResourceController::Reclamation](docs/Reclamation.md)
+ - [IbmCloudResourceController::ReclamationActionsPost](docs/ReclamationActionsPost.md)
+ - [IbmCloudResourceController::ReclamationsList](docs/ReclamationsList.md)
+ - [IbmCloudResourceController::ResourceAlias](docs/ResourceAlias.md)
+ - [IbmCloudResourceController::ResourceAliasPatch](docs/ResourceAliasPatch.md)
+ - [IbmCloudResourceController::ResourceAliasPost](docs/ResourceAliasPost.md)
+ - [IbmCloudResourceController::ResourceAliasesList](docs/ResourceAliasesList.md)
+ - [IbmCloudResourceController::ResourceBinding](docs/ResourceBinding.md)
+ - [IbmCloudResourceController::ResourceBindingPatch](docs/ResourceBindingPatch.md)
+ - [IbmCloudResourceController::ResourceBindingPost](docs/ResourceBindingPost.md)
+ - [IbmCloudResourceController::ResourceBindingPostParameters](docs/ResourceBindingPostParameters.md)
+ - [IbmCloudResourceController::ResourceBindingsList](docs/ResourceBindingsList.md)
+ - [IbmCloudResourceController::ResourceInstance](docs/ResourceInstance.md)
+ - [IbmCloudResourceController::ResourceInstancePatch](docs/ResourceInstancePatch.md)
+ - [IbmCloudResourceController::ResourceInstancePost](docs/ResourceInstancePost.md)
+ - [IbmCloudResourceController::ResourceInstancesList](docs/ResourceInstancesList.md)
+ - [IbmCloudResourceController::ResourceKey](docs/ResourceKey.md)
+ - [IbmCloudResourceController::ResourceKeyPatch](docs/ResourceKeyPatch.md)
+ - [IbmCloudResourceController::ResourceKeyPost](docs/ResourceKeyPost.md)
+ - [IbmCloudResourceController::ResourceKeysList](docs/ResourceKeysList.md)
+
+
+## Documentation for Authorization
+
+
+### IAM
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Credentials.md

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,45 @@
+# 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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,57 @@
+# 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

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,302 @@
+# 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
+