pulpcore_client 3.16.24 → 3.17.0

data/docs/RolesApi.md

@@ -0,0 +1,363 @@
+# PulpcoreClient::RolesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RolesApi.md#create) | **POST** /pulp/api/v3/roles/ | Create a role
+[**delete**](RolesApi.md#delete) | **DELETE** {role_href} | Delete a role
+[**list**](RolesApi.md#list) | **GET** /pulp/api/v3/roles/ | List roles
+[**partial_update**](RolesApi.md#partial_update) | **PATCH** {role_href} | Update a role
+[**read**](RolesApi.md#read) | **GET** {role_href} | Inspect a role
+[**update**](RolesApi.md#update) | **PUT** {role_href} | Update a role
+
+
+
+## create
+
+> RoleResponse create(role)
+
+Create a role
+
+ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::RolesApi.new
+role = PulpcoreClient::Role.new # Role | 
+
+begin
+  #Create a role
+  result = api_instance.create(role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling RolesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role** | [**Role**](Role.md)|  | 
+
+### Return type
+
+[**RoleResponse**](RoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## delete
+
+> delete(role_href)
+
+Delete a role
+
+ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::RolesApi.new
+role_href = 'role_href_example' # String | 
+
+begin
+  #Delete a role
+  api_instance.delete(role_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling RolesApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> PaginatedRoleResponseList list(opts)
+
+List roles
+
+ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::RolesApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  locked: true, # Boolean | Filter results where locked matches value
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List roles
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling RolesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **locked** | **Boolean**| Filter results where locked matches value | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedRoleResponseList**](PaginatedRoleResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> RoleResponse partial_update(role_href, patched_role)
+
+Update a role
+
+ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::RolesApi.new
+role_href = 'role_href_example' # String | 
+patched_role = PulpcoreClient::PatchedRole.new # PatchedRole | 
+
+begin
+  #Update a role
+  result = api_instance.partial_update(role_href, patched_role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling RolesApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_href** | **String**|  | 
+ **patched_role** | [**PatchedRole**](PatchedRole.md)|  | 
+
+### Return type
+
+[**RoleResponse**](RoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## read
+
+> RoleResponse read(role_href, opts)
+
+Inspect a role
+
+ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::RolesApi.new
+role_href = 'role_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a role
+  result = api_instance.read(role_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling RolesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**RoleResponse**](RoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> RoleResponse update(role_href, role)
+
+Update a role
+
+ViewSet for Role.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::RolesApi.new
+role_href = 'role_href_example' # String | 
+role = PulpcoreClient::Role.new # Role | 
+
+begin
+  #Update a role
+  result = api_instance.update(role_href, role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling RolesApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_href** | **String**|  | 
+ **role** | [**Role**](Role.md)|  | 
+
+### Return type
+
+[**RoleResponse**](RoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/StatesEnum.md

@@ -0,0 +1,16 @@
+# PulpcoreClient::StatesEnum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::StatesEnum.new()
+```
+
+

data/docs/TasksApi.md

@@ -4,13 +4,72 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](TasksApi.md#add_role) | **POST** {task_href}add_role/ | 
 [**delete**](TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
 [**list**](TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
+[**list_roles**](TasksApi.md#list_roles) | **GET** {task_href}list_roles/ | 
+[**my_permissions**](TasksApi.md#my_permissions) | **GET** {task_href}my_permissions/ | 
+[**purge**](TasksApi.md#purge) | **POST** /pulp/api/v3/tasks/purge/ | Purge Completed Tasks
 [**read**](TasksApi.md#read) | **GET** {task_href} | Inspect a task
+[**remove_role**](TasksApi.md#remove_role) | **POST** {task_href}remove_role/ | 
 [**tasks_cancel**](TasksApi.md#tasks_cancel) | **PATCH** {task_href} | Cancel a task
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(task_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TasksApi.new
+task_href = 'task_href_example' # String | 
+nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(task_href, nested_role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TasksApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_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
+
+
 ## delete
 
 > delete(task_href)
@@ -176,6 +235,175 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(task_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TasksApi.new
+task_href = 'task_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(task_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TasksApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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(task_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TasksApi.new
+task_href = 'task_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(task_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TasksApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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
+
+
+## purge
+
+> AsyncOperationResponse purge(purge)
+
+Purge Completed Tasks
+
+Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp (tech-preview, may change in the future).
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TasksApi.new
+purge = PulpcoreClient::Purge.new # Purge | 
+
+begin
+  #Purge Completed Tasks
+  result = api_instance.purge(purge)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TasksApi->purge: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **purge** | [**Purge**](Purge.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## read
 
 > TaskResponse read(task_href, opts)
@@ -235,6 +463,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(task_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TasksApi.new
+task_href = 'task_href_example' # String | 
+nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(task_href, nested_role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TasksApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_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
+
+
 ## tasks_cancel
 
 > TaskResponse tasks_cancel(task_href, patched_task_cancel)

data/docs/User.md

@@ -0,0 +1,29 @@
+# PulpcoreClient::User
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | 
+**password** | **String** | Users password. Set to ``null`` to disable password authentication. | [optional] 
+**first_name** | **String** | First name | [optional] 
+**last_name** | **String** | Last name | [optional] 
+**email** | **String** | Email address | [optional] 
+**is_staff** | **Boolean** | Designates whether the user can log into this admin site. | [optional] [default to false]
+**is_active** | **Boolean** | Designates whether this user should be treated as active. | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::User.new(username: null,
+                                 password: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null)
+```
+
+