pulpcore_client 3.22.30 → 3.23.0

data/docs/DomainsApi.md

@@ -0,0 +1,362 @@
+# PulpcoreClient::DomainsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DomainsApi.md#create) | **POST** /pulp/api/v3/domains/ | Create a domain
+[**delete**](DomainsApi.md#delete) | **DELETE** {domain_href} | Delete a domain
+[**list**](DomainsApi.md#list) | **GET** /pulp/api/v3/domains/ | List domains
+[**partial_update**](DomainsApi.md#partial_update) | **PATCH** {domain_href} | Update a domain
+[**read**](DomainsApi.md#read) | **GET** {domain_href} | Inspect a domain
+[**update**](DomainsApi.md#update) | **PUT** {domain_href} | Update a domain
+
+
+
+## create
+
+> DomainResponse create(domain)
+
+Create a domain
+
+ViewSet for Domain.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### 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::DomainsApi.new
+domain = PulpcoreClient::Domain.new # Domain | 
+
+begin
+  #Create a domain
+  result = api_instance.create(domain)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DomainsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain** | [**Domain**](Domain.md)|  | 
+
+### Return type
+
+[**DomainResponse**](DomainResponse.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(domain_href)
+
+Delete a domain
+
+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::DomainsApi.new
+domain_href = 'domain_href_example' # String | 
+
+begin
+  #Delete a domain
+  result = api_instance.delete(domain_href)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DomainsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedDomainResponseList list(opts)
+
+List domains
+
+ViewSet for Domain.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### 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::DomainsApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  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'], # 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.
+}
+
+begin
+  #List domains
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DomainsApi->list: #{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__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** | [**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
+
+[**PaginatedDomainResponseList**](PaginatedDomainResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(domain_href, patched_domain)
+
+Update a domain
+
+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::DomainsApi.new
+domain_href = 'domain_href_example' # String | 
+patched_domain = PulpcoreClient::PatchedDomain.new # PatchedDomain | 
+
+begin
+  #Update a domain
+  result = api_instance.partial_update(domain_href, patched_domain)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DomainsApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain_href** | **String**|  | 
+ **patched_domain** | [**PatchedDomain**](PatchedDomain.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
+
+> DomainResponse read(domain_href, opts)
+
+Inspect a domain
+
+ViewSet for Domain.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### 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::DomainsApi.new
+domain_href = 'domain_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.
+}
+
+begin
+  #Inspect a domain
+  result = api_instance.read(domain_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DomainsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain_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
+
+[**DomainResponse**](DomainResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(domain_href, domain)
+
+Update a domain
+
+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::DomainsApi.new
+domain_href = 'domain_href_example' # String | 
+domain = PulpcoreClient::Domain.new # Domain | 
+
+begin
+  #Update a domain
+  result = api_instance.update(domain_href, domain)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DomainsApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain_href** | **String**|  | 
+ **domain** | [**Domain**](Domain.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/ExportersFilesystemApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ExportersFilesystemApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 Create a filesystem exporter
 
-Endpoint for managing FilesystemExporters. FilesystemExporters are provided as a tech preview.
+Endpoint for managing FilesystemExporters.
 
 ### Example
 
@@ -125,7 +125,7 @@ Name | Type | Description  | Notes
 
 List filesystem exporters
 
-Endpoint for managing FilesystemExporters. FilesystemExporters are provided as a tech preview.
+Endpoint for managing FilesystemExporters.
 
 ### Example
 
@@ -253,7 +253,7 @@ Name | Type | Description  | Notes
 
 Inspect a filesystem exporter
 
-Endpoint for managing FilesystemExporters. FilesystemExporters are provided as a tech preview.
+Endpoint for managing FilesystemExporters.
 
 ### Example
 

data/docs/ExportersFilesystemExportsApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ExportersFilesystemExportsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 Delete a filesystem export
 
-Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview.
+Endpoint for managing FilesystemExports.
 
 ### Example
 
@@ -124,7 +124,7 @@ nil (empty response body)
 
 List filesystem exports
 
-Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview.
+Endpoint for managing FilesystemExports.
 
 ### Example
 
@@ -187,7 +187,7 @@ Name | Type | Description  | Notes
 
 Inspect a filesystem export
 
-Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview.
+Endpoint for managing FilesystemExports.
 
 ### Example
 

data/docs/ExportersPulpApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ExportersPulpApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/ExportersPulpExportsApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ExportersPulpExportsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/GroupRole.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **role** | **String** |  | 
 **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. | 
+**domain** | **String** | Domain this role should be applied on, mutually exclusive with content_object. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'PulpcoreClient'
 
 instance = PulpcoreClient::GroupRole.new(role: null,
-                                 content_object: null)
+                                 content_object: null,
+                                 domain: null)
 ```
 
 

data/docs/GroupRoleResponse.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **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] 
+**domain** | **String** | Domain this role should be applied on, mutually exclusive with content_object. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = PulpcoreClient::GroupRoleResponse.new(pulp_href: null,
                                  role: null,
                                  content_object: null,
                                  description: null,
-                                 permissions: null)
+                                 permissions: null,
+                                 domain: null)
 ```
 
 

data/docs/GroupsApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::GroupsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -77,7 +77,7 @@ Name | Type | Description  | Notes
 
 Create a group
 
-ViewSet for Group.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for Group.
 
 ### Example
 
@@ -130,7 +130,7 @@ Name | Type | Description  | Notes
 
 Delete a group
 
-ViewSet for Group.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for Group.
 
 ### Example
 
@@ -182,7 +182,7 @@ nil (empty response body)
 
 List groups
 
-ViewSet for Group.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for Group.
 
 ### Example
 
@@ -375,7 +375,7 @@ Name | Type | Description  | Notes
 
 Update a group
 
-ViewSet for Group.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for Group.
 
 ### Example
 
@@ -430,7 +430,7 @@ Name | Type | Description  | Notes
 
 Inspect a group
 
-ViewSet for Group.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for Group.
 
 ### Example
 
@@ -543,7 +543,7 @@ Name | Type | Description  | Notes
 
 Update a group
 
-ViewSet for Group.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for Group.
 
 ### Example
 

data/docs/GroupsRolesApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::GroupsRolesApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 Create a group role
 
-ViewSet for GroupRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for GroupRole.
 
 ### Example
 
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 Delete a group role
 
-ViewSet for GroupRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for GroupRole.
 
 ### Example
 
@@ -124,7 +124,7 @@ nil (empty response body)
 
 List group roles
 
-ViewSet for GroupRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for GroupRole.
 
 ### Example
 
@@ -142,6 +142,7 @@ api_instance = PulpcoreClient::GroupsRolesApi.new
 group_href = 'group_href_example' # String | 
 opts = {
   content_object: 'content_object_example', # String | content_object
+  domain: 'domain_example', # String | Foreign Key referenced by HREF
   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'], # Array<String> | Ordering
@@ -170,6 +171,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **group_href** | **String**|  | 
  **content_object** | **String**| content_object | [optional] 
+ **domain** | **String**| Foreign Key referenced by HREF | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
  **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
@@ -201,7 +203,7 @@ Name | Type | Description  | Notes
 
 Inspect a group role
 
-ViewSet for GroupRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for GroupRole.
 
 ### Example
 

data/docs/GroupsUsersApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::GroupsUsersApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/ImportersPulpApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ImportersPulpApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/ImportersPulpImportCheckApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ImportersPulpImportCheckApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/ImportersPulpImportsApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::ImportersPulpImportsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/OrphansApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::OrphansApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/OrphansCleanupApi.md

@@ -1,6 +1,6 @@
 # PulpcoreClient::OrphansCleanupApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PaginatedDomainResponseList.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PaginatedDomainResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DomainResponse>**](DomainResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PaginatedDomainResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+