pulp_deb_client 2.0.0b2

data/docs/PublicationsAptApi.md

@@ -0,0 +1,235 @@
+# PulpDebClient::PublicationsAptApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PublicationsAptApi.md#create) | **POST** /pulp/api/v3/publications/deb/apt/ | Create a deb publication
+[**delete**](PublicationsAptApi.md#delete) | **DELETE** {deb_publication_href} | Delete a deb publication
+[**list**](PublicationsAptApi.md#list) | **GET** /pulp/api/v3/publications/deb/apt/ | List deb publications
+[**read**](PublicationsAptApi.md#read) | **GET** {deb_publication_href} | Inspect a deb publication
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a deb publication
+
+Trigger an asynchronous task to publish content
+
+### 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::PublicationsAptApi.new
+data = PulpDebClient::DebPublication.new # DebPublication | 
+
+begin
+  #Create a deb publication
+  result = api_instance.create(data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsAptApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**DebPublication**](DebPublication.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(deb_publication_href)
+
+Delete a deb publication
+
+A ViewSet for DebPublication.
+
+### 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::PublicationsAptApi.new
+deb_publication_href = 'deb_publication_href_example' # String | URI of Deb Publication. e.g.: /pulp/api/v3/publications/deb/apt/1/
+
+begin
+  #Delete a deb publication
+  api_instance.delete(deb_publication_href)
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsAptApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_publication_href** | **String**| URI of Deb Publication. e.g.: /pulp/api/v3/publications/deb/apt/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2007 list(opts)
+
+List deb publications
+
+A ViewSet for DebPublication.
+
+### 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::PublicationsAptApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  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 publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsAptApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [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
+
+[**InlineResponse2007**](InlineResponse2007.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> DebPublication read(deb_publication_href, opts)
+
+Inspect a deb publication
+
+A ViewSet for DebPublication.
+
+### 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::PublicationsAptApi.new
+deb_publication_href = 'deb_publication_href_example' # String | URI of Deb Publication. e.g.: /pulp/api/v3/publications/deb/apt/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a deb publication
+  result = api_instance.read(deb_publication_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsAptApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_publication_href** | **String**| URI of Deb Publication. e.g.: /pulp/api/v3/publications/deb/apt/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**DebPublication**](DebPublication.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PublicationsVerbatimApi.md

@@ -0,0 +1,235 @@
+# PulpDebClient::PublicationsVerbatimApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PublicationsVerbatimApi.md#create) | **POST** /pulp/api/v3/publications/deb/verbatim/ | Create a verbatim publication
+[**delete**](PublicationsVerbatimApi.md#delete) | **DELETE** {verbatim_publication_href} | Delete a verbatim publication
+[**list**](PublicationsVerbatimApi.md#list) | **GET** /pulp/api/v3/publications/deb/verbatim/ | List verbatim publications
+[**read**](PublicationsVerbatimApi.md#read) | **GET** {verbatim_publication_href} | Inspect a verbatim publication
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a verbatim publication
+
+Trigger an asynchronous task to publish content
+
+### 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::PublicationsVerbatimApi.new
+data = PulpDebClient::VerbatimPublication.new # VerbatimPublication | 
+
+begin
+  #Create a verbatim publication
+  result = api_instance.create(data)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsVerbatimApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**VerbatimPublication**](VerbatimPublication.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(verbatim_publication_href)
+
+Delete a verbatim publication
+
+A ViewSet for VerbatimPublication.
+
+### 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::PublicationsVerbatimApi.new
+verbatim_publication_href = 'verbatim_publication_href_example' # String | URI of Verbatim Publication. e.g.: /pulp/api/v3/publications/deb/verbatim/1/
+
+begin
+  #Delete a verbatim publication
+  api_instance.delete(verbatim_publication_href)
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsVerbatimApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verbatim_publication_href** | **String**| URI of Verbatim Publication. e.g.: /pulp/api/v3/publications/deb/verbatim/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2008 list(opts)
+
+List verbatim publications
+
+A ViewSet for VerbatimPublication.
+
+### 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::PublicationsVerbatimApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  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 verbatim publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsVerbatimApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [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
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> VerbatimPublication read(verbatim_publication_href, opts)
+
+Inspect a verbatim publication
+
+A ViewSet for VerbatimPublication.
+
+### 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::PublicationsVerbatimApi.new
+verbatim_publication_href = 'verbatim_publication_href_example' # String | URI of Verbatim Publication. e.g.: /pulp/api/v3/publications/deb/verbatim/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a verbatim publication
+  result = api_instance.read(verbatim_publication_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling PublicationsVerbatimApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verbatim_publication_href** | **String**| URI of Verbatim Publication. e.g.: /pulp/api/v3/publications/deb/verbatim/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**VerbatimPublication**](VerbatimPublication.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Release.md

@@ -0,0 +1,31 @@
+# PulpDebClient::Release
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**artifacts** | **Hash<String, String>** | A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': '/artifacts/1/' | 
+**codename** | **String** | Codename of the release, i.e. \"buster\". | 
+**suite** | **String** | Suite of the release, i.e. \"stable\". | [optional] 
+**distribution** | **String** | Distribution of the release, i.e. \"stable/updates\". | [optional] 
+**relative_path** | **String** | Path of file relative to url. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpDebClient'
+
+instance = PulpDebClient::Release.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 artifacts: null,
+                                 codename: null,
+                                 suite: null,
+                                 distribution: null,
+                                 relative_path: null)
+```
+
+