pulp_file_client 1.10.5 → 1.11.0

data/docs/PublicationsFileApi.md

@@ -4,13 +4,71 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](PublicationsFileApi.md#add_role) | **POST** {file_file_publication_href}add_role/ | 
 [**create**](PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
 [**delete**](PublicationsFileApi.md#delete) | **DELETE** {file_file_publication_href} | Delete a file publication
 [**list**](PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
+[**list_roles**](PublicationsFileApi.md#list_roles) | **GET** {file_file_publication_href}list_roles/ | 
+[**my_permissions**](PublicationsFileApi.md#my_permissions) | **GET** {file_file_publication_href}my_permissions/ | 
 [**read**](PublicationsFileApi.md#read) | **GET** {file_file_publication_href} | Inspect a file publication
+[**remove_role**](PublicationsFileApi.md#remove_role) | **POST** {file_file_publication_href}remove_role/ | 
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(file_file_publication_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::PublicationsFileApi.new
+file_file_publication_href = 'file_file_publication_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(file_file_publication_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_publication_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_publication)
@@ -142,13 +200,14 @@ opts = {
   content__in: 'content__in_example', # String | Content Unit 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', # String | Which field to use when ordering the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
   pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
   pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
   pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
   pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
   pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
+  repository: 'repository_example', # String | Repository referenced by HREF
   repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
   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.
@@ -172,13 +231,14 @@ Name | Type | Description  | Notes
  **content__in** | **String**| Content Unit 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** | **String**| Which field to use when ordering the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
  **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
  **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
  **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
  **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
  **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] 
+ **repository** | **String**| Repository referenced by HREF | [optional] 
  **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [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] 
@@ -197,6 +257,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(file_file_publication_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::PublicationsFileApi.new
+file_file_publication_href = 'file_file_publication_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_publication_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_publication_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_publication_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::PublicationsFileApi.new
+file_file_publication_href = 'file_file_publication_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_publication_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_publication_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
+
+
 ## read
 
 > FileFilePublicationResponse read(file_file_publication_href, opts)
@@ -255,3 +431,57 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## remove_role
+
+> NestedRoleResponse remove_role(file_file_publication_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::PublicationsFileApi.new
+file_file_publication_href = 'file_file_publication_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(file_file_publication_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_publication_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
+

data/docs/RemotesFileApi.md

@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](RemotesFileApi.md#add_role) | **POST** {file_file_remote_href}add_role/ | 
 [**create**](RemotesFileApi.md#create) | **POST** /pulp/api/v3/remotes/file/file/ | Create a file remote
 [**delete**](RemotesFileApi.md#delete) | **DELETE** {file_file_remote_href} | Delete a file remote
 [**list**](RemotesFileApi.md#list) | **GET** /pulp/api/v3/remotes/file/file/ | List file remotes
+[**list_roles**](RemotesFileApi.md#list_roles) | **GET** {file_file_remote_href}list_roles/ | 
+[**my_permissions**](RemotesFileApi.md#my_permissions) | **GET** {file_file_remote_href}my_permissions/ | 
 [**partial_update**](RemotesFileApi.md#partial_update) | **PATCH** {file_file_remote_href} | Update a file remote
 [**read**](RemotesFileApi.md#read) | **GET** {file_file_remote_href} | Inspect a file remote
+[**remove_role**](RemotesFileApi.md#remove_role) | **POST** {file_file_remote_href}remove_role/ | 
 [**update**](RemotesFileApi.md#update) | **PUT** {file_file_remote_href} | Update a file remote
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(file_file_remote_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::RemotesFileApi.new
+file_file_remote_href = 'file_file_remote_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(file_file_remote_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_remote_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
 
 > FileFileRemoteResponse create(file_file_remote)
@@ -148,7 +206,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
   pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
   pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
@@ -181,7 +239,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] 
  **pulp_last_updated** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
  **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional] 
@@ -206,6 +264,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(file_file_remote_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::RemotesFileApi.new
+file_file_remote_href = 'file_file_remote_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_remote_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_remote_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_remote_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::RemotesFileApi.new
+file_file_remote_href = 'file_file_remote_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_remote_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_remote_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_remote_href, patchedfile_file_remote)
@@ -320,6 +494,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(file_file_remote_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::RemotesFileApi.new
+file_file_remote_href = 'file_file_remote_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(file_file_remote_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_remote_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_remote_href, file_file_remote)

data/docs/Repair.md

@@ -0,0 +1,17 @@
+# PulpFileClient::Repair
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**verify_checksums** | **Boolean** | Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::Repair.new(verify_checksums: null)
+```
+
+