pulpcore_client 3.19.1 → 3.20.0

data/docs/GroupRoleResponse.md

@@ -7,7 +7,9 @@ Name | Type | Description | Notes
 **pulp_href** | **String** |  | [optional] [readonly] 
 **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
 **role** | **String** |  | 
-**content_object** | **String** | Optional pulp_href of the object the permissions are to be asserted on. | 
+**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on the model-level. | 
+**description** | **String** |  | [optional] [readonly] 
+**permissions** | **Array<String>** |  | [optional] [readonly] 
 
 ## Code Sample
 
@@ -17,7 +19,9 @@ require 'PulpcoreClient'
 instance = PulpcoreClient::GroupRoleResponse.new(pulp_href: null,
                                  pulp_created: null,
                                  role: null,
-                                 content_object: null)
+                                 content_object: null,
+                                 description: null,
+                                 permissions: null)
 ```
 
 

data/docs/GroupsApi.md

@@ -207,7 +207,7 @@ opts = {
   name__iexact: 'name__iexact_example', # String | Filter results where name matches value
   name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
   offset: 56, # Integer | The initial index from which to return the results.
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   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.
 }
@@ -235,7 +235,7 @@ Name | Type | Description  | Notes
  **name__iexact** | **String**| Filter results where name matches value | [optional] 
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [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] 
 

data/docs/GroupsRolesApi.md

@@ -144,7 +144,7 @@ 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.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   role: 'role_example', # String | 
   role__contains: 'role__contains_example', # String | 
   role__icontains: 'role__icontains_example', # String | 
@@ -172,7 +172,7 @@ Name | Type | Description  | Notes
  **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] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **role** | **String**|  | [optional] 
  **role__contains** | **String**|  | [optional] 
  **role__icontains** | **String**|  | [optional] 

data/docs/GroupsUsersApi.md

@@ -142,7 +142,6 @@ 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.
-  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.
 }
@@ -164,7 +163,6 @@ Name | Type | Description  | Notes
  **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] 
 

data/docs/Import.md

@@ -0,0 +1,19 @@
+# PulpcoreClient::Import
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | A URI of the Task that ran the Import. | 
+**params** | [**Object**](.md) | Any parameters that were used to create the import. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Import.new(task: null,
+                                 params: null)
+```
+
+

data/docs/Importer.md

@@ -0,0 +1,17 @@
+# PulpcoreClient::Importer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the Importer. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Importer.new(name: null)
+```
+
+

data/docs/ImporterResponse.md

@@ -0,0 +1,21 @@
+# PulpcoreClient::ImporterResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | Unique name of the Importer. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::ImporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null)
+```
+
+

data/docs/ImportersApi.md

@@ -0,0 +1,361 @@
+# PulpcoreClient::ImportersApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ImportersApi.md#create) | **POST** /pulp/api/v3/importers/ | Create an importer
+[**delete**](ImportersApi.md#delete) | **DELETE** {importer_href} | Delete an importer
+[**list**](ImportersApi.md#list) | **GET** /pulp/api/v3/importers/ | List importers
+[**partial_update**](ImportersApi.md#partial_update) | **PATCH** {importer_href} | Update an importer
+[**read**](ImportersApi.md#read) | **GET** {importer_href} | Inspect an importer
+[**update**](ImportersApi.md#update) | **PUT** {importer_href} | Update an importer
+
+
+
+## create
+
+> ImporterResponse create(importer)
+
+Create an importer
+
+ViewSet for Importers.
+
+### 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::ImportersApi.new
+importer = PulpcoreClient::Importer.new # Importer | 
+
+begin
+  #Create an importer
+  result = api_instance.create(importer)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer** | [**Importer**](Importer.md)|  | 
+
+### Return type
+
+[**ImporterResponse**](ImporterResponse.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(importer_href)
+
+Delete an importer
+
+ViewSet for Importers.
+
+### 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::ImportersApi.new
+importer_href = 'importer_href_example' # String | 
+
+begin
+  #Delete an importer
+  api_instance.delete(importer_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> PaginatedImporterResponseList list(opts)
+
+List importers
+
+ViewSet for Importers.
+
+### 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::ImportersApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  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'], # Array<String> | Ordering
+  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 importers
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**|  | [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** | [**Array&lt;String&gt;**](String.md)| Ordering | [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
+
+[**PaginatedImporterResponseList**](PaginatedImporterResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> ImporterResponse partial_update(importer_href, patched_importer)
+
+Update an importer
+
+ViewSet for Importers.
+
+### 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::ImportersApi.new
+importer_href = 'importer_href_example' # String | 
+patched_importer = PulpcoreClient::PatchedImporter.new # PatchedImporter | 
+
+begin
+  #Update an importer
+  result = api_instance.partial_update(importer_href, patched_importer)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer_href** | **String**|  | 
+ **patched_importer** | [**PatchedImporter**](PatchedImporter.md)|  | 
+
+### Return type
+
+[**ImporterResponse**](ImporterResponse.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
+
+> ImporterResponse read(importer_href, opts)
+
+Inspect an importer
+
+ViewSet for Importers.
+
+### 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::ImportersApi.new
+importer_href = 'importer_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 an importer
+  result = api_instance.read(importer_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer_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
+
+[**ImporterResponse**](ImporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> ImporterResponse update(importer_href, importer)
+
+Update an importer
+
+ViewSet for Importers.
+
+### 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::ImportersApi.new
+importer_href = 'importer_href_example' # String | 
+importer = PulpcoreClient::Importer.new # Importer | 
+
+begin
+  #Update an importer
+  result = api_instance.update(importer_href, importer)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer_href** | **String**|  | 
+ **importer** | [**Importer**](Importer.md)|  | 
+
+### Return type
+
+[**ImporterResponse**](ImporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+