pulp_rpm_client 3.18.20 → 3.18.21

data/docs/AccessPoliciesApi.md

@@ -0,0 +1,313 @@
+# PulpRpmClient::AccessPoliciesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](AccessPoliciesApi.md#list) | **GET** /pulp/api/v3/access_policies/ | List access policys
+[**partial_update**](AccessPoliciesApi.md#partial_update) | **PATCH** {access_policy_href} | Update an access policy
+[**read**](AccessPoliciesApi.md#read) | **GET** {access_policy_href} | Inspect an access policy
+[**reset**](AccessPoliciesApi.md#reset) | **POST** {access_policy_href}reset/ | 
+[**update**](AccessPoliciesApi.md#update) | **PUT** {access_policy_href} | Update an access policy
+
+
+
+## list
+
+> PaginatedAccessPolicyResponseList list(opts)
+
+List access policys
+
+ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::AccessPoliciesApi.new
+opts = {
+  customized: true, # Boolean | Filter results where customized matches value
+  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  * `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) * `creation_hooks` - Creation hooks * `-creation_hooks` - Creation hooks (descending) * `statements` - Statements * `-statements` - Statements (descending) * `viewset_name` - Viewset name * `-viewset_name` - Viewset name (descending) * `customized` - Customized * `-customized` - Customized (descending) * `queryset_scoping` - Queryset scoping * `-queryset_scoping` - Queryset scoping (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  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.
+  viewset_name: 'viewset_name_example', # String | Filter results where viewset_name matches value
+  viewset_name__contains: 'viewset_name__contains_example', # String | Filter results where viewset_name contains value
+  viewset_name__icontains: 'viewset_name__icontains_example', # String | Filter results where viewset_name contains value
+  viewset_name__in: ['viewset_name__in_example'], # Array<String> | Filter results where viewset_name is in a comma-separated list of values
+  viewset_name__startswith: 'viewset_name__startswith_example', # String | Filter results where viewset_name starts with value
+  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 access policys
+  result = api_instance.list(opts)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling AccessPoliciesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customized** | **Boolean**| Filter results where customized matches value | [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  * &#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;creation_hooks&#x60; - Creation hooks * &#x60;-creation_hooks&#x60; - Creation hooks (descending) * &#x60;statements&#x60; - Statements * &#x60;-statements&#x60; - Statements (descending) * &#x60;viewset_name&#x60; - Viewset name * &#x60;-viewset_name&#x60; - Viewset name (descending) * &#x60;customized&#x60; - Customized * &#x60;-customized&#x60; - Customized (descending) * &#x60;queryset_scoping&#x60; - Queryset scoping * &#x60;-queryset_scoping&#x60; - Queryset scoping (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [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] 
+ **viewset_name** | **String**| Filter results where viewset_name matches value | [optional] 
+ **viewset_name__contains** | **String**| Filter results where viewset_name contains value | [optional] 
+ **viewset_name__icontains** | **String**| Filter results where viewset_name contains value | [optional] 
+ **viewset_name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where viewset_name is in a comma-separated list of values | [optional] 
+ **viewset_name__startswith** | **String**| Filter results where viewset_name starts with value | [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
+
+[**PaginatedAccessPolicyResponseList**](PaginatedAccessPolicyResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AccessPolicyResponse partial_update(access_policy_href, patched_access_policy)
+
+Update an access policy
+
+ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::AccessPoliciesApi.new
+access_policy_href = 'access_policy_href_example' # String | 
+patched_access_policy = PulpRpmClient::PatchedAccessPolicy.new # PatchedAccessPolicy | 
+
+begin
+  #Update an access policy
+  result = api_instance.partial_update(access_policy_href, patched_access_policy)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling AccessPoliciesApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **access_policy_href** | **String**|  | 
+ **patched_access_policy** | [**PatchedAccessPolicy**](PatchedAccessPolicy.md)|  | 
+
+### Return type
+
+[**AccessPolicyResponse**](AccessPolicyResponse.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
+
+> AccessPolicyResponse read(access_policy_href, opts)
+
+Inspect an access policy
+
+ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::AccessPoliciesApi.new
+access_policy_href = 'access_policy_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 an access policy
+  result = api_instance.read(access_policy_href, opts)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling AccessPoliciesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **access_policy_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
+
+[**AccessPolicyResponse**](AccessPolicyResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reset
+
+> AccessPolicyResponse reset(access_policy_href)
+
+
+
+Reset the access policy to its uncustomized default value.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::AccessPoliciesApi.new
+access_policy_href = 'access_policy_href_example' # String | 
+
+begin
+  result = api_instance.reset(access_policy_href)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling AccessPoliciesApi->reset: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **access_policy_href** | **String**|  | 
+
+### Return type
+
+[**AccessPolicyResponse**](AccessPolicyResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AccessPolicyResponse update(access_policy_href, access_policy)
+
+Update an access policy
+
+ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::AccessPoliciesApi.new
+access_policy_href = 'access_policy_href_example' # String | 
+access_policy = PulpRpmClient::AccessPolicy.new # AccessPolicy | 
+
+begin
+  #Update an access policy
+  result = api_instance.update(access_policy_href, access_policy)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling AccessPoliciesApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **access_policy_href** | **String**|  | 
+ **access_policy** | [**AccessPolicy**](AccessPolicy.md)|  | 
+
+### Return type
+
+[**AccessPolicyResponse**](AccessPolicyResponse.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/AccessPolicy.md

@@ -0,0 +1,23 @@
+# PulpRpmClient::AccessPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead. | [optional] 
+**creation_hooks** | **Array<Object>** | List of callables that may associate user roles for new objects. | [optional] 
+**statements** | **Array<Object>** | List of policy statements defining the policy. | 
+**queryset_scoping** | [**Object**](.md) | A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpRpmClient'
+
+instance = PulpRpmClient::AccessPolicy.new(permissions_assignment: null,
+                                 creation_hooks: null,
+                                 statements: null,
+                                 queryset_scoping: null)
+```
+
+

data/docs/AccessPolicyResponse.md

@@ -0,0 +1,31 @@
+# PulpRpmClient::AccessPolicyResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead. | [optional] 
+**creation_hooks** | **Array<Object>** | List of callables that may associate user roles for new objects. | [optional] 
+**statements** | **Array<Object>** | List of policy statements defining the policy. | 
+**viewset_name** | **String** | The name of ViewSet this AccessPolicy authorizes. | [optional] [readonly] 
+**customized** | **Boolean** | True if the AccessPolicy has been user-modified. False otherwise. | [optional] [readonly] 
+**queryset_scoping** | [**Object**](.md) | A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpRpmClient'
+
+instance = PulpRpmClient::AccessPolicyResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 permissions_assignment: null,
+                                 creation_hooks: null,
+                                 statements: null,
+                                 viewset_name: null,
+                                 customized: null,
+                                 queryset_scoping: null)
+```
+
+

data/docs/Artifact.md

@@ -0,0 +1,31 @@
+# PulpRpmClient::Artifact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **File** | The stored file. | 
+**size** | **Integer** | The size of the file in bytes. | [optional] 
+**md5** | **String** | The MD5 checksum of the file if available. | [optional] 
+**sha1** | **String** | The SHA-1 checksum of the file if available. | [optional] 
+**sha224** | **String** | The SHA-224 checksum of the file if available. | [optional] 
+**sha256** | **String** | The SHA-256 checksum of the file if available. | [optional] 
+**sha384** | **String** | The SHA-384 checksum of the file if available. | [optional] 
+**sha512** | **String** | The SHA-512 checksum of the file if available. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpRpmClient'
+
+instance = PulpRpmClient::Artifact.new(file: null,
+                                 size: null,
+                                 md5: null,
+                                 sha1: null,
+                                 sha224: null,
+                                 sha256: null,
+                                 sha384: null,
+                                 sha512: null)
+```
+
+

data/docs/ArtifactDistributionResponse.md

@@ -0,0 +1,29 @@
+# PulpRpmClient::ArtifactDistributionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**pulp_href** | **String** |  | [optional] [readonly] 
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | 
+**pulp_labels** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpRpmClient'
+
+instance = PulpRpmClient::ArtifactDistributionResponse.new(pulp_created: null,
+                                 pulp_href: null,
+                                 base_path: null,
+                                 pulp_labels: null,
+                                 name: null,
+                                 content_guard: null,
+                                 base_url: null)
+```
+
+