pulp_file_client 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f94978a10aa60c8d0d086d7d473abd0d5e7335e295f693c66c3730e60c59130
-  data.tar.gz: 7a3093a79e98315e3bafbf43517e1d3e66b122bc6a8f6a2ca717c8384769ecec
+  metadata.gz: 7ab1de40c7b3b018b1de914542a49dad0e9d0b654d587a70e298b2bc8a0e3175
+  data.tar.gz: 1eeb8b446e2bfe85bd104ef407ddbb4aec6843af0b055acf7e248e2d1bc91350
 SHA512:
-  metadata.gz: 0d8c75049f0e496022d0e58bcf08c919700a0e076a4c233f631029931339185c62d4aac4c925dabad188558172ab851fffab313d8ecb65880422f0701e37a2f1
-  data.tar.gz: c393c36f1621f6c89446b6d0f184dfdc9e6d1d88b8cf2cc3873e02194ee4236f2aba6ad1672e42aa92266286850991fa3a261f50b21796a030c2acfa6de14e27
+  metadata.gz: 66cf85d087081c62019d70b5662558f8a41100fa9886a42d13409eb4bf5a4c95029880b10749b85ee86a00f68b98374c5e064e7eecae33a890eade9e094c10a2
+  data.tar.gz: e5a8504db98f586de1f4baf2fd886cae8ee886b1402f52a95e65f1eedddac417c0f5acd41aea74c4c05c372b4ee507536e92131427d4be8920a4acda5a7d09cd

data/README.md

@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v3
-- Package version: 1.8.2
+- Package version: 1.9.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://pulpproject.org](https://pulpproject.org)
 
@@ -24,16 +24,16 @@ gem build pulp_file_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pulp_file_client-1.8.2.gem
+gem install ./pulp_file_client-1.9.0.gem
 ```
 
-(for development, run `gem install --dev ./pulp_file_client-1.8.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pulp_file_client-1.9.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'pulp_file_client', '~> 1.8.2'
+    gem 'pulp_file_client', '~> 1.9.0'
 
 ### Install from Git
 
@@ -64,30 +64,32 @@ PulpFileClient.configure do |config|
   config.password = 'YOUR_PASSWORD'
 end
 
-api_instance = PulpFileClient::ContentFilesApi.new
-relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
-opts = {
-  artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
-  repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
-}
+api_instance = PulpFileClient::AcsFileApi.new
+file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource | 
 
 begin
-  #Create a file content
-  result = api_instance.create(relative_path, opts)
+  #Create a file alternate content source
+  result = api_instance.create(file_file_alternate_content_source)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling ContentFilesApi->create: #{e}"
+  puts "Exception when calling AcsFileApi->create: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *http://pulp*
+All URIs are relative to *https://pulp*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*PulpFileClient::AcsFileApi* | [**create**](docs/AcsFileApi.md#create) | **POST** /pulp/api/v3/acs/file/file/ | Create a file alternate content source
+*PulpFileClient::AcsFileApi* | [**delete**](docs/AcsFileApi.md#delete) | **DELETE** {file_file_alternate_content_source_href} | Delete a file alternate content source
+*PulpFileClient::AcsFileApi* | [**list**](docs/AcsFileApi.md#list) | **GET** /pulp/api/v3/acs/file/file/ | List file alternate content sources
+*PulpFileClient::AcsFileApi* | [**partial_update**](docs/AcsFileApi.md#partial_update) | **PATCH** {file_file_alternate_content_source_href} | Update a file alternate content source
+*PulpFileClient::AcsFileApi* | [**read**](docs/AcsFileApi.md#read) | **GET** {file_file_alternate_content_source_href} | Inspect a file alternate content source
+*PulpFileClient::AcsFileApi* | [**refresh**](docs/AcsFileApi.md#refresh) | **POST** {file_file_alternate_content_source_href}refresh/ | 
+*PulpFileClient::AcsFileApi* | [**update**](docs/AcsFileApi.md#update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source
 *PulpFileClient::ContentFilesApi* | [**create**](docs/ContentFilesApi.md#create) | **POST** /pulp/api/v3/content/file/files/ | Create a file content
 *PulpFileClient::ContentFilesApi* | [**list**](docs/ContentFilesApi.md#list) | **GET** /pulp/api/v3/content/file/files/ | List file contents
 *PulpFileClient::ContentFilesApi* | [**read**](docs/ContentFilesApi.md#read) | **GET** {file_file_content_href} | Inspect a file content
@@ -126,6 +128,8 @@ Class | Method | HTTP request | Description
  - [PulpFileClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
  - [PulpFileClient::ContentSummary](docs/ContentSummary.md)
  - [PulpFileClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
+ - [PulpFileClient::FileFileAlternateContentSource](docs/FileFileAlternateContentSource.md)
+ - [PulpFileClient::FileFileAlternateContentSourceResponse](docs/FileFileAlternateContentSourceResponse.md)
  - [PulpFileClient::FileFileContent](docs/FileFileContent.md)
  - [PulpFileClient::FileFileContentResponse](docs/FileFileContentResponse.md)
  - [PulpFileClient::FileFileDistribution](docs/FileFileDistribution.md)
@@ -137,11 +141,13 @@ Class | Method | HTTP request | Description
  - [PulpFileClient::FileFileRepository](docs/FileFileRepository.md)
  - [PulpFileClient::FileFileRepositoryResponse](docs/FileFileRepositoryResponse.md)
  - [PulpFileClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
+ - [PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList](docs/PaginatedfileFileAlternateContentSourceResponseList.md)
  - [PulpFileClient::PaginatedfileFileContentResponseList](docs/PaginatedfileFileContentResponseList.md)
  - [PulpFileClient::PaginatedfileFileDistributionResponseList](docs/PaginatedfileFileDistributionResponseList.md)
  - [PulpFileClient::PaginatedfileFilePublicationResponseList](docs/PaginatedfileFilePublicationResponseList.md)
  - [PulpFileClient::PaginatedfileFileRemoteResponseList](docs/PaginatedfileFileRemoteResponseList.md)
  - [PulpFileClient::PaginatedfileFileRepositoryResponseList](docs/PaginatedfileFileRepositoryResponseList.md)
+ - [PulpFileClient::PatchedfileFileAlternateContentSource](docs/PatchedfileFileAlternateContentSource.md)
  - [PulpFileClient::PatchedfileFileDistribution](docs/PatchedfileFileDistribution.md)
  - [PulpFileClient::PatchedfileFileRemote](docs/PatchedfileFileRemote.md)
  - [PulpFileClient::PatchedfileFileRepository](docs/PatchedfileFileRepository.md)

data/docs/AcsFileApi.md

@@ -0,0 +1,416 @@
+# PulpFileClient::AcsFileApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](AcsFileApi.md#create) | **POST** /pulp/api/v3/acs/file/file/ | Create a file alternate content source
+[**delete**](AcsFileApi.md#delete) | **DELETE** {file_file_alternate_content_source_href} | Delete a file alternate content source
+[**list**](AcsFileApi.md#list) | **GET** /pulp/api/v3/acs/file/file/ | List file alternate content sources
+[**partial_update**](AcsFileApi.md#partial_update) | **PATCH** {file_file_alternate_content_source_href} | Update a file alternate content source
+[**read**](AcsFileApi.md#read) | **GET** {file_file_alternate_content_source_href} | Inspect a file alternate content source
+[**refresh**](AcsFileApi.md#refresh) | **POST** {file_file_alternate_content_source_href}refresh/ | 
+[**update**](AcsFileApi.md#update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source
+
+
+
+## create
+
+> FileFileAlternateContentSourceResponse create(file_file_alternate_content_source)
+
+Create a file alternate content source
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource | 
+
+begin
+  #Create a file alternate content source
+  result = api_instance.create(file_file_alternate_content_source)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_alternate_content_source** | [**FileFileAlternateContentSource**](FileFileAlternateContentSource.md)|  | 
+
+### Return type
+
+[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.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
+
+> delete(file_file_alternate_content_source_href)
+
+Delete a file alternate content source
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | 
+
+begin
+  #Delete a file alternate content source
+  api_instance.delete(file_file_alternate_content_source_href)
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_alternate_content_source_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> PaginatedfileFileAlternateContentSourceResponseList list(opts)
+
+List file alternate content sources
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  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', # 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.
+}
+
+begin
+  #List file alternate content sources
+  result = api_instance.list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**|  | [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** | **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] 
+
+### Return type
+
+[**PaginatedfileFileAlternateContentSourceResponseList**](PaginatedfileFileAlternateContentSourceResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> FileFileAlternateContentSourceResponse partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
+
+Update a file alternate content source
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | 
+patchedfile_file_alternate_content_source = PulpFileClient::PatchedfileFileAlternateContentSource.new # PatchedfileFileAlternateContentSource | 
+
+begin
+  #Update a file alternate content source
+  result = api_instance.partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_alternate_content_source_href** | **String**|  | 
+ **patchedfile_file_alternate_content_source** | [**PatchedfileFileAlternateContentSource**](PatchedfileFileAlternateContentSource.md)|  | 
+
+### Return type
+
+[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.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
+
+> FileFileAlternateContentSourceResponse read(file_file_alternate_content_source_href, opts)
+
+Inspect a file alternate content source
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+file_file_alternate_content_source_href = 'file_file_alternate_content_source_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
+  #Inspect a file alternate content source
+  result = api_instance.read(file_file_alternate_content_source_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_alternate_content_source_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
+
+[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## refresh
+
+> FileFileAlternateContentSourceResponse refresh(file_file_alternate_content_source_href, file_file_alternate_content_source)
+
+
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | 
+file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource | 
+
+begin
+  result = api_instance.refresh(file_file_alternate_content_source_href, file_file_alternate_content_source)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->refresh: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_alternate_content_source_href** | **String**|  | 
+ **file_file_alternate_content_source** | [**FileFileAlternateContentSource**](FileFileAlternateContentSource.md)|  | 
+
+### Return type
+
+[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.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
+
+> FileFileAlternateContentSourceResponse update(file_file_alternate_content_source_href, file_file_alternate_content_source)
+
+Update a file alternate content source
+
+Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
+
+### 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::AcsFileApi.new
+file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | 
+file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource | 
+
+begin
+  #Update a file alternate content source
+  result = api_instance.update(file_file_alternate_content_source_href, file_file_alternate_content_source)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling AcsFileApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_alternate_content_source_href** | **String**|  | 
+ **file_file_alternate_content_source** | [**FileFileAlternateContentSource**](FileFileAlternateContentSource.md)|  | 
+
+### Return type
+
+[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+