pulp_ansible_client 0.16.6 → 0.17.0

data/docs/RemotesRoleApi.md

@@ -1,18 +1,76 @@
 # PulpAnsibleClient::RemotesRoleApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](RemotesRoleApi.md#add_role) | **POST** {ansible_role_remote_href}add_role/ | 
 [**create**](RemotesRoleApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/role/ | Create a role remote
 [**delete**](RemotesRoleApi.md#delete) | **DELETE** {ansible_role_remote_href} | Delete a role remote
 [**list**](RemotesRoleApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/role/ | List role remotes
+[**list_roles**](RemotesRoleApi.md#list_roles) | **GET** {ansible_role_remote_href}list_roles/ | 
+[**my_permissions**](RemotesRoleApi.md#my_permissions) | **GET** {ansible_role_remote_href}my_permissions/ | 
 [**partial_update**](RemotesRoleApi.md#partial_update) | **PATCH** {ansible_role_remote_href} | Update a role remote
 [**read**](RemotesRoleApi.md#read) | **GET** {ansible_role_remote_href} | Inspect a role remote
+[**remove_role**](RemotesRoleApi.md#remove_role) | **POST** {ansible_role_remote_href}remove_role/ | 
 [**update**](RemotesRoleApi.md#update) | **PUT** {ansible_role_remote_href} | Update a role remote
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(ansible_role_remote_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesRoleApi.new
+ansible_role_remote_href = 'ansible_role_remote_href_example' # String | 
+nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(ansible_role_remote_href, nested_role)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesRoleApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_role_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > AnsibleRoleRemoteResponse create(ansible_role_remote)
@@ -206,6 +264,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(ansible_role_remote_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesRoleApi.new
+ansible_role_remote_href = 'ansible_role_remote_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(ansible_role_remote_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesRoleApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_role_remote_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(ansible_role_remote_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesRoleApi.new
+ansible_role_remote_href = 'ansible_role_remote_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(ansible_role_remote_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesRoleApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_role_remote_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
 > AsyncOperationResponse partial_update(ansible_role_remote_href, patchedansible_role_remote)
@@ -320,6 +494,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(ansible_role_remote_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesRoleApi.new
+ansible_role_remote_href = 'ansible_role_remote_href_example' # String | 
+nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(ansible_role_remote_href, nested_role)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesRoleApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_role_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## update
 
 > AsyncOperationResponse update(ansible_role_remote_href, ansible_role_remote)