pulp_maven_client 0.24.0 → 0.25.0

data/docs/DistributionsMavenApi.md

@@ -4,16 +4,96 @@ All URIs are relative to *http://localhost:24817*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**add_role**](DistributionsMavenApi.md#add_role) | **POST** {maven_maven_distribution_href}add_role/ | Add a role |
 | [**create**](DistributionsMavenApi.md#create) | **POST** /pulp/api/v3/distributions/maven/maven/ | Create a maven distribution |
 | [**delete**](DistributionsMavenApi.md#delete) | **DELETE** {maven_maven_distribution_href} | Delete a maven distribution |
 | [**list**](DistributionsMavenApi.md#list) | **GET** /pulp/api/v3/distributions/maven/maven/ | List maven distributions |
+| [**list_roles**](DistributionsMavenApi.md#list_roles) | **GET** {maven_maven_distribution_href}list_roles/ | List roles |
+| [**my_permissions**](DistributionsMavenApi.md#my_permissions) | **GET** {maven_maven_distribution_href}my_permissions/ | List user permissions |
 | [**partial_update**](DistributionsMavenApi.md#partial_update) | **PATCH** {maven_maven_distribution_href} | Update a maven distribution |
 | [**read**](DistributionsMavenApi.md#read) | **GET** {maven_maven_distribution_href} | Inspect a maven distribution |
+| [**remove_role**](DistributionsMavenApi.md#remove_role) | **POST** {maven_maven_distribution_href}remove_role/ | Remove a role |
 | [**set_label**](DistributionsMavenApi.md#set_label) | **POST** {maven_maven_distribution_href}set_label/ | Set a label |
 | [**unset_label**](DistributionsMavenApi.md#unset_label) | **POST** {maven_maven_distribution_href}unset_label/ | Unset a label |
 | [**update**](DistributionsMavenApi.md#update) | **PUT** {maven_maven_distribution_href} | Update a maven distribution |
 
 
+## add_role
+
+> <NestedRoleResponse> add_role(maven_maven_distribution_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::DistributionsMavenApi.new
+maven_maven_distribution_href = 'maven_maven_distribution_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_distribution_href, nested_role, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->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_distribution_href, nested_role, opts)
+
+```ruby
+begin
+  # Add a role
+  data, status_code, headers = api_instance.add_role_with_http_info(maven_maven_distribution_href, nested_role, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NestedRoleResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->add_role_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_distribution_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
 
 > <AsyncOperationResponse> create(maven_maven_distribution, opts)
@@ -288,6 +368,162 @@ end
 - **Accept**: application/json
 
 
+## list_roles
+
+> <ObjectRolesResponse> list_roles(maven_maven_distribution_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::DistributionsMavenApi.new
+maven_maven_distribution_href = 'maven_maven_distribution_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_distribution_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->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_distribution_href, opts)
+
+```ruby
+begin
+  # List roles
+  data, status_code, headers = api_instance.list_roles_with_http_info(maven_maven_distribution_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ObjectRolesResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->list_roles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_distribution_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_distribution_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::DistributionsMavenApi.new
+maven_maven_distribution_href = 'maven_maven_distribution_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_distribution_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->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_distribution_href, opts)
+
+```ruby
+begin
+  # List user permissions
+  data, status_code, headers = api_instance.my_permissions_with_http_info(maven_maven_distribution_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MyPermissionsResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->my_permissions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_distribution_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
 
 > <MavenMavenDistributionResponse> partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution, opts)
@@ -442,6 +678,82 @@ end
 - **Accept**: application/json
 
 
+## remove_role
+
+> <NestedRoleResponse> remove_role(maven_maven_distribution_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::DistributionsMavenApi.new
+maven_maven_distribution_href = 'maven_maven_distribution_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_distribution_href, nested_role, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->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_distribution_href, nested_role, opts)
+
+```ruby
+begin
+  # Remove a role
+  data, status_code, headers = api_instance.remove_role_with_http_info(maven_maven_distribution_href, nested_role, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NestedRoleResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling DistributionsMavenApi->remove_role_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_distribution_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_distribution_href, set_label, opts)

data/docs/MavenMavenPackageResponse.md

@@ -0,0 +1,48 @@
+# PulpMavenClient::MavenMavenPackageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **pulp_labels** | **Hash<String, String>** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
+| **vuln_report** | **String** |  | [optional][readonly] |
+| **group_id** | **String** | Group Id of the package. | [optional][readonly] |
+| **artifact_id** | **String** | Artifact Id of the package. | [optional][readonly] |
+| **version** | **String** | Version of the package. | [optional][readonly] |
+| **name** | **String** | Human-readable name from the POM. | [optional][readonly] |
+| **description** | **String** | Description from the POM. | [optional][readonly] |
+| **packaging** | **String** | Packaging type (jar, war, pom, etc). | [optional][readonly] |
+| **url** | **String** | Project URL from the POM. | [optional][readonly] |
+| **licenses** | **Object** |  | [optional] |
+| **dependencies** | **Object** |  | [optional] |
+| **scm_url** | **String** | Source control URL from the POM. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pulp_maven_client'
+
+instance = PulpMavenClient::MavenMavenPackageResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  pulp_labels: null,
+  vuln_report: null,
+  group_id: null,
+  artifact_id: null,
+  version: null,
+  name: null,
+  description: null,
+  packaging: null,
+  url: null,
+  licenses: null,
+  dependencies: null,
+  scm_url: null
+)
+```
+

data/docs/MyPermissionsResponse.md

@@ -0,0 +1,18 @@
+# PulpMavenClient::MyPermissionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permissions** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'pulp_maven_client'
+
+instance = PulpMavenClient::MyPermissionsResponse.new(
+  permissions: null
+)
+```
+

data/docs/NestedRole.md

@@ -0,0 +1,22 @@
+# PulpMavenClient::NestedRole
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | **Array<String>** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **role** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pulp_maven_client'
+
+instance = PulpMavenClient::NestedRole.new(
+  users: null,
+  groups: null,
+  role: null
+)
+```
+

data/docs/NestedRoleResponse.md

@@ -0,0 +1,22 @@
+# PulpMavenClient::NestedRoleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | **Array<String>** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **role** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pulp_maven_client'
+
+instance = PulpMavenClient::NestedRoleResponse.new(
+  users: null,
+  groups: null,
+  role: null
+)
+```
+

data/docs/ObjectRolesResponse.md

@@ -0,0 +1,18 @@
+# PulpMavenClient::ObjectRolesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'pulp_maven_client'
+
+instance = PulpMavenClient::ObjectRolesResponse.new(
+  roles: null
+)
+```
+

data/docs/PaginatedmavenMavenPackageResponseList.md

@@ -0,0 +1,24 @@
+# PulpMavenClient::PaginatedmavenMavenPackageResponseList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<MavenMavenPackageResponse>**](MavenMavenPackageResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'pulp_maven_client'
+
+instance = PulpMavenClient::PaginatedmavenMavenPackageResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
+```
+