pulp_deb_client 2.0.0b2

data/docs/ContentReleasesApi.md

@@ -0,0 +1,186 @@
+# PulpDebClient::ContentReleasesApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentReleasesApi.md#create) | **POST** /pulp/api/v3/content/deb/releases/ | Create a release
+[**list**](ContentReleasesApi.md#list) | **GET** /pulp/api/v3/content/deb/releases/ | List releases
+[**read**](ContentReleasesApi.md#read) | **GET** {release_href} | Inspect a release
+
+
+
+## create
+
+> Release create(data)
+
+Create a release
+
+A ViewSet for Release.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentReleasesApi.new
+data = PulpDebClient::Release.new # Release | 
+
+begin
+  #Create a release
+  result = api_instance.create(data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentReleasesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**Release**](Release.md)|  | 
+
+### Return type
+
+[**Release**](Release.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2005 list(opts)
+
+List releases
+
+A ViewSet for Release.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentReleasesApi.new
+opts = {
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version 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.
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #List releases
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentReleasesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version 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] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> Release read(release_href, opts)
+
+Inspect a release
+
+A ViewSet for Release.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentReleasesApi.new
+release_href = 'release_href_example' # String | URI of Release. e.g.: /pulp/api/v3/content/deb/releases/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a release
+  result = api_instance.read(release_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentReleasesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **release_href** | **String**| URI of Release. e.g.: /pulp/api/v3/content/deb/releases/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**Release**](Release.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DebDistribution.md

@@ -0,0 +1,29 @@
+# PulpDebClient::DebDistribution
+
+## 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 'PulpDebClient'
+
+instance = PulpDebClient::DebDistribution.new(_href: null,
+                                 _created: null,
+                                 base_path: null,
+                                 base_url: null,
+                                 content_guard: null,
+                                 name: null,
+                                 publication: null)
+```
+
+

data/docs/DebPublication.md

@@ -0,0 +1,31 @@
+# PulpDebClient::DebPublication
+
+## 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] 
+**simple** | **Boolean** | Activate simple publishing mode (all packages in one release component). | [optional] [default to false]
+**structured** | **Boolean** | Activate structured publishing mode. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpDebClient'
+
+instance = PulpDebClient::DebPublication.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 publisher: null,
+                                 repository_version: null,
+                                 repository: null,
+                                 simple: null,
+                                 structured: null)
+```
+
+

data/docs/DebRemote.md

@@ -0,0 +1,57 @@
+# PulpDebClient::DebRemote
+
+## 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']
+**distributions** | **String** | Whitespace separated list of distributions to sync | 
+**components** | **String** | Whitespace separatet list of components to sync | [optional] 
+**architectures** | **String** | Whitespace separated list of architectures to sync | [optional] 
+**sync_sources** | **Boolean** | Sync source packages | [optional] 
+**sync_udebs** | **Boolean** | Sync installer packages | [optional] 
+**sync_installer** | **Boolean** | Sync installer files | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpDebClient'
+
+instance = PulpDebClient::DebRemote.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,
+                                 distributions: null,
+                                 components: null,
+                                 architectures: null,
+                                 sync_sources: null,
+                                 sync_udebs: null,
+                                 sync_installer: null)
+```
+
+

data/docs/DistributionsAptApi.md

@@ -0,0 +1,358 @@
+# PulpDebClient::DistributionsAptApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsAptApi.md#create) | **POST** /pulp/api/v3/distributions/deb/apt/ | Create a deb distribution
+[**delete**](DistributionsAptApi.md#delete) | **DELETE** {deb_distribution_href} | Delete a deb distribution
+[**list**](DistributionsAptApi.md#list) | **GET** /pulp/api/v3/distributions/deb/apt/ | List deb distributions
+[**partial_update**](DistributionsAptApi.md#partial_update) | **PATCH** {deb_distribution_href} | Partially update a deb distribution
+[**read**](DistributionsAptApi.md#read) | **GET** {deb_distribution_href} | Inspect a deb distribution
+[**update**](DistributionsAptApi.md#update) | **PUT** {deb_distribution_href} | Update a deb distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a deb distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::DistributionsAptApi.new
+data = PulpDebClient::DebDistribution.new # DebDistribution | 
+
+begin
+  #Create a deb distribution
+  result = api_instance.create(data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling DistributionsAptApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**DebDistribution**](DebDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(deb_distribution_href)
+
+Delete a deb distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::DistributionsAptApi.new
+deb_distribution_href = 'deb_distribution_href_example' # String | URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/
+
+begin
+  #Delete a deb distribution
+  result = api_instance.delete(deb_distribution_href)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling DistributionsAptApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_distribution_href** | **String**| URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2006 list(opts)
+
+List deb distributions
+
+ViewSet for DebDistributions.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::DistributionsAptApi.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
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #List deb distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling DistributionsAptApi->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] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2006**](InlineResponse2006.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(deb_distribution_href, data)
+
+Partially update a deb distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::DistributionsAptApi.new
+deb_distribution_href = 'deb_distribution_href_example' # String | URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/
+data = PulpDebClient::DebDistribution.new # DebDistribution | 
+
+begin
+  #Partially update a deb distribution
+  result = api_instance.partial_update(deb_distribution_href, data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling DistributionsAptApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_distribution_href** | **String**| URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/ | 
+ **data** | [**DebDistribution**](DebDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> DebDistribution read(deb_distribution_href, opts)
+
+Inspect a deb distribution
+
+ViewSet for DebDistributions.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::DistributionsAptApi.new
+deb_distribution_href = 'deb_distribution_href_example' # String | URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a deb distribution
+  result = api_instance.read(deb_distribution_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling DistributionsAptApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_distribution_href** | **String**| URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**DebDistribution**](DebDistribution.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(deb_distribution_href, data)
+
+Update a deb distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::DistributionsAptApi.new
+deb_distribution_href = 'deb_distribution_href_example' # String | URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/
+data = PulpDebClient::DebDistribution.new # DebDistribution | 
+
+begin
+  #Update a deb distribution
+  result = api_instance.update(deb_distribution_href, data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling DistributionsAptApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_distribution_href** | **String**| URI of Deb Distribution. e.g.: /pulp/api/v3/distributions/deb/apt/1/ | 
+ **data** | [**DebDistribution**](DebDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/GenericContent.md

@@ -0,0 +1,41 @@
+# PulpDebClient::GenericContent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**artifact** | **String** | Artifact file representing the physical content | [optional] 
+**relative_path** | **String** | Path where the artifact is located relative to distributions base_path | 
+**file** | **String** | An uploaded file that should 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] 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'PulpDebClient'
+
+instance = PulpDebClient::GenericContent.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 artifact: null,
+                                 relative_path: null,
+                                 file: null,
+                                 repository: null,
+                                 md5: null,
+                                 sha1: null,
+                                 sha224: null,
+                                 sha256: null,
+                                 sha384: null,
+                                 sha512: null)
+```
+
+