pulpcore_client 3.69.2 → 3.70.0

data/docs/ImportersPulpImportsApi.md

@@ -2,27 +2,26 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ImportersPulpImportsApi.md#create) | **POST** {pulp_importer_href}imports/ | Create a pulp import
-[**delete**](ImportersPulpImportsApi.md#delete) | **DELETE** {pulp_pulp_import_href} | Delete a pulp import
-[**list**](ImportersPulpImportsApi.md#list) | **GET** {pulp_importer_href}imports/ | List pulp imports
-[**read**](ImportersPulpImportsApi.md#read) | **GET** {pulp_pulp_import_href} | Inspect a pulp import
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ImportersPulpImportsApi.md#create) | **POST** {pulp_importer_href}imports/ | Create a pulp import |
+| [**delete**](ImportersPulpImportsApi.md#delete) | **DELETE** {pulp_pulp_import_href} | Delete a pulp import |
+| [**list**](ImportersPulpImportsApi.md#list) | **GET** {pulp_importer_href}imports/ | List pulp imports |
+| [**read**](ImportersPulpImportsApi.md#read) | **GET** {pulp_pulp_import_href} | Inspect a pulp import |
 
 
 ## create
 
-> TaskGroupOperationResponse create(pulp_importer_href, pulp_import)
+> <TaskGroupOperationResponse> create(pulp_importer_href, pulp_import)
 
 Create a pulp import
 
 Trigger an asynchronous task to import a Pulp export.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -36,21 +35,38 @@ pulp_importer_href = 'pulp_importer_href_example' # String |
 pulp_import = PulpcoreClient::PulpImport.new # PulpImport | 
 
 begin
-  #Create a pulp import
+  # Create a pulp import
   result = api_instance.create(pulp_importer_href, pulp_import)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersPulpImportsApi->create: #{e}"
+  puts "Error when calling ImportersPulpImportsApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<TaskGroupOperationResponse>, Integer, Hash)> create_with_http_info(pulp_importer_href, pulp_import)
+
+```ruby
+begin
+  # Create a pulp import
+  data, status_code, headers = api_instance.create_with_http_info(pulp_importer_href, pulp_import)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaskGroupOperationResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ImportersPulpImportsApi->create_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_importer_href** | **String**|  | 
- **pulp_import** | [**PulpImport**](PulpImport.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_importer_href** | **String** |  |  |
+| **pulp_import** | [**PulpImport**](PulpImport.md) |  |  |
 
 ### Return type
 
@@ -74,10 +90,10 @@ Delete a pulp import
 
 ViewSet for PulpImports.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -90,19 +106,36 @@ api_instance = PulpcoreClient::ImportersPulpImportsApi.new
 pulp_pulp_import_href = 'pulp_pulp_import_href_example' # String | 
 
 begin
-  #Delete a pulp import
+  # Delete a pulp import
   api_instance.delete(pulp_pulp_import_href)
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersPulpImportsApi->delete: #{e}"
+  puts "Error when calling ImportersPulpImportsApi->delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_with_http_info(pulp_pulp_import_href)
+
+```ruby
+begin
+  # Delete a pulp import
+  data, status_code, headers = api_instance.delete_with_http_info(pulp_pulp_import_href)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ImportersPulpImportsApi->delete_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_pulp_import_href** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_pulp_import_href** | **String** |  |  |
 
 ### Return type
 
@@ -120,16 +153,16 @@ nil (empty response body)
 
 ## list
 
-> PaginatedImportResponseList list(pulp_importer_href, opts)
+> <PaginatedImportResponseList> list(pulp_importer_href, opts)
 
 List pulp imports
 
 ViewSet for PulpImports.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -143,29 +176,46 @@ pulp_importer_href = 'pulp_importer_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.
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List pulp imports
+  # List pulp imports
   result = api_instance.list(pulp_importer_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersPulpImportsApi->list: #{e}"
+  puts "Error when calling ImportersPulpImportsApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedImportResponseList>, Integer, Hash)> list_with_http_info(pulp_importer_href, opts)
+
+```ruby
+begin
+  # List pulp imports
+  data, status_code, headers = api_instance.list_with_http_info(pulp_importer_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedImportResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ImportersPulpImportsApi->list_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **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] 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 
@@ -183,16 +233,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> ImportResponse read(pulp_pulp_import_href, opts)
+> <ImportResponse> read(pulp_pulp_import_href, opts)
 
 Inspect a pulp import
 
 ViewSet for PulpImports.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -204,27 +254,44 @@ end
 api_instance = PulpcoreClient::ImportersPulpImportsApi.new
 pulp_pulp_import_href = 'pulp_pulp_import_href_example' # String | 
 opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect a pulp import
+  # Inspect a pulp import
   result = api_instance.read(pulp_pulp_import_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersPulpImportsApi->read: #{e}"
+  puts "Error when calling ImportersPulpImportsApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImportResponse>, Integer, Hash)> read_with_http_info(pulp_pulp_import_href, opts)
+
+```ruby
+begin
+  # Inspect a pulp import
+  data, status_code, headers = api_instance.read_with_http_info(pulp_pulp_import_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImportResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ImportersPulpImportsApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_pulp_import_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_pulp_import_href** | **String** |  |  |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 

data/docs/LivezApi.md

@@ -2,10 +2,9 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**livez_read**](LivezApi.md#livez_read) | **GET** /pulp/api/v3/livez/ | Inspect liveness of Pulp's REST API.
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**livez_read**](LivezApi.md#livez_read) | **GET** /pulp/api/v3/livez/ | Inspect liveness of Pulp's REST API. |
 
 
 ## livez_read
@@ -16,19 +15,37 @@ Inspect liveness of Pulp's REST API.
 
 Returns 200 OK when API is alive.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 
 api_instance = PulpcoreClient::LivezApi.new
 
 begin
-  #Inspect liveness of Pulp's REST API.
+  # Inspect liveness of Pulp's REST API.
   api_instance.livez_read
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling LivezApi->livez_read: #{e}"
+  puts "Error when calling LivezApi->livez_read: #{e}"
+end
+```
+
+#### Using the livez_read_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> livez_read_with_http_info
+
+```ruby
+begin
+  # Inspect liveness of Pulp's REST API.
+  data, status_code, headers = api_instance.livez_read_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LivezApi->livez_read_with_http_info: #{e}"
 end
 ```
 

data/docs/LoginApi.md

@@ -0,0 +1,204 @@
+# PulpcoreClient::LoginApi
+
+All URIs are relative to *http://localhost:24817*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**login**](LoginApi.md#login) | **POST** /pulp/api/v3/login/ |  |
+| [**login_read**](LoginApi.md#login_read) | **GET** /pulp/api/v3/login/ |  |
+| [**logout**](LoginApi.md#logout) | **DELETE** /pulp/api/v3/login/ |  |
+
+
+## login
+
+> <LoginResponse> login
+
+
+
+### Examples
+
+```ruby
+require 'time'
+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::LoginApi.new
+
+begin
+  
+  result = api_instance.login
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LoginApi->login: #{e}"
+end
+```
+
+#### Using the login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LoginResponse>, Integer, Hash)> login_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.login_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LoginResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LoginApi->login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**LoginResponse**](LoginResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## login_read
+
+> <LoginResponse> login_read
+
+
+
+### Examples
+
+```ruby
+require 'time'
+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::LoginApi.new
+
+begin
+  
+  result = api_instance.login_read
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LoginApi->login_read: #{e}"
+end
+```
+
+#### Using the login_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LoginResponse>, Integer, Hash)> login_read_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.login_read_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LoginResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LoginApi->login_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**LoginResponse**](LoginResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## logout
+
+> logout
+
+
+
+### Examples
+
+```ruby
+require 'time'
+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::LoginApi.new
+
+begin
+  
+  api_instance.logout
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LoginApi->logout: #{e}"
+end
+```
+
+#### Using the logout_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> logout_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.logout_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling LoginApi->logout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/LoginResponse.md

@@ -0,0 +1,22 @@
+# PulpcoreClient::LoginResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** |  | [optional][readonly] |
+| **username** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pulpcore_client'
+
+instance = PulpcoreClient::LoginResponse.new(
+  pulp_href: null,
+  prn: null,
+  username: null
+)
+```
+

data/docs/MethodEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
 instance = PulpcoreClient::MethodEnum.new()
 ```
 
-

data/docs/MinimalTaskResponse.md

@@ -2,34 +2,35 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**name** | **String** | The name of task. | 
-**state** | **String** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional] [readonly] 
-**unblocked_at** | **DateTime** | Timestamp of when this task was identified ready for pickup. | [optional] [readonly] 
-**started_at** | **DateTime** | Timestamp of when this task started execution. | [optional] [readonly] 
-**finished_at** | **DateTime** | Timestamp of when this task stopped execution. | [optional] [readonly] 
-**worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional] [readonly] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **name** | **String** | The name of task. |  |
+| **state** | **String** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional][readonly] |
+| **unblocked_at** | **Time** | Timestamp of when this task was identified ready for pickup. | [optional][readonly] |
+| **started_at** | **Time** | Timestamp of when this task started execution. | [optional][readonly] |
+| **finished_at** | **Time** | Timestamp of when this task stopped execution. | [optional][readonly] |
+| **worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional][readonly] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::MinimalTaskResponse.new(pulp_href: null,
-                                 prn: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 state: null,
-                                 unblocked_at: null,
-                                 started_at: null,
-                                 finished_at: null,
-                                 worker: null)
+instance = PulpcoreClient::MinimalTaskResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  name: null,
+  state: null,
+  unblocked_at: null,
+  started_at: null,
+  finished_at: null,
+  worker: null
+)
 ```
 
-