pulpcore_client 3.16.24 → 3.17.0

data/docs/GroupsRolesApi.md

@@ -0,0 +1,255 @@
+# PulpcoreClient::GroupsRolesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsRolesApi.md#create) | **POST** {group_href}roles/ | Create a group role
+[**delete**](GroupsRolesApi.md#delete) | **DELETE** {groups_group_role_href} | Delete a group role
+[**list**](GroupsRolesApi.md#list) | **GET** {group_href}roles/ | List group roles
+[**read**](GroupsRolesApi.md#read) | **GET** {groups_group_role_href} | Inspect a group role
+
+
+
+## create
+
+> GroupRoleResponse create(group_href, group_role)
+
+Create a group role
+
+ViewSet for GroupRole.  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::GroupsRolesApi.new
+group_href = 'group_href_example' # String | 
+group_role = PulpcoreClient::GroupRole.new # GroupRole | 
+
+begin
+  #Create a group role
+  result = api_instance.create(group_href, group_role)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **group_role** | [**GroupRole**](GroupRole.md)|  | 
+
+### Return type
+
+[**GroupRoleResponse**](GroupRoleResponse.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(groups_group_role_href)
+
+Delete a group role
+
+ViewSet for GroupRole.  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::GroupsRolesApi.new
+groups_group_role_href = 'groups_group_role_href_example' # String | 
+
+begin
+  #Delete a group role
+  api_instance.delete(groups_group_role_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **groups_group_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
+
+> PaginatedGroupRoleResponseList list(group_href, opts)
+
+List group roles
+
+ViewSet for GroupRole.  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::GroupsRolesApi.new
+group_href = 'group_href_example' # String | 
+opts = {
+  content_object: 'content_object_example', # String | content_object
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  role: 'role_example', # String | 
+  role__contains: 'role__contains_example', # String | 
+  role__icontains: 'role__icontains_example', # String | 
+  role__in: ['role__in_example'], # Array<String> | Multiple values may be separated by commas.
+  role__startswith: 'role__startswith_example', # String | 
+  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 group roles
+  result = api_instance.list(group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **content_object** | **String**| content_object | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **role** | **String**|  | [optional] 
+ **role__contains** | **String**|  | [optional] 
+ **role__icontains** | **String**|  | [optional] 
+ **role__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **role__startswith** | **String**|  | [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
+
+[**PaginatedGroupRoleResponseList**](PaginatedGroupRoleResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> GroupRoleResponse read(groups_group_role_href, opts)
+
+Inspect a group role
+
+ViewSet for GroupRole.  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::GroupsRolesApi.new
+groups_group_role_href = 'groups_group_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 group role
+  result = api_instance.read(groups_group_role_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **groups_group_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
+
+[**GroupRoleResponse**](GroupRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GroupsUsersApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](GroupsUsersApi.md#create) | **POST** {auth_group_href}users/ | Create an user
-[**delete**](GroupsUsersApi.md#delete) | **DELETE** {auth_groups_user_href} | Delete an user
-[**list**](GroupsUsersApi.md#list) | **GET** {auth_group_href}users/ | List users
+[**create**](GroupsUsersApi.md#create) | **POST** {group_href}users/ | Create an user
+[**delete**](GroupsUsersApi.md#delete) | **DELETE** {groups_user_href} | Delete an user
+[**list**](GroupsUsersApi.md#list) | **GET** {group_href}users/ | List users
 
 
 
 ## create
 
-> GroupUserResponse create(auth_group_href, group_user)
+> GroupUserResponse create(group_href, group_user)
 
 Create an user
 
@@ -31,12 +31,12 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsUsersApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 group_user = PulpcoreClient::GroupUser.new # GroupUser | 
 
 begin
   #Create an user
-  result = api_instance.create(auth_group_href, group_user)
+  result = api_instance.create(group_href, group_user)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsUsersApi->create: #{e}"
@@ -48,7 +48,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **group_user** | [**GroupUser**](GroupUser.md)|  | 
 
 ### Return type
@@ -67,7 +67,7 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> delete(auth_groups_user_href)
+> delete(groups_user_href)
 
 Delete an user
 
@@ -86,11 +86,11 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsUsersApi.new
-auth_groups_user_href = 'auth_groups_user_href_example' # String | 
+groups_user_href = 'groups_user_href_example' # String | 
 
 begin
   #Delete an user
-  api_instance.delete(auth_groups_user_href)
+  api_instance.delete(groups_user_href)
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsUsersApi->delete: #{e}"
 end
@@ -101,7 +101,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_groups_user_href** | **String**|  | 
+ **groups_user_href** | **String**|  | 
 
 ### Return type
 
@@ -119,7 +119,7 @@ nil (empty response body)
 
 ## list
 
-> PaginatedGroupUserResponseList list(auth_group_href, opts)
+> PaginatedGroupUserResponseList list(group_href, opts)
 
 List users
 
@@ -138,7 +138,7 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::GroupsUsersApi.new
-auth_group_href = 'auth_group_href_example' # String | 
+group_href = 'group_href_example' # String | 
 opts = {
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
@@ -149,7 +149,7 @@ opts = {
 
 begin
   #List users
-  result = api_instance.list(auth_group_href, opts)
+  result = api_instance.list(group_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling GroupsUsersApi->list: #{e}"
@@ -161,7 +161,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **auth_group_href** | **String**|  | 
+ **group_href** | **String**|  | 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
  **ordering** | **String**| Which field to use when ordering the results. | [optional] 

data/docs/MyPermissionsResponse.md

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

data/docs/NestedRole.md

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

data/docs/NestedRoleResponse.md

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

data/docs/ObjectRolesResponse.md

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

data/docs/PaginatedGroupRoleResponseList.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PaginatedGroupRoleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupRoleResponse>**](GroupRoleResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PaginatedGroupRoleResponseList.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)
+```
+
+

data/docs/PaginatedRoleResponseList.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PaginatedRoleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RoleResponse>**](RoleResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PaginatedRoleResponseList.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)
+```
+
+

data/docs/PaginatedUserRoleResponseList.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PaginatedUserRoleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<UserRoleResponse>**](UserRoleResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PaginatedUserRoleResponseList.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)
+```
+
+

data/docs/PatchedAccessPolicy.md

@@ -4,7 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects. | [optional] 
+**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead. | [optional] 
+**creation_hooks** | **Array<Object>** | List of callables that may associate user roles for new objects. | [optional] 
 **statements** | **Array<Object>** | List of policy statements defining the policy. | [optional] 
 
 ## Code Sample
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
 require 'PulpcoreClient'
 
 instance = PulpcoreClient::PatchedAccessPolicy.new(permissions_assignment: null,
+                                 creation_hooks: null,
                                  statements: null)
 ```
 

data/docs/PatchedRole.md

@@ -0,0 +1,21 @@
+# PulpcoreClient::PatchedRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this role. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**permissions** | **Array<String>** | List of permissions defining the role. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PatchedRole.new(name: null,
+                                 description: null,
+                                 permissions: null)
+```
+
+

data/docs/PatchedUser.md

@@ -0,0 +1,29 @@
+# PulpcoreClient::PatchedUser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | [optional] 
+**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::PatchedUser.new(username: null,
+                                 password: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null)
+```
+
+

data/docs/PermissionResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **pulp_href** | **String** |  | [optional] [readonly] 
 **id** | **Integer** |  | [optional] [readonly] 
 **permission** | **String** |  | [optional] [readonly] 
-**obj** | **String** | Content object. | [optional] [readonly] 
+**obj** | **String** | pulp_href of the object the permission is to be asserted on. | [optional] [readonly] 
 
 ## Code Sample
 

data/docs/Purge.md

@@ -0,0 +1,19 @@
+# PulpcoreClient::Purge
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**finished_before** | **DateTime** | Purge tasks completed earlier than this timestamp. Format '%Y-%m-%d[T%H:%M:%S]' | [optional] 
+**states** | [**Array<StatesEnum>**](StatesEnum.md) | List of task-states to be purged. Only 'final' states are allowed. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Purge.new(finished_before: null,
+                                 states: null)
+```
+
+

data/docs/Role.md

@@ -0,0 +1,21 @@
+# PulpcoreClient::Role
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this role. | 
+**description** | **String** | An optional description. | [optional] 
+**permissions** | **Array<String>** | List of permissions defining the role. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Role.new(name: null,
+                                 description: null,
+                                 permissions: null)
+```
+
+

data/docs/RoleResponse.md

@@ -0,0 +1,27 @@
+# PulpcoreClient::RoleResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | The name of this role. | 
+**description** | **String** | An optional description. | [optional] 
+**permissions** | **Array<String>** | List of permissions defining the role. | 
+**locked** | **Boolean** | True if the role is system managed. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::RoleResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 description: null,
+                                 permissions: null,
+                                 locked: null)
+```
+
+