pulp_deb_client 2.0.0b2

data/docs/ContentInstallerPackagesApi.md

@@ -0,0 +1,194 @@
+# PulpDebClient::ContentInstallerPackagesApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentInstallerPackagesApi.md#create) | **POST** /pulp/api/v3/content/deb/installer_packages/ | Create an installer package
+[**list**](ContentInstallerPackagesApi.md#list) | **GET** /pulp/api/v3/content/deb/installer_packages/ | List installer packages
+[**read**](ContentInstallerPackagesApi.md#read) | **GET** {installer_package_href} | Inspect an installer package
+
+
+
+## create
+
+> AsyncOperationResponse create(opts)
+
+Create an installer package
+
+Trigger an asynchronous task to create content,optionally create new repository version.
+
+### 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::ContentInstallerPackagesApi.new
+opts = {
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path
+  file: File.new('/path/to/file'), # File | An uploaded file that should 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.
+}
+
+begin
+  #Create an installer package
+  result = api_instance.create(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentInstallerPackagesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **artifact** | **String**| Artifact file representing the physical content | [optional] 
+ **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | [optional] 
+ **file** | **File**| 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] 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2002 list(opts)
+
+List installer packages
+
+A ViewSet for InstallerPackage.
+
+### 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::ContentInstallerPackagesApi.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 installer packages
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentInstallerPackagesApi->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
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> InstallerPackage read(installer_package_href, opts)
+
+Inspect an installer package
+
+A ViewSet for InstallerPackage.
+
+### 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::ContentInstallerPackagesApi.new
+installer_package_href = 'installer_package_href_example' # String | URI of Installer Package. e.g.: /pulp/api/v3/content/deb/installer_packages/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect an installer package
+  result = api_instance.read(installer_package_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentInstallerPackagesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **installer_package_href** | **String**| URI of Installer Package. e.g.: /pulp/api/v3/content/deb/installer_packages/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**InstallerPackage**](InstallerPackage.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentPackageIndexApi.md

@@ -0,0 +1,186 @@
+# PulpDebClient::ContentPackageIndexApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentPackageIndexApi.md#create) | **POST** /pulp/api/v3/content/deb/package_index/ | Create a package index
+[**list**](ContentPackageIndexApi.md#list) | **GET** /pulp/api/v3/content/deb/package_index/ | List PackageIndices
+[**read**](ContentPackageIndexApi.md#read) | **GET** {package_index_href} | Inspect a package index
+
+
+
+## create
+
+> PackageIndex create(data)
+
+Create a package index
+
+A ViewSet for PackageIndex.
+
+### 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::ContentPackageIndexApi.new
+data = PulpDebClient::PackageIndex.new # PackageIndex | 
+
+begin
+  #Create a package index
+  result = api_instance.create(data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentPackageIndexApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PackageIndex**](PackageIndex.md)|  | 
+
+### Return type
+
+[**PackageIndex**](PackageIndex.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2003 list(opts)
+
+List PackageIndices
+
+A ViewSet for PackageIndex.
+
+### 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::ContentPackageIndexApi.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 PackageIndices
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentPackageIndexApi->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
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> PackageIndex read(package_index_href, opts)
+
+Inspect a package index
+
+A ViewSet for PackageIndex.
+
+### 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::ContentPackageIndexApi.new
+package_index_href = 'package_index_href_example' # String | URI of Package Index. e.g.: /pulp/api/v3/content/deb/package_index/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a package index
+  result = api_instance.read(package_index_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentPackageIndexApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_index_href** | **String**| URI of Package Index. e.g.: /pulp/api/v3/content/deb/package_index/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**PackageIndex**](PackageIndex.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentPackagesApi.md

@@ -0,0 +1,194 @@
+# PulpDebClient::ContentPackagesApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/deb/packages/ | Create a package
+[**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/deb/packages/ | List packages
+[**read**](ContentPackagesApi.md#read) | **GET** {package_href} | Inspect a package
+
+
+
+## create
+
+> AsyncOperationResponse create(opts)
+
+Create a package
+
+Trigger an asynchronous task to create content,optionally create new repository version.
+
+### 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::ContentPackagesApi.new
+opts = {
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path
+  file: File.new('/path/to/file'), # File | An uploaded file that should 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.
+}
+
+begin
+  #Create a package
+  result = api_instance.create(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **artifact** | **String**| Artifact file representing the physical content | [optional] 
+ **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | [optional] 
+ **file** | **File**| 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] 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2004 list(opts)
+
+List packages
+
+A ViewSet for Package.
+
+### 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::ContentPackagesApi.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 packages
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->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
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> Package read(package_href, opts)
+
+Inspect a package
+
+A ViewSet for Package.
+
+### 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::ContentPackagesApi.new
+package_href = 'package_href_example' # String | URI of Package. e.g.: /pulp/api/v3/content/deb/packages/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a package
+  result = api_instance.read(package_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_href** | **String**| URI of Package. e.g.: /pulp/api/v3/content/deb/packages/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**Package**](Package.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+