pulp_rpm_client 3.0.0b3.dev.1559835992

data/docs/PublicationsApi.md

@@ -0,0 +1,229 @@
+# PulpRpmClient::PublicationsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**publications_rpm_rpm_create**](PublicationsApi.md#publications_rpm_rpm_create) | **POST** /pulp/api/v3/publications/rpm/rpm/ | Create a rpm publication
+[**publications_rpm_rpm_delete**](PublicationsApi.md#publications_rpm_rpm_delete) | **DELETE** {rpm_publication_href} | Delete a rpm publication
+[**publications_rpm_rpm_list**](PublicationsApi.md#publications_rpm_rpm_list) | **GET** /pulp/api/v3/publications/rpm/rpm/ | List rpm publications
+[**publications_rpm_rpm_read**](PublicationsApi.md#publications_rpm_rpm_read) | **GET** {rpm_publication_href} | Inspect a rpm publication
+
+
+
+## publications_rpm_rpm_create
+
+> AsyncOperationResponse publications_rpm_rpm_create(data)
+
+Create a rpm publication
+
+Trigger an asynchronous task to create a new RPM content publication.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::PublicationsApi.new
+data = PulpRpmClient::RpmPublication.new # RpmPublication | 
+
+begin
+  #Create a rpm publication
+  result = api_instance.publications_rpm_rpm_create(data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling PublicationsApi->publications_rpm_rpm_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**RpmPublication**](RpmPublication.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## publications_rpm_rpm_delete
+
+> publications_rpm_rpm_delete(rpm_publication_href)
+
+Delete a rpm publication
+
+ViewSet for Rpm Publications.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::PublicationsApi.new
+rpm_publication_href = 'rpm_publication_href_example' # String | URI of Rpm Publication. e.g.: /pulp/api/v3/publications/rpm/rpm/1/
+
+begin
+  #Delete a rpm publication
+  api_instance.publications_rpm_rpm_delete(rpm_publication_href)
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling PublicationsApi->publications_rpm_rpm_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_publication_href** | **String**| URI of Rpm Publication. e.g.: /pulp/api/v3/publications/rpm/rpm/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## publications_rpm_rpm_list
+
+> InlineResponse2003 publications_rpm_rpm_list(opts)
+
+List rpm publications
+
+ViewSet for Rpm Publications.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::PublicationsApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List rpm publications
+  result = api_instance.publications_rpm_rpm_list(opts)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling PublicationsApi->publications_rpm_rpm_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [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
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## publications_rpm_rpm_read
+
+> RpmPublication publications_rpm_rpm_read(rpm_publication_href)
+
+Inspect a rpm publication
+
+ViewSet for Rpm Publications.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::PublicationsApi.new
+rpm_publication_href = 'rpm_publication_href_example' # String | URI of Rpm Publication. e.g.: /pulp/api/v3/publications/rpm/rpm/1/
+
+begin
+  #Inspect a rpm publication
+  result = api_instance.publications_rpm_rpm_read(rpm_publication_href)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling PublicationsApi->publications_rpm_rpm_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_publication_href** | **String**| URI of Rpm Publication. e.g.: /pulp/api/v3/publications/rpm/rpm/1/ | 
+
+### Return type
+
+[**RpmPublication**](RpmPublication.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RemotesApi.md

@@ -0,0 +1,412 @@
+# PulpRpmClient::RemotesApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**remotes_rpm_rpm_create**](RemotesApi.md#remotes_rpm_rpm_create) | **POST** /pulp/api/v3/remotes/rpm/rpm/ | Create a rpm remote
+[**remotes_rpm_rpm_delete**](RemotesApi.md#remotes_rpm_rpm_delete) | **DELETE** {rpm_remote_href} | Delete a rpm remote
+[**remotes_rpm_rpm_list**](RemotesApi.md#remotes_rpm_rpm_list) | **GET** /pulp/api/v3/remotes/rpm/rpm/ | List rpm remotes
+[**remotes_rpm_rpm_partial_update**](RemotesApi.md#remotes_rpm_rpm_partial_update) | **PATCH** {rpm_remote_href} | Partially update a rpm remote
+[**remotes_rpm_rpm_read**](RemotesApi.md#remotes_rpm_rpm_read) | **GET** {rpm_remote_href} | Inspect a rpm remote
+[**remotes_rpm_rpm_sync**](RemotesApi.md#remotes_rpm_rpm_sync) | **POST** {rpm_remote_href}sync/ | Sync from remote
+[**remotes_rpm_rpm_update**](RemotesApi.md#remotes_rpm_rpm_update) | **PUT** {rpm_remote_href} | Update a rpm remote
+
+
+
+## remotes_rpm_rpm_create
+
+> RpmRemote remotes_rpm_rpm_create(data)
+
+Create a rpm remote
+
+A ViewSet for RpmRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+data = PulpRpmClient::RpmRemote.new # RpmRemote | 
+
+begin
+  #Create a rpm remote
+  result = api_instance.remotes_rpm_rpm_create(data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**RpmRemote**](RpmRemote.md)|  | 
+
+### Return type
+
+[**RpmRemote**](RpmRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remotes_rpm_rpm_delete
+
+> AsyncOperationResponse remotes_rpm_rpm_delete(rpm_remote_href)
+
+Delete a rpm remote
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+rpm_remote_href = 'rpm_remote_href_example' # String | URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/
+
+begin
+  #Delete a rpm remote
+  result = api_instance.remotes_rpm_rpm_delete(rpm_remote_href)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_remote_href** | **String**| URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remotes_rpm_rpm_list
+
+> InlineResponse2004 remotes_rpm_rpm_list(opts)
+
+List rpm remotes
+
+A ViewSet for RpmRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  _last_updated__lt: '_last_updated__lt_example', # String | Filter results where _last_updated is less than value
+  _last_updated__lte: '_last_updated__lte_example', # String | Filter results where _last_updated is less than or equal to value
+  _last_updated__gt: '_last_updated__gt_example', # String | Filter results where _last_updated is greater than value
+  _last_updated__gte: '_last_updated__gte_example', # String | Filter results where _last_updated is greater than or equal to value
+  _last_updated__range: '_last_updated__range_example', # String | Filter results where _last_updated is between two comma separated values
+  _last_updated: '_last_updated_example', # String | ISO 8601 formatted dates are supported
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List rpm remotes
+  result = api_instance.remotes_rpm_rpm_list(opts)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_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] 
+ **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional] 
+ **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional] 
+ **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional] 
+ **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional] 
+ **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional] 
+ **_last_updated** | **String**| ISO 8601 formatted dates are supported | [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
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remotes_rpm_rpm_partial_update
+
+> AsyncOperationResponse remotes_rpm_rpm_partial_update(rpm_remote_href, data)
+
+Partially update a rpm remote
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+rpm_remote_href = 'rpm_remote_href_example' # String | URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/
+data = PulpRpmClient::RpmRemote.new # RpmRemote | 
+
+begin
+  #Partially update a rpm remote
+  result = api_instance.remotes_rpm_rpm_partial_update(rpm_remote_href, data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_remote_href** | **String**| URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/ | 
+ **data** | [**RpmRemote**](RpmRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remotes_rpm_rpm_read
+
+> RpmRemote remotes_rpm_rpm_read(rpm_remote_href)
+
+Inspect a rpm remote
+
+A ViewSet for RpmRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+rpm_remote_href = 'rpm_remote_href_example' # String | URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/
+
+begin
+  #Inspect a rpm remote
+  result = api_instance.remotes_rpm_rpm_read(rpm_remote_href)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_remote_href** | **String**| URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/ | 
+
+### Return type
+
+[**RpmRemote**](RpmRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remotes_rpm_rpm_sync
+
+> AsyncOperationResponse remotes_rpm_rpm_sync(rpm_remote_href, data)
+
+Sync from remote
+
+Trigger an asynchronous task to sync RPM content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+rpm_remote_href = 'rpm_remote_href_example' # String | URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/
+data = PulpRpmClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  #Sync from remote
+  result = api_instance.remotes_rpm_rpm_sync(rpm_remote_href, data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_remote_href** | **String**| URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/ | 
+ **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remotes_rpm_rpm_update
+
+> AsyncOperationResponse remotes_rpm_rpm_update(rpm_remote_href, data)
+
+Update a rpm remote
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_rpm_client'
+# setup authorization
+PulpRpmClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpRpmClient::RemotesApi.new
+rpm_remote_href = 'rpm_remote_href_example' # String | URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/
+data = PulpRpmClient::RpmRemote.new # RpmRemote | 
+
+begin
+  #Update a rpm remote
+  result = api_instance.remotes_rpm_rpm_update(rpm_remote_href, data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling RemotesApi->remotes_rpm_rpm_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_remote_href** | **String**| URI of Rpm Remote. e.g.: /pulp/api/v3/remotes/rpm/rpm/1/ | 
+ **data** | [**RpmRemote**](RpmRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,19 @@
+# PulpRpmClient::RepositorySyncURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repository** | **String** | A URI of the repository to be synchronized. | 
+**mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpRpmClient'
+
+instance = PulpRpmClient::RepositorySyncURL.new(repository: null,
+                                 mirror: null)
+```
+
+