pulp_maven_client 0.24.0 → 0.25.0

data/docs/RemotesMavenApi.md

@@ -4,16 +4,96 @@ All URIs are relative to *http://localhost:24817*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**add_role**](RemotesMavenApi.md#add_role) | **POST** {maven_maven_remote_href}add_role/ | Add a role |
 | [**create**](RemotesMavenApi.md#create) | **POST** /pulp/api/v3/remotes/maven/maven/ | Create a maven remote |
 | [**delete**](RemotesMavenApi.md#delete) | **DELETE** {maven_maven_remote_href} | Delete a maven remote |
 | [**list**](RemotesMavenApi.md#list) | **GET** /pulp/api/v3/remotes/maven/maven/ | List maven remotes |
+| [**list_roles**](RemotesMavenApi.md#list_roles) | **GET** {maven_maven_remote_href}list_roles/ | List roles |
+| [**my_permissions**](RemotesMavenApi.md#my_permissions) | **GET** {maven_maven_remote_href}my_permissions/ | List user permissions |
 | [**partial_update**](RemotesMavenApi.md#partial_update) | **PATCH** {maven_maven_remote_href} | Update a maven remote |
 | [**read**](RemotesMavenApi.md#read) | **GET** {maven_maven_remote_href} | Inspect a maven remote |
+| [**remove_role**](RemotesMavenApi.md#remove_role) | **POST** {maven_maven_remote_href}remove_role/ | Remove a role |
 | [**set_label**](RemotesMavenApi.md#set_label) | **POST** {maven_maven_remote_href}set_label/ | Set a label |
 | [**unset_label**](RemotesMavenApi.md#unset_label) | **POST** {maven_maven_remote_href}unset_label/ | Unset a label |
 | [**update**](RemotesMavenApi.md#update) | **PUT** {maven_maven_remote_href} | Update a maven remote |
 
 
+## add_role
+
+> <NestedRoleResponse> add_role(maven_maven_remote_href, nested_role, opts)
+
+Add a role
+
+Add a role for this object to users/groups.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RemotesMavenApi.new
+maven_maven_remote_href = 'maven_maven_remote_href_example' # String | 
+nested_role = PulpMavenClient::NestedRole.new({role: 'role_example'}) # NestedRole | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
+
+begin
+  # Add a role
+  result = api_instance.add_role(maven_maven_remote_href, nested_role, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->add_role: #{e}"
+end
+```
+
+#### Using the add_role_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(maven_maven_remote_href, nested_role, opts)
+
+```ruby
+begin
+  # Add a role
+  data, status_code, headers = api_instance.add_role_with_http_info(maven_maven_remote_href, nested_role, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NestedRoleResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->add_role_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_remote_href** | **String** |  |  |
+| **nested_role** | [**NestedRole**](NestedRole.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+
+### 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
 
 > <MavenMavenRemoteResponse> create(maven_maven_remote, opts)
@@ -286,6 +366,162 @@ end
 - **Accept**: application/json
 
 
+## list_roles
+
+> <ObjectRolesResponse> list_roles(maven_maven_remote_href, opts)
+
+List roles
+
+List roles assigned to this object.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RemotesMavenApi.new
+maven_maven_remote_href = 'maven_maven_remote_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  # List roles
+  result = api_instance.list_roles(maven_maven_remote_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->list_roles: #{e}"
+end
+```
+
+#### Using the list_roles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(maven_maven_remote_href, opts)
+
+```ruby
+begin
+  # List roles
+  data, status_code, headers = api_instance.list_roles_with_http_info(maven_maven_remote_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ObjectRolesResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->list_roles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_remote_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+| **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(maven_maven_remote_href, opts)
+
+List user permissions
+
+List permissions available to the current user on this object.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RemotesMavenApi.new
+maven_maven_remote_href = 'maven_maven_remote_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  # List user permissions
+  result = api_instance.my_permissions(maven_maven_remote_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->my_permissions: #{e}"
+end
+```
+
+#### Using the my_permissions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(maven_maven_remote_href, opts)
+
+```ruby
+begin
+  # List user permissions
+  data, status_code, headers = api_instance.my_permissions_with_http_info(maven_maven_remote_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MyPermissionsResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->my_permissions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_remote_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+| **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
 
 > <MavenMavenRemoteResponse> partial_update(maven_maven_remote_href, patchedmaven_maven_remote, opts)
@@ -440,6 +676,82 @@ end
 - **Accept**: application/json
 
 
+## remove_role
+
+> <NestedRoleResponse> remove_role(maven_maven_remote_href, nested_role, opts)
+
+Remove a role
+
+Remove a role for this object from users/groups.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RemotesMavenApi.new
+maven_maven_remote_href = 'maven_maven_remote_href_example' # String | 
+nested_role = PulpMavenClient::NestedRole.new({role: 'role_example'}) # NestedRole | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
+
+begin
+  # Remove a role
+  result = api_instance.remove_role(maven_maven_remote_href, nested_role, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->remove_role: #{e}"
+end
+```
+
+#### Using the remove_role_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(maven_maven_remote_href, nested_role, opts)
+
+```ruby
+begin
+  # Remove a role
+  data, status_code, headers = api_instance.remove_role_with_http_info(maven_maven_remote_href, nested_role, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NestedRoleResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling RemotesMavenApi->remove_role_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_remote_href** | **String** |  |  |
+| **nested_role** | [**NestedRole**](NestedRole.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+
+### 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
+
+
 ## set_label
 
 > <SetLabelResponse> set_label(maven_maven_remote_href, set_label, opts)