pulpcore_client 3.5.0 → 3.6.0

data/docs/GroupsApi.md

@@ -0,0 +1,351 @@
+# PulpcoreClient::GroupsApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsApi.md#create) | **POST** /pulp/api/v3/groups/ | Create a group
+[**delete**](GroupsApi.md#delete) | **DELETE** {auth_group_href} | Delete a group
+[**list**](GroupsApi.md#list) | **GET** /pulp/api/v3/groups/ | List groups
+[**partial_update**](GroupsApi.md#partial_update) | **PATCH** {auth_group_href} | Update a group
+[**read**](GroupsApi.md#read) | **GET** {auth_group_href} | Inspect a group
+[**update**](GroupsApi.md#update) | **PUT** {auth_group_href} | Update a group
+
+
+
+## create
+
+> GroupResponse create(group)
+
+Create a group
+
+ViewSet for Group.  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::GroupsApi.new
+group = PulpcoreClient::Group.new # Group | 
+
+begin
+  #Create a group
+  result = api_instance.create(group)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group** | [**Group**](Group.md)|  | 
+
+### Return type
+
+[**GroupResponse**](GroupResponse.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(auth_group_href)
+
+Delete a group
+
+ViewSet for Group.  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::GroupsApi.new
+auth_group_href = 'auth_group_href_example' # String | 
+
+begin
+  #Delete a group
+  api_instance.delete(auth_group_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_group_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2004 list(opts)
+
+List groups
+
+ViewSet for Group.  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::GroupsApi.new
+opts = {
+  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.
+  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 groups
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **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
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> GroupResponse partial_update(auth_group_href, patched_group)
+
+Update a group
+
+ViewSet for Group.  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::GroupsApi.new
+auth_group_href = 'auth_group_href_example' # String | 
+patched_group = PulpcoreClient::PatchedGroup.new # PatchedGroup | 
+
+begin
+  #Update a group
+  result = api_instance.partial_update(auth_group_href, patched_group)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_group_href** | **String**|  | 
+ **patched_group** | [**PatchedGroup**](PatchedGroup.md)|  | 
+
+### Return type
+
+[**GroupResponse**](GroupResponse.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
+
+> GroupResponse read(auth_group_href, opts)
+
+Inspect a group
+
+ViewSet for Group.  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::GroupsApi.new
+auth_group_href = 'auth_group_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
+  result = api_instance.read(auth_group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_group_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
+
+[**GroupResponse**](GroupResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> GroupResponse update(auth_group_href, group)
+
+Update a group
+
+ViewSet for Group.  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::GroupsApi.new
+auth_group_href = 'auth_group_href_example' # String | 
+group = PulpcoreClient::Group.new # Group | 
+
+begin
+  #Update a group
+  result = api_instance.update(auth_group_href, group)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_group_href** | **String**|  | 
+ **group** | [**Group**](Group.md)|  | 
+
+### Return type
+
+[**GroupResponse**](GroupResponse.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/GroupsModelPermissionsApi.md

@@ -0,0 +1,128 @@
+# PulpcoreClient::GroupsModelPermissionsApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsModelPermissionsApi.md#create) | **POST** {auth_auth_groups_permission_href}model_permissions/ | Create a permission
+[**list**](GroupsModelPermissionsApi.md#list) | **GET** {auth_group_href}model_permissions/ | List permissions
+
+
+
+## create
+
+> PermissionResponse create(auth_auth_groups_permission_href)
+
+Create a permission
+
+Add a model permission to a group.
+
+### 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::GroupsModelPermissionsApi.new
+auth_auth_groups_permission_href = 'auth_auth_groups_permission_href_example' # String | 
+
+begin
+  #Create a permission
+  result = api_instance.create(auth_auth_groups_permission_href)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsModelPermissionsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_auth_groups_permission_href** | **String**|  | 
+
+### Return type
+
+[**PermissionResponse**](PermissionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2005 list(auth_group_href, opts)
+
+List permissions
+
+List group permissions.
+
+### 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::GroupsModelPermissionsApi.new
+auth_group_href = 'auth_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.
+  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 permissions
+  result = api_instance.list(auth_group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsModelPermissionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_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] 
+ **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
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GroupsObjectPermissionsApi.md

@@ -0,0 +1,247 @@
+# PulpcoreClient::GroupsObjectPermissionsApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsObjectPermissionsApi.md#create) | **POST** {auth_auth_groups_permission_href}object_permissions/ | Create a permission
+[**delete**](GroupsObjectPermissionsApi.md#delete) | **DELETE** {auth_auth_groups_permission_href} | Delete a permission
+[**list**](GroupsObjectPermissionsApi.md#list) | **GET** {auth_group_href}object_permissions/ | List permissions
+[**read**](GroupsObjectPermissionsApi.md#read) | **GET** {auth_auth_groups_permission_href} | Inspect a permission
+
+
+
+## create
+
+> PermissionResponse create(auth_auth_groups_permission_href)
+
+Create a permission
+
+Add an object permission to a group.
+
+### 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::GroupsObjectPermissionsApi.new
+auth_auth_groups_permission_href = 'auth_auth_groups_permission_href_example' # String | 
+
+begin
+  #Create a permission
+  result = api_instance.create(auth_auth_groups_permission_href)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsObjectPermissionsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_auth_groups_permission_href** | **String**|  | 
+
+### Return type
+
+[**PermissionResponse**](PermissionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete
+
+> delete(auth_auth_groups_permission_href, opts)
+
+Delete a permission
+
+Remove an object permission from a group.
+
+### 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::GroupsObjectPermissionsApi.new
+auth_auth_groups_permission_href = 'auth_auth_groups_permission_href_example' # String | 
+opts = {
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
+
+begin
+  #Delete a permission
+  api_instance.delete(auth_auth_groups_permission_href, opts)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsObjectPermissionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_auth_groups_permission_href** | **String**|  | 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2005 list(auth_group_href, opts)
+
+List permissions
+
+List group object permissions.
+
+### 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::GroupsObjectPermissionsApi.new
+auth_group_href = 'auth_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.
+  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 permissions
+  result = api_instance.list(auth_group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsObjectPermissionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_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] 
+ **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
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> PermissionResponse read(auth_auth_groups_permission_href, opts)
+
+Inspect a permission
+
+Retrieve a model permission from a group.
+
+### 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::GroupsObjectPermissionsApi.new
+auth_auth_groups_permission_href = 'auth_auth_groups_permission_href_example' # String | 
+opts = {
+  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
+  #Inspect a permission
+  result = api_instance.read(auth_auth_groups_permission_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsObjectPermissionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_auth_groups_permission_href** | **String**|  | 
+ **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
+
+[**PermissionResponse**](PermissionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+