pulp_file_client 0.1.0b1

data/docs/DistributionsFileApi.md

@@ -0,0 +1,352 @@
+# PulpFileClient::DistributionsFileApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsFileApi.md#create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution
+[**delete**](DistributionsFileApi.md#delete) | **DELETE** {file_distribution_href} | Delete a file distribution
+[**list**](DistributionsFileApi.md#list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions
+[**partial_update**](DistributionsFileApi.md#partial_update) | **PATCH** {file_distribution_href} | Partially update a file distribution
+[**read**](DistributionsFileApi.md#read) | **GET** {file_distribution_href} | Inspect a file distribution
+[**update**](DistributionsFileApi.md#update) | **PUT** {file_distribution_href} | Update a file distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a file distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+data = PulpFileClient::FileDistribution.new # FileDistribution | 
+
+begin
+  #Create a file distribution
+  result = api_instance.create(data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**FileDistribution**](FileDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(file_distribution_href)
+
+Delete a file distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_distribution_href = 'file_distribution_href_example' # String | URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/
+
+begin
+  #Delete a file distribution
+  result = api_instance.delete(file_distribution_href)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_distribution_href** | **String**| URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2001 list(opts)
+
+List file distributions
+
+<!-- User-facing documentation, rendered as html--> FileDistributions host <a href=\"#operation/publications_file_file_list\">File Publications</a> which makes the metadata and the referenced <a href=\"#operation/content_file_files_list\">File Content</a> available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a <a href=\"#operation/remotes_file_file_list\">File Remote</a> , allowing another instance of Pulp to sync the content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  base_path: 'base_path_example', # String | 
+  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
+  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
+  base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List file distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | [optional] 
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
+ **base_path** | **String**|  | [optional] 
+ **base_path__contains** | **String**| Filter results where base_path contains value | [optional] 
+ **base_path__icontains** | **String**| Filter results where base_path contains value | [optional] 
+ **base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(file_distribution_href, data)
+
+Partially update a file distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_distribution_href = 'file_distribution_href_example' # String | URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/
+data = PulpFileClient::FileDistribution.new # FileDistribution | 
+
+begin
+  #Partially update a file distribution
+  result = api_instance.partial_update(file_distribution_href, data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_distribution_href** | **String**| URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/ | 
+ **data** | [**FileDistribution**](FileDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> FileDistribution read(file_distribution_href)
+
+Inspect a file distribution
+
+<!-- User-facing documentation, rendered as html--> FileDistributions host <a href=\"#operation/publications_file_file_list\">File Publications</a> which makes the metadata and the referenced <a href=\"#operation/content_file_files_list\">File Content</a> available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a <a href=\"#operation/remotes_file_file_list\">File Remote</a> , allowing another instance of Pulp to sync the content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_distribution_href = 'file_distribution_href_example' # String | URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/
+
+begin
+  #Inspect a file distribution
+  result = api_instance.read(file_distribution_href)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_distribution_href** | **String**| URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/ | 
+
+### Return type
+
+[**FileDistribution**](FileDistribution.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(file_distribution_href, data)
+
+Update a file distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsFileApi.new
+file_distribution_href = 'file_distribution_href_example' # String | URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/
+data = PulpFileClient::FileDistribution.new # FileDistribution | 
+
+begin
+  #Update a file distribution
+  result = api_instance.update(file_distribution_href, data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsFileApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_distribution_href** | **String**| URI of File Distribution. e.g.: /pulp/api/v3/distributions/file/file/1/ | 
+ **data** | [**FileDistribution**](FileDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FileContent.md

@@ -0,0 +1,37 @@
+# PulpFileClient::FileContent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_href** | **String** |  | [optional] 
+**_artifact** | **String** | Artifact file representing the physical content | 
+**_type** | **String** |  | [optional] 
+**md5** | **String** | The MD5 checksum if available. | [optional] 
+**sha1** | **String** | The SHA-1 checksum if available. | [optional] 
+**sha224** | **String** | The SHA-224 checksum if available. | [optional] 
+**sha256** | **String** | The SHA-256 checksum if available. | [optional] 
+**sha384** | **String** | The SHA-384 checksum if available. | [optional] 
+**sha512** | **String** | The SHA-512 checksum if available. | [optional] 
+**relative_path** | **String** | Relative location of the file within the repository. Example: `path/to/file.txt` | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileContent.new(_created: null,
+                                 _href: null,
+                                 _artifact: null,
+                                 _type: null,
+                                 md5: null,
+                                 sha1: null,
+                                 sha224: null,
+                                 sha256: null,
+                                 sha384: null,
+                                 sha512: null,
+                                 relative_path: null)
+```
+
+

data/docs/FileDistribution.md

@@ -0,0 +1,29 @@
+# PulpFileClient::FileDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**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\") | 
+**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**publication** | **String** | Publication to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileDistribution.new(_href: null,
+                                 _created: null,
+                                 base_path: null,
+                                 base_url: null,
+                                 content_guard: null,
+                                 name: null,
+                                 publication: null)
+```
+
+

data/docs/FilePublication.md

@@ -0,0 +1,31 @@
+# PulpFileClient::FilePublication
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**publisher** | **String** |  | [optional] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+**distributions** | **Array<String>** | This publication is currently hosted as defined by these distributions. | [optional] 
+**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FilePublication.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 publisher: null,
+                                 repository_version: null,
+                                 repository: null,
+                                 distributions: null,
+                                 manifest: null)
+```
+
+

data/docs/FileRemote.md

@@ -0,0 +1,45 @@
+# PulpFileClient::FileRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**name** | **String** | A unique name for this remote. | 
+**url** | **String** | The URL of an external content source. | 
+**ssl_ca_certificate** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional] 
+**ssl_client_certificate** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional] 
+**ssl_client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional] 
+**ssl_validation** | **Boolean** | If True, SSL peer validation must be performed. | [optional] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [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] 
+**_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
+**policy** | **String** | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional] [default to 'immediate']
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileRemote.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 name: null,
+                                 url: null,
+                                 ssl_ca_certificate: null,
+                                 ssl_client_certificate: null,
+                                 ssl_client_key: null,
+                                 ssl_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 _last_updated: null,
+                                 download_concurrency: null,
+                                 policy: null)
+```
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,23 @@
+# PulpFileClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**count** | **Integer** |  | 
+**results** | [**Array<FileContent>**](FileContent.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::InlineResponse200.new(_next: null,
+                                 previous: null,
+                                 count: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,23 @@
+# PulpFileClient::InlineResponse2001
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**count** | **Integer** |  | 
+**results** | [**Array<FileDistribution>**](FileDistribution.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::InlineResponse2001.new(_next: null,
+                                 previous: null,
+                                 count: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,23 @@
+# PulpFileClient::InlineResponse2002
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**count** | **Integer** |  | 
+**results** | [**Array<FilePublication>**](FilePublication.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::InlineResponse2002.new(_next: null,
+                                 previous: null,
+                                 count: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2003.md

@@ -0,0 +1,23 @@
+# PulpFileClient::InlineResponse2003
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**count** | **Integer** |  | 
+**results** | [**Array<FileRemote>**](FileRemote.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::InlineResponse2003.new(_next: null,
+                                 previous: null,
+                                 count: null,
+                                 results: null)
+```
+
+