pulpcore_client 3.69.1 → 3.70.0

data/docs/ExportersPulpApi.md

@@ -2,29 +2,28 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersPulpApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/ | Create a pulp exporter
-[**delete**](ExportersPulpApi.md#delete) | **DELETE** {pulp_exporter_href} | Delete a pulp exporter
-[**list**](ExportersPulpApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/ | List pulp exporters
-[**partial_update**](ExportersPulpApi.md#partial_update) | **PATCH** {pulp_exporter_href} | Update a pulp exporter
-[**read**](ExportersPulpApi.md#read) | **GET** {pulp_exporter_href} | Inspect a pulp exporter
-[**update**](ExportersPulpApi.md#update) | **PUT** {pulp_exporter_href} | Update a pulp exporter
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ExportersPulpApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/ | Create a pulp exporter |
+| [**delete**](ExportersPulpApi.md#delete) | **DELETE** {pulp_exporter_href} | Delete a pulp exporter |
+| [**list**](ExportersPulpApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/ | List pulp exporters |
+| [**partial_update**](ExportersPulpApi.md#partial_update) | **PATCH** {pulp_exporter_href} | Update a pulp exporter |
+| [**read**](ExportersPulpApi.md#read) | **GET** {pulp_exporter_href} | Inspect a pulp exporter |
+| [**update**](ExportersPulpApi.md#update) | **PUT** {pulp_exporter_href} | Update a pulp exporter |
 
 
 ## create
 
-> PulpExporterResponse create(pulp_exporter)
+> <PulpExporterResponse> create(pulp_exporter)
 
 Create a pulp exporter
 
 ViewSet for viewing PulpExporters.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -34,23 +33,40 @@ PulpcoreClient.configure do |config|
 end
 
 api_instance = PulpcoreClient::ExportersPulpApi.new
-pulp_exporter = PulpcoreClient::PulpExporter.new # PulpExporter | 
+pulp_exporter = PulpcoreClient::PulpExporter.new({name: 'name_example', path: 'path_example', repositories: ['repositories_example']}) # PulpExporter | 
 
 begin
-  #Create a pulp exporter
+  # Create a pulp exporter
   result = api_instance.create(pulp_exporter)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->create: #{e}"
+  puts "Error when calling ExportersPulpApi->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(<PulpExporterResponse>, Integer, Hash)> create_with_http_info(pulp_exporter)
+
+```ruby
+begin
+  # Create a pulp exporter
+  data, status_code, headers = api_instance.create_with_http_info(pulp_exporter)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PulpExporterResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersPulpApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter** | [**PulpExporter**](PulpExporter.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_exporter** | [**PulpExporter**](PulpExporter.md) |  |  |
 
 ### Return type
 
@@ -68,16 +84,16 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> AsyncOperationResponse delete(pulp_exporter_href)
+> <AsyncOperationResponse> delete(pulp_exporter_href)
 
 Delete a pulp exporter
 
 Trigger an asynchronous delete task
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -90,20 +106,37 @@ api_instance = PulpcoreClient::ExportersPulpApi.new
 pulp_exporter_href = 'pulp_exporter_href_example' # String | 
 
 begin
-  #Delete a pulp exporter
+  # Delete a pulp exporter
   result = api_instance.delete(pulp_exporter_href)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->delete: #{e}"
+  puts "Error when calling ExportersPulpApi->delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
+> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(pulp_exporter_href)
+
+```ruby
+begin
+  # Delete a pulp exporter
+  data, status_code, headers = api_instance.delete_with_http_info(pulp_exporter_href)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersPulpApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_exporter_href** | **String** |  |  |
 
 ### Return type
 
@@ -121,16 +154,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatedPulpExporterResponseList list(opts)
+> <PaginatedPulpExporterResponseList> list(opts)
 
 List pulp exporters
 
 ViewSet for viewing PulpExporters.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -146,53 +179,70 @@ opts = {
   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__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
+  name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
   name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
   name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
   name__regex: 'name__regex_example', # String | Filter results where name matches regex value
   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  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `path` - Path * `-path` - Path (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  ordering: ['-name'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `path` - Path * `-path` - Path (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
   q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
-  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 exporters
+  # List pulp exporters
   result = api_instance.list(opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->list: #{e}"
+  puts "Error when calling ExportersPulpApi->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(<PaginatedPulpExporterResponseList>, Integer, Hash)> list_with_http_info(opts)
 
+```ruby
+begin
+  # List pulp exporters
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedPulpExporterResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersPulpApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **name** | **String**| Filter results where name matches value | [optional] 
- **name__contains** | **String**| Filter results where name contains value | [optional] 
- **name__icontains** | **String**| Filter results where name contains value | [optional] 
- **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] 
- **name__iregex** | **String**| Filter results where name matches regex value | [optional] 
- **name__istartswith** | **String**| Filter results where name starts with value | [optional] 
- **name__regex** | **String**| Filter results where name matches regex value | [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  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;path&#x60; - Path * &#x60;-path&#x60; - Path (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [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 |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **name** | **String** | Filter results where name matches value | [optional] |
+| **name__contains** | **String** | Filter results where name contains value | [optional] |
+| **name__icontains** | **String** | Filter results where name contains value | [optional] |
+| **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] |
+| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
+| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
+| **name__regex** | **String** | Filter results where name matches regex value | [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  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;path&#x60; - Path * &#x60;-path&#x60; - Path (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [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
 
@@ -210,16 +260,16 @@ Name | Type | Description  | Notes
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(pulp_exporter_href, patched_pulp_exporter)
+> <AsyncOperationResponse> partial_update(pulp_exporter_href, patched_pulp_exporter)
 
 Update a pulp exporter
 
 Trigger an asynchronous partial update task
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -233,21 +283,38 @@ pulp_exporter_href = 'pulp_exporter_href_example' # String |
 patched_pulp_exporter = PulpcoreClient::PatchedPulpExporter.new # PatchedPulpExporter | 
 
 begin
-  #Update a pulp exporter
+  # Update a pulp exporter
   result = api_instance.partial_update(pulp_exporter_href, patched_pulp_exporter)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->partial_update: #{e}"
+  puts "Error when calling ExportersPulpApi->partial_update: #{e}"
 end
 ```
 
-### Parameters
+#### Using the partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(pulp_exporter_href, patched_pulp_exporter)
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
- **patched_pulp_exporter** | [**PatchedPulpExporter**](PatchedPulpExporter.md)|  | 
+```ruby
+begin
+  # Update a pulp exporter
+  data, status_code, headers = api_instance.partial_update_with_http_info(pulp_exporter_href, patched_pulp_exporter)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersPulpApi->partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_exporter_href** | **String** |  |  |
+| **patched_pulp_exporter** | [**PatchedPulpExporter**](PatchedPulpExporter.md) |  |  |
 
 ### Return type
 
@@ -265,16 +332,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> PulpExporterResponse read(pulp_exporter_href, opts)
+> <PulpExporterResponse> read(pulp_exporter_href, opts)
 
 Inspect a pulp exporter
 
 ViewSet for viewing PulpExporters.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -286,27 +353,44 @@ end
 api_instance = PulpcoreClient::ExportersPulpApi.new
 pulp_exporter_href = 'pulp_exporter_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 exporter
+  # Inspect a pulp exporter
   result = api_instance.read(pulp_exporter_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->read: #{e}"
+  puts "Error when calling ExportersPulpApi->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(<PulpExporterResponse>, Integer, Hash)> read_with_http_info(pulp_exporter_href, opts)
+
+```ruby
+begin
+  # Inspect a pulp exporter
+  data, status_code, headers = api_instance.read_with_http_info(pulp_exporter_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PulpExporterResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersPulpApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_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_exporter_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
 
@@ -324,16 +408,16 @@ Name | Type | Description  | Notes
 
 ## update
 
-> AsyncOperationResponse update(pulp_exporter_href, pulp_exporter)
+> <AsyncOperationResponse> update(pulp_exporter_href, pulp_exporter)
 
 Update a pulp exporter
 
 Trigger an asynchronous update task
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -344,24 +428,41 @@ end
 
 api_instance = PulpcoreClient::ExportersPulpApi.new
 pulp_exporter_href = 'pulp_exporter_href_example' # String | 
-pulp_exporter = PulpcoreClient::PulpExporter.new # PulpExporter | 
+pulp_exporter = PulpcoreClient::PulpExporter.new({name: 'name_example', path: 'path_example', repositories: ['repositories_example']}) # PulpExporter | 
 
 begin
-  #Update a pulp exporter
+  # Update a pulp exporter
   result = api_instance.update(pulp_exporter_href, pulp_exporter)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->update: #{e}"
+  puts "Error when calling ExportersPulpApi->update: #{e}"
 end
 ```
 
-### Parameters
+#### Using the update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(pulp_exporter_href, pulp_exporter)
 
+```ruby
+begin
+  # Update a pulp exporter
+  data, status_code, headers = api_instance.update_with_http_info(pulp_exporter_href, pulp_exporter)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersPulpApi->update_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
- **pulp_exporter** | [**PulpExporter**](PulpExporter.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_exporter_href** | **String** |  |  |
+| **pulp_exporter** | [**PulpExporter**](PulpExporter.md) |  |  |
 
 ### Return type