pulpcore_client 3.20.0 → 3.21.0

data/docs/ExportersApi.md

@@ -1,362 +0,0 @@
-# PulpcoreClient::ExportersApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersApi.md#create) | **POST** /pulp/api/v3/exporters/ | Create an exporter
-[**delete**](ExportersApi.md#delete) | **DELETE** {exporter_href} | Delete an exporter
-[**list**](ExportersApi.md#list) | **GET** /pulp/api/v3/exporters/ | List exporters
-[**partial_update**](ExportersApi.md#partial_update) | **PATCH** {exporter_href} | Update an exporter
-[**read**](ExportersApi.md#read) | **GET** {exporter_href} | Inspect an exporter
-[**update**](ExportersApi.md#update) | **PUT** {exporter_href} | Update an exporter
-
-
-
-## create
-
-> ExporterResponse create(exporter)
-
-Create an exporter
-
-ViewSet for viewing exporters.
-
-### 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::ExportersApi.new
-exporter = PulpcoreClient::Exporter.new # Exporter | 
-
-begin
-  #Create an exporter
-  result = api_instance.create(exporter)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter** | [**Exporter**](Exporter.md)|  | 
-
-### Return type
-
-[**ExporterResponse**](ExporterResponse.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
-
-> AsyncOperationResponse delete(exporter_href)
-
-Delete an exporter
-
-Trigger an asynchronous delete task
-
-### 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::ExportersApi.new
-exporter_href = 'exporter_href_example' # String | 
-
-begin
-  #Delete an exporter
-  result = api_instance.delete(exporter_href)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter_href** | **String**|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list
-
-> PaginatedExporterResponseList list(opts)
-
-List exporters
-
-ViewSet for viewing exporters.
-
-### 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::ExportersApi.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 exporters
-  result = api_instance.list(opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersApi->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
-
-[**PaginatedExporterResponseList**](PaginatedExporterResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## partial_update
-
-> AsyncOperationResponse partial_update(exporter_href, patched_exporter)
-
-Update an exporter
-
-Trigger an asynchronous partial update task
-
-### 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::ExportersApi.new
-exporter_href = 'exporter_href_example' # String | 
-patched_exporter = PulpcoreClient::PatchedExporter.new # PatchedExporter | 
-
-begin
-  #Update an exporter
-  result = api_instance.partial_update(exporter_href, patched_exporter)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter_href** | **String**|  | 
- **patched_exporter** | [**PatchedExporter**](PatchedExporter.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.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
-
-> ExporterResponse read(exporter_href, opts)
-
-Inspect an exporter
-
-ViewSet for viewing exporters.
-
-### 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::ExportersApi.new
-exporter_href = 'exporter_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 exporter
-  result = api_instance.read(exporter_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter_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
-
-[**ExporterResponse**](ExporterResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> AsyncOperationResponse update(exporter_href, exporter)
-
-Update an exporter
-
-Trigger an asynchronous update task
-
-### 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::ExportersApi.new
-exporter_href = 'exporter_href_example' # String | 
-exporter = PulpcoreClient::Exporter.new # Exporter | 
-
-begin
-  #Update an exporter
-  result = api_instance.update(exporter_href, exporter)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter_href** | **String**|  | 
- **exporter** | [**Exporter**](Exporter.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.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/ExportersExportsApi.md

@@ -1,241 +0,0 @@
-# PulpcoreClient::ExportersExportsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersExportsApi.md#create) | **POST** {exporter_href}exports/ | Create an export
-[**delete**](ExportersExportsApi.md#delete) | **DELETE** {exporters_export_href} | Delete an export
-[**list**](ExportersExportsApi.md#list) | **GET** {exporter_href}exports/ | List exports
-[**read**](ExportersExportsApi.md#read) | **GET** {exporters_export_href} | Inspect an export
-
-
-
-## create
-
-> ExportResponse create(exporter_href, export)
-
-Create an export
-
-ViewSet for viewing exports from an Exporter.
-
-### 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::ExportersExportsApi.new
-exporter_href = 'exporter_href_example' # String | 
-export = PulpcoreClient::Export.new # Export | 
-
-begin
-  #Create an export
-  result = api_instance.create(exporter_href, export)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersExportsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter_href** | **String**|  | 
- **export** | [**Export**](Export.md)|  | 
-
-### Return type
-
-[**ExportResponse**](ExportResponse.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(exporters_export_href)
-
-Delete an export
-
-ViewSet for viewing exports from an Exporter.
-
-### 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::ExportersExportsApi.new
-exporters_export_href = 'exporters_export_href_example' # String | 
-
-begin
-  #Delete an export
-  api_instance.delete(exporters_export_href)
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersExportsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporters_export_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## list
-
-> PaginatedExportResponseList list(exporter_href, opts)
-
-List exports
-
-ViewSet for viewing exports from an Exporter.
-
-### 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::ExportersExportsApi.new
-exporter_href = 'exporter_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', # 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 exports
-  result = api_instance.list(exporter_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersExportsApi->list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporter_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** | **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
-
-[**PaginatedExportResponseList**](PaginatedExportResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## read
-
-> ExportResponse read(exporters_export_href, opts)
-
-Inspect an export
-
-ViewSet for viewing exports from an Exporter.
-
-### 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::ExportersExportsApi.new
-exporters_export_href = 'exporters_export_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 export
-  result = api_instance.read(exporters_export_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersExportsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **exporters_export_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
-
-[**ExportResponse**](ExportResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/Import.md

@@ -1,19 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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)
-```
-
-