pulpcore_client 3.5.0 → 3.6.0

data/docs/GroupsUsersApi.md

@@ -0,0 +1,183 @@
+# PulpcoreClient::GroupsUsersApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsUsersApi.md#create) | **POST** {auth_auth_groups_user_href}users/ | Create an user
+[**delete**](GroupsUsersApi.md#delete) | **DELETE** {auth_auth_groups_user_href} | Delete an user
+[**list**](GroupsUsersApi.md#list) | **GET** {auth_group_href}users/ | List users
+
+
+
+## create
+
+> GroupUserResponse create(auth_auth_groups_user_href, group_user)
+
+Create an user
+
+Add a user 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::GroupsUsersApi.new
+auth_auth_groups_user_href = 'auth_auth_groups_user_href_example' # String | 
+group_user = PulpcoreClient::GroupUser.new # GroupUser | 
+
+begin
+  #Create an user
+  result = api_instance.create(auth_auth_groups_user_href, group_user)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsUsersApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_auth_groups_user_href** | **String**|  | 
+ **group_user** | [**GroupUser**](GroupUser.md)|  | 
+
+### Return type
+
+[**GroupUserResponse**](GroupUserResponse.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_auth_groups_user_href)
+
+Delete an user
+
+Remove a user 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::GroupsUsersApi.new
+auth_auth_groups_user_href = 'auth_auth_groups_user_href_example' # String | 
+
+begin
+  #Delete an user
+  api_instance.delete(auth_auth_groups_user_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsUsersApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_auth_groups_user_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2006 list(auth_group_href, opts)
+
+List users
+
+List group users.
+
+### 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::GroupsUsersApi.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 users
+  result = api_instance.list(auth_group_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling GroupsUsersApi->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
+
+[**InlineResponse2006**](InlineResponse2006.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/{Import.md → ImportResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::Import
+# PulpcoreClient::ImportResponse
 
 ## Properties
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::Import.new(pulp_href: null,
+instance = PulpcoreClient::ImportResponse.new(pulp_href: null,
                                  pulp_created: null,
                                  task: null,
                                  params: null)

data/docs/ImportersCoreImportsApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](ImportersCoreImportsApi.md#create) | **POST** {pulp_importer_href}imports/ | Create a pulp import
-[**delete**](ImportersCoreImportsApi.md#delete) | **DELETE** {pulp_import_href} | Delete a pulp import
+[**create**](ImportersCoreImportsApi.md#create) | **POST** {core_pulp_pulp_import_href}imports/ | Create a pulp import
+[**delete**](ImportersCoreImportsApi.md#delete) | **DELETE** {core_pulp_pulp_import_href} | Delete a pulp import
 [**list**](ImportersCoreImportsApi.md#list) | **GET** {pulp_importer_href}imports/ | List pulp imports
-[**read**](ImportersCoreImportsApi.md#read) | **GET** {pulp_import_href} | Inspect a pulp import
+[**read**](ImportersCoreImportsApi.md#read) | **GET** {core_pulp_pulp_import_href} | Inspect a pulp import
 
 
 
 ## create
 
-> AsyncOperationResponse create(pulp_importer_href, data)
+> AsyncOperationResponse create(core_pulp_pulp_import_href, pulp_import)
 
 Create a pulp import
 
@@ -26,18 +26,18 @@ Trigger an asynchronous task to import a Pulp export.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::ImportersCoreImportsApi.new
-pulp_importer_href = 'pulp_importer_href_example' # String | URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/
-data = PulpcoreClient::PulpImport.new # PulpImport | 
+core_pulp_pulp_import_href = 'core_pulp_pulp_import_href_example' # String | 
+pulp_import = PulpcoreClient::PulpImport.new # PulpImport | 
 
 begin
   #Create a pulp import
-  result = api_instance.create(pulp_importer_href, data)
+  result = api_instance.create(core_pulp_pulp_import_href, pulp_import)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling ImportersCoreImportsApi->create: #{e}"
@@ -49,8 +49,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pulp_importer_href** | **String**| URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/ | 
- **data** | [**PulpImport**](PulpImport.md)|  | 
+ **core_pulp_pulp_import_href** | **String**|  | 
+ **pulp_import** | [**PulpImport**](PulpImport.md)|  | 
 
 ### Return type
 
@@ -58,17 +58,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## delete
 
-> delete(pulp_import_href)
+> delete(core_pulp_pulp_import_href)
 
 Delete a pulp import
 
@@ -81,17 +81,17 @@ ViewSet for PulpImports.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::ImportersCoreImportsApi.new
-pulp_import_href = 'pulp_import_href_example' # String | URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/
+core_pulp_pulp_import_href = 'core_pulp_pulp_import_href_example' # String | 
 
 begin
   #Delete a pulp import
-  api_instance.delete(pulp_import_href)
+  api_instance.delete(core_pulp_pulp_import_href)
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling ImportersCoreImportsApi->delete: #{e}"
 end
@@ -102,7 +102,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pulp_import_href** | **String**| URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/ | 
+ **core_pulp_pulp_import_href** | **String**|  | 
 
 ### Return type
 
@@ -110,7 +110,7 @@ nil (empty response body)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -120,7 +120,7 @@ nil (empty response body)
 
 ## list
 
-> InlineResponse2004 list(pulp_importer_href, opts)
+> InlineResponse2008 list(pulp_importer_href, opts)
 
 List pulp imports
 
@@ -133,17 +133,17 @@ ViewSet for PulpImports.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::ImportersCoreImportsApi.new
-pulp_importer_href = 'pulp_importer_href_example' # String | URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/
+pulp_importer_href = 'pulp_importer_href_example' # String | 
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
   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.
 }
@@ -162,20 +162,20 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pulp_importer_href** | **String**| URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/ | 
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **pulp_importer_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
 
-[**InlineResponse2004**](InlineResponse2004.md)
+[**InlineResponse2008**](InlineResponse2008.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -185,7 +185,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> Import read(pulp_import_href, opts)
+> ImportResponse read(core_pulp_pulp_import_href, opts)
 
 Inspect a pulp import
 
@@ -198,13 +198,13 @@ ViewSet for PulpImports.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::ImportersCoreImportsApi.new
-pulp_import_href = 'pulp_import_href_example' # String | URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/
+core_pulp_pulp_import_href = 'core_pulp_pulp_import_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.
@@ -212,7 +212,7 @@ opts = {
 
 begin
   #Inspect a pulp import
-  result = api_instance.read(pulp_import_href, opts)
+  result = api_instance.read(core_pulp_pulp_import_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling ImportersCoreImportsApi->read: #{e}"
@@ -224,17 +224,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pulp_import_href** | **String**| URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/ | 
+ **core_pulp_pulp_import_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
 
-[**Import**](Import.md)
+[**ImportResponse**](ImportResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers