ibm_cloud_resource_controller 1.0.1

data/docs/ResourceAliasesList.md

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

data/docs/ResourceBinding.md

@@ -0,0 +1,57 @@
+# IbmCloudResourceController::ResourceBinding
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID associated with the binding. | [optional] 
+**guid** | **String** | When you create a new binding, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the binding. | [optional] 
+**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] 
+**url** | **String** | When you provision a new binding, a relative URL path is created identifying the location of the binding. | [optional] 
+**name** | **String** | The human-readable name of the binding. | [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 alias associated to the binding. | [optional] 
+**target_crn** | **String** | The CRN of target resource, e.g. application, in a specific environment. | [optional] 
+**role** | **String** | The role CRN. | [optional] 
+**region_binding_id** | **String** | The short ID of the binding in specific targeted environment, e.g. `service_binding_id` in a given IBM Cloud environment. | [optional] 
+**state** | **String** | The state of the binding. | [optional] 
+**credentials** | [**Credentials**](Credentials.md) | The credentials for the binding. Additional key-value pairs are passed through from the resource brokers.  For additional details, see the service’s documentation. | [optional] 
+**iam_compatible** | **Boolean** | Specifies whether the binding’s credentials support IAM. | [optional] 
+**resource_alias_url** | **String** | The relative path to the resource alias that this binding is associated with. | [optional] 
+**created_at** | **DateTime** | The date when the binding was created. | [optional] 
+**updated_at** | **DateTime** | The date when the binding was last updated. | [optional] 
+**deleted_at** | **DateTime** | The date when the binding was deleted. | [optional] 
+**created_by** | **String** | The subject who created the binding. | [optional] 
+**updated_by** | **String** | The subject who updated the binding. | [optional] 
+**deleted_by** | **String** | The subject who deleted the binding. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceBinding.new(id: null,
+                                 guid: null,
+                                 crn: null,
+                                 url: null,
+                                 name: null,
+                                 account_id: null,
+                                 resource_group_id: null,
+                                 source_crn: null,
+                                 target_crn: null,
+                                 role: null,
+                                 region_binding_id: null,
+                                 state: null,
+                                 credentials: null,
+                                 iam_compatible: null,
+                                 resource_alias_url: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 deleted_at: null,
+                                 created_by: null,
+                                 updated_by: null,
+                                 deleted_by: null)
+```
+
+

data/docs/ResourceBindingPatch.md

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

data/docs/ResourceBindingPost.md

@@ -0,0 +1,25 @@
+# IbmCloudResourceController::ResourceBindingPost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the binding. Must be 180 characters or less and cannot include any special characters other than `(space) - . _ :`. | [optional] 
+**source** | **String** | The short or long ID of resource alias. | 
+**target** | **String** | The CRN of application to bind to in a specific environment, e.g. Dallas YP, CFEE instance | 
+**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::ResourceBindingPost.new(name: my-binding,
+                                 source: 25eba2a9-beef-450b-82cf-f5ad5e36c6dd,
+                                 target: crn:v1:cf:public:cf:us-south:s/0ba4dba0-a120-4a1e-a124-5a249a904b76::cf-application:a1caa40b-2c24-4da8-8267-ac2c1a42ad0c,
+                                 parameters: null,
+                                 role: Writer)
+```
+
+

data/docs/ResourceBindingPostParameters.md

@@ -0,0 +1,17 @@
+# IbmCloudResourceController::ResourceBindingPostParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serviceid_crn** | **String** | An optional platform defined option to reuse an existing IAM serviceId for the role assignment. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceBindingPostParameters.new(serviceid_crn: crn:v1:bluemix:public:iam-identity::a/9fceaa56d1ab84893af6b9eec5ab81bb::serviceid:ServiceId-fe4c29b5-db13-410a-bacc-b5779a03d393)
+```
+
+

data/docs/ResourceBindingsApi.md

@@ -0,0 +1,300 @@
+# IbmCloudResourceController::ResourceBindingsApi
+
+All URIs are relative to *https://resource-controller.cloud.ibm.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_resource_binding**](ResourceBindingsApi.md#create_resource_binding) | **POST** /v2/resource_bindings | Create a new resource binding
+[**delete_resource_binding**](ResourceBindingsApi.md#delete_resource_binding) | **DELETE** /v2/resource_bindings/{id} | Delete a resource binding
+[**get_resource_binding**](ResourceBindingsApi.md#get_resource_binding) | **GET** /v2/resource_bindings/{id} | Get a resource binding
+[**list_resource_bindings**](ResourceBindingsApi.md#list_resource_bindings) | **GET** /v2/resource_bindings | Get a list of all resource bindings
+[**update_resource_binding**](ResourceBindingsApi.md#update_resource_binding) | **PATCH** /v2/resource_bindings/{id} | Update a resource binding
+
+
+
+## create_resource_binding
+
+> ResourceBinding create_resource_binding(resource_binding_post)
+
+Create a new resource binding
+
+Create a new resource binding.
+
+### 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::ResourceBindingsApi.new
+resource_binding_post = IbmCloudResourceController::ResourceBindingPost.new # ResourceBindingPost | 
+
+begin
+  #Create a new resource binding
+  result = api_instance.create_resource_binding(resource_binding_post)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceBindingsApi->create_resource_binding: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resource_binding_post** | [**ResourceBindingPost**](ResourceBindingPost.md)|  | 
+
+### Return type
+
+[**ResourceBinding**](ResourceBinding.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_resource_binding
+
+> delete_resource_binding(id)
+
+Delete a resource binding
+
+Delete a resource binding 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::ResourceBindingsApi.new
+id = 'id_example' # String | The short or long ID of the binding.
+
+begin
+  #Delete a resource binding
+  api_instance.delete_resource_binding(id)
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceBindingsApi->delete_resource_binding: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the binding. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_resource_binding
+
+> ResourceBinding get_resource_binding(id)
+
+Get a resource binding
+
+Retrieve a resource binding 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::ResourceBindingsApi.new
+id = 'id_example' # String | The short or long ID of the binding.
+
+begin
+  #Get a resource binding
+  result = api_instance.get_resource_binding(id)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceBindingsApi->get_resource_binding: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the binding. | 
+
+### Return type
+
+[**ResourceBinding**](ResourceBinding.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_resource_bindings
+
+> ResourceBindingsList list_resource_bindings(opts)
+
+Get a list of all resource bindings
+
+Get a list of all resource bindings.
+
+### 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::ResourceBindingsApi.new
+opts = {
+  guid: 'guid_example', # String | The short ID of the binding.
+  name: 'name_example', # String | The human-readable name of the binding.
+  resource_group_id: 'resource_group_id_example', # String | Short ID of the resource group.
+  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.
+  region_binding_id: 'region_binding_id_example', # String | Short ID of the binding in the specific targeted environment, e.g. service_binding_id in a given IBM Cloud environment.
+  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 bindings
+  result = api_instance.list_resource_bindings(opts)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceBindingsApi->list_resource_bindings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **guid** | **String**| The short ID of the binding. | [optional] 
+ **name** | **String**| The human-readable name of the binding. | [optional] 
+ **resource_group_id** | **String**| Short ID of the resource group. | [optional] 
+ **resource_id** | **String**| The unique ID of the offering (service name). This value is provided by and stored in the global catalog. | [optional] 
+ **region_binding_id** | **String**| Short ID of the binding in the specific targeted environment, e.g. service_binding_id in a given IBM Cloud environment. | [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
+
+[**ResourceBindingsList**](ResourceBindingsList.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_resource_binding
+
+> ResourceBinding update_resource_binding(id, resource_binding_patch)
+
+Update a resource binding
+
+Update a resource binding 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::ResourceBindingsApi.new
+id = 'id_example' # String | The short or long ID of the binding.
+resource_binding_patch = IbmCloudResourceController::ResourceBindingPatch.new # ResourceBindingPatch | 
+
+begin
+  #Update a resource binding
+  result = api_instance.update_resource_binding(id, resource_binding_patch)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceBindingsApi->update_resource_binding: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the binding. | 
+ **resource_binding_patch** | [**ResourceBindingPatch**](ResourceBindingPatch.md)|  | 
+
+### Return type
+
+[**ResourceBinding**](ResourceBinding.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ResourceBindingsList.md

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