pulp_file_client 1.10.5 → 1.11.0

data/docs/DistributionsFileApi.md

@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](DistributionsFileApi.md#add_role) | **POST** {file_file_distribution_href}add_role/ | 
 [**create**](DistributionsFileApi.md#create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution
 [**delete**](DistributionsFileApi.md#delete) | **DELETE** {file_file_distribution_href} | Delete a file distribution
 [**list**](DistributionsFileApi.md#list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions
+[**list_roles**](DistributionsFileApi.md#list_roles) | **GET** {file_file_distribution_href}list_roles/ | 
+[**my_permissions**](DistributionsFileApi.md#my_permissions) | **GET** {file_file_distribution_href}my_permissions/ | 
 [**partial_update**](DistributionsFileApi.md#partial_update) | **PATCH** {file_file_distribution_href} | Update a file distribution
 [**read**](DistributionsFileApi.md#read) | **GET** {file_file_distribution_href} | Inspect a file distribution
+[**remove_role**](DistributionsFileApi.md#remove_role) | **POST** {file_file_distribution_href}remove_role/ | 
 [**update**](DistributionsFileApi.md#update) | **PUT** {file_file_distribution_href} | Update a file distribution
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(file_file_distribution_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_file_distribution_href = 'file_file_distribution_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(file_file_distribution_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_distribution_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > AsyncOperationResponse create(file_file_distribution)
@@ -152,7 +210,7 @@ opts = {
   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', # String | Which field to use when ordering the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
   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.
@@ -183,7 +241,7 @@ Name | Type | Description  | Notes
  **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** | **String**| Which field to use when ordering the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_label_select** | **String**| Filter labels by search string | [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] 
@@ -202,6 +260,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(file_file_distribution_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_file_distribution_href = 'file_file_distribution_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
+  result = api_instance.list_roles(file_file_distribution_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_distribution_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
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(file_file_distribution_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_file_distribution_href = 'file_file_distribution_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
+  result = api_instance.my_permissions(file_file_distribution_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_distribution_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
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
 > AsyncOperationResponse partial_update(file_file_distribution_href, patchedfile_file_distribution)
@@ -316,6 +490,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(file_file_distribution_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_file_distribution_href = 'file_file_distribution_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(file_file_distribution_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_distribution_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## update
 
 > AsyncOperationResponse update(file_file_distribution_href, file_file_distribution)

data/docs/FileFileContent.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **relative_path** | **String** | Path where the artifact is located relative to distributions base_path | 
 **file** | **File** | An uploaded file that may be turned into the artifact of the content unit. | [optional] 
 **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] 
+**upload** | **String** | An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'PulpFileClient'
 instance = PulpFileClient::FileFileContent.new(artifact: null,
                                  relative_path: null,
                                  file: null,
-                                 repository: null)
+                                 repository: null,
+                                 upload: null)
 ```
 
 

data/docs/FileFileRemote.md

@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
 **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
 **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**proxy_password** | **String** | The password to authenticte to the proxy. | [optional] 
+**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
 **username** | **String** | The username to be used for authentication when syncing. | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
 **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**rate_limit** | **Integer** | Limits total download rate in requests per second | [optional] 
+**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
 
 ## Code Sample
 

data/docs/FileFileRemoteResponse.md

@@ -22,7 +22,7 @@ Name | Type | Description | Notes
 **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**rate_limit** | **Integer** | Limits total download rate in requests per second | [optional] 
+**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
 
 ## Code Sample
 

data/docs/MyPermissionsResponse.md

@@ -0,0 +1,17 @@
+# PulpFileClient::MyPermissionsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::MyPermissionsResponse.new(permissions: null)
+```
+
+

data/docs/NestedRole.md

@@ -0,0 +1,21 @@
+# PulpFileClient::NestedRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Array<String>** |  | [optional] 
+**groups** | **Array<String>** |  | [optional] 
+**role** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::NestedRole.new(users: null,
+                                 groups: null,
+                                 role: null)
+```
+
+

data/docs/NestedRoleResponse.md

@@ -0,0 +1,21 @@
+# PulpFileClient::NestedRoleResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Array<String>** |  | [optional] 
+**groups** | **Array<String>** |  | [optional] 
+**role** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::NestedRoleResponse.new(users: null,
+                                 groups: null,
+                                 role: null)
+```
+
+

data/docs/ObjectRolesResponse.md

@@ -0,0 +1,17 @@
+# PulpFileClient::ObjectRolesResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::ObjectRolesResponse.new(roles: null)
+```
+
+

data/docs/PatchedfileFileRemote.md

@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
 **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
 **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**proxy_password** | **String** | The password to authenticte to the proxy. | [optional] 
+**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
 **username** | **String** | The username to be used for authentication when syncing. | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
 **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**rate_limit** | **Integer** | Limits total download rate in requests per second | [optional] 
+**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
 
 ## Code Sample