pulp_file_client 1.1.0 → 1.2.0

data/docs/RepositoriesFileApi.md

@@ -5,19 +5,19 @@ All URIs are relative to *http://pulp*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create**](RepositoriesFileApi.md#create) | **POST** /pulp/api/v3/repositories/file/file/ | Create a file repository
-[**delete**](RepositoriesFileApi.md#delete) | **DELETE** {file_repository_href} | Delete a file repository
+[**delete**](RepositoriesFileApi.md#delete) | **DELETE** {file_file_repository_href} | Delete a file repository
 [**list**](RepositoriesFileApi.md#list) | **GET** /pulp/api/v3/repositories/file/file/ | List file repositorys
-[**modify**](RepositoriesFileApi.md#modify) | **POST** {file_repository_href}modify/ | Modify Repository Content
-[**partial_update**](RepositoriesFileApi.md#partial_update) | **PATCH** {file_repository_href} | Partially update a file repository
-[**read**](RepositoriesFileApi.md#read) | **GET** {file_repository_href} | Inspect a file repository
-[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_repository_href}sync/ | 
-[**update**](RepositoriesFileApi.md#update) | **PUT** {file_repository_href} | Update a file repository
+[**modify**](RepositoriesFileApi.md#modify) | **POST** {file_file_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesFileApi.md#partial_update) | **PATCH** {file_file_repository_href} | Update a file repository
+[**read**](RepositoriesFileApi.md#read) | **GET** {file_file_repository_href} | Inspect a file repository
+[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_file_repository_href}sync/ | 
+[**update**](RepositoriesFileApi.md#update) | **PUT** {file_file_repository_href} | Update a file repository
 
 
 
 ## create
 
-> FileFileRepository create(data)
+> FileFileRepositoryResponse create(file_file_repository)
 
 Create a file repository
 
@@ -30,17 +30,17 @@ Create a file repository
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-data = PulpFileClient::FileFileRepository.new # FileFileRepository | 
+file_file_repository = PulpFileClient::FileFileRepository.new # FileFileRepository | 
 
 begin
   #Create a file repository
-  result = api_instance.create(data)
+  result = api_instance.create(file_file_repository)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->create: #{e}"
@@ -52,25 +52,25 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **data** | [**FileFileRepository**](FileFileRepository.md)|  | 
+ **file_file_repository** | [**FileFileRepository**](FileFileRepository.md)|  | 
 
 ### Return type
 
-[**FileFileRepository**](FileFileRepository.md)
+[**FileFileRepositoryResponse**](FileFileRepositoryResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## delete
 
-> AsyncOperationResponse delete(file_repository_href)
+> AsyncOperationResponse delete(file_file_repository_href, opts)
 
 Delete a file repository
 
@@ -83,17 +83,22 @@ Trigger an asynchronous delete task
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
 
 begin
   #Delete a file repository
-  result = api_instance.delete(file_repository_href)
+  result = api_instance.delete(file_file_repository_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->delete: #{e}"
@@ -105,7 +110,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ | 
+ **file_file_repository_href** | **String**|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -113,7 +121,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -136,18 +144,18 @@ List file repositorys
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
-  name: 'name_example', # String | 
-  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
   limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
   offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
   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.
 }
@@ -166,11 +174,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
- **name** | **String**|  | [optional] 
- **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [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] 
 
@@ -180,7 +188,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -190,7 +198,7 @@ Name | Type | Description  | Notes
 
 ## modify
 
-> AsyncOperationResponse modify(file_repository_href, data)
+> AsyncOperationResponse modify(file_file_repository_href, repository_add_remove_content)
 
 Modify Repository Content
 
@@ -203,18 +211,18 @@ Trigger an asynchronous task to create a new repository version.
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
-data = PulpFileClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+repository_add_remove_content = PulpFileClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
 
 begin
   #Modify Repository Content
-  result = api_instance.modify(file_repository_href, data)
+  result = api_instance.modify(file_file_repository_href, repository_add_remove_content)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->modify: #{e}"
@@ -226,8 +234,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ | 
- **data** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
+ **file_file_repository_href** | **String**|  | 
+ **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
 
 ### Return type
 
@@ -235,19 +243,19 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(file_repository_href, data)
+> AsyncOperationResponse partial_update(file_file_repository_href, patchedfile_file_repository, opts)
 
-Partially update a file repository
+Update a file repository
 
 Trigger an asynchronous partial update task
 
@@ -258,18 +266,23 @@ Trigger an asynchronous partial update task
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
-data = PulpFileClient::FileFileRepository.new # FileFileRepository | 
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+patchedfile_file_repository = PulpFileClient::PatchedfileFileRepository.new # PatchedfileFileRepository | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
 
 begin
-  #Partially update a file repository
-  result = api_instance.partial_update(file_repository_href, data)
+  #Update a file repository
+  result = api_instance.partial_update(file_file_repository_href, patchedfile_file_repository, opts)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->partial_update: #{e}"
@@ -281,8 +294,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ | 
- **data** | [**FileFileRepository**](FileFileRepository.md)|  | 
+ **file_file_repository_href** | **String**|  | 
+ **patchedfile_file_repository** | [**PatchedfileFileRepository**](PatchedfileFileRepository.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -290,17 +306,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## read
 
-> FileFileRepository read(file_repository_href, opts)
+> FileFileRepositoryResponse read(file_file_repository_href, opts)
 
 Inspect a file repository
 
@@ -313,13 +329,13 @@ Inspect a file repository
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
+file_file_repository_href = 'file_file_repository_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.
@@ -327,7 +343,7 @@ opts = {
 
 begin
   #Inspect a file repository
-  result = api_instance.read(file_repository_href, opts)
+  result = api_instance.read(file_file_repository_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->read: #{e}"
@@ -339,17 +355,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ | 
+ **file_file_repository_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
 
-[**FileFileRepository**](FileFileRepository.md)
+[**FileFileRepositoryResponse**](FileFileRepositoryResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -359,7 +375,7 @@ Name | Type | Description  | Notes
 
 ## sync
 
-> AsyncOperationResponse sync(file_repository_href, data)
+> AsyncOperationResponse sync(file_file_repository_href, repository_sync_url)
 
 
 
@@ -372,17 +388,17 @@ Trigger an asynchronous task to sync file content.
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
-data = PulpFileClient::RepositorySyncURL.new # RepositorySyncURL | 
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+repository_sync_url = PulpFileClient::RepositorySyncURL.new # RepositorySyncURL | 
 
 begin
-  result = api_instance.sync(file_repository_href, data)
+  result = api_instance.sync(file_file_repository_href, repository_sync_url)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->sync: #{e}"
@@ -394,8 +410,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ | 
- **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+ **file_file_repository_href** | **String**|  | 
+ **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
 
 ### Return type
 
@@ -403,17 +419,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## update
 
-> AsyncOperationResponse update(file_repository_href, data)
+> AsyncOperationResponse update(file_file_repository_href, file_file_repository, opts)
 
 Update a file repository
 
@@ -426,18 +442,23 @@ Trigger an asynchronous update task
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpFileClient::RepositoriesFileApi.new
-file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
-data = PulpFileClient::FileFileRepository.new # FileFileRepository | 
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+file_file_repository = PulpFileClient::FileFileRepository.new # FileFileRepository | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
 
 begin
   #Update a file repository
-  result = api_instance.update(file_repository_href, data)
+  result = api_instance.update(file_file_repository_href, file_file_repository, opts)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileApi->update: #{e}"
@@ -449,8 +470,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ | 
- **data** | [**FileFileRepository**](FileFileRepository.md)|  | 
+ **file_file_repository_href** | **String**|  | 
+ **file_file_repository** | [**FileFileRepository**](FileFileRepository.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -458,10 +482,10 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json