pulp_rpm_client 3.0.0b4

data/docs/DistributionsRpmApi.md

@@ -0,0 +1,352 @@
+# PulpRpmClient::DistributionsRpmApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsRpmApi.md#create) | **POST** /pulp/api/v3/distributions/rpm/rpm/ | Create a rpm distribution
+[**delete**](DistributionsRpmApi.md#delete) | **DELETE** {rpm_distribution_href} | Delete a rpm distribution
+[**list**](DistributionsRpmApi.md#list) | **GET** /pulp/api/v3/distributions/rpm/rpm/ | List rpm distributions
+[**partial_update**](DistributionsRpmApi.md#partial_update) | **PATCH** {rpm_distribution_href} | Partially update a rpm distribution
+[**read**](DistributionsRpmApi.md#read) | **GET** {rpm_distribution_href} | Inspect a rpm distribution
+[**update**](DistributionsRpmApi.md#update) | **PUT** {rpm_distribution_href} | Update a rpm distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a rpm distribution
+
+Trigger an asynchronous create 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::DistributionsRpmApi.new
+data = PulpRpmClient::RpmDistribution.new # RpmDistribution | 
+
+begin
+  #Create a rpm distribution
+  result = api_instance.create(data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling DistributionsRpmApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**RpmDistribution**](RpmDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(rpm_distribution_href)
+
+Delete a rpm distribution
+
+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::DistributionsRpmApi.new
+rpm_distribution_href = 'rpm_distribution_href_example' # String | URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/
+
+begin
+  #Delete a rpm distribution
+  result = api_instance.delete(rpm_distribution_href)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling DistributionsRpmApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_distribution_href** | **String**| URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2002 list(opts)
+
+List rpm distributions
+
+ViewSet for RPM Distributions.
+
+### 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::DistributionsRpmApi.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 rpm distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling DistributionsRpmApi->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
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(rpm_distribution_href, data)
+
+Partially update a rpm distribution
+
+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::DistributionsRpmApi.new
+rpm_distribution_href = 'rpm_distribution_href_example' # String | URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/
+data = PulpRpmClient::RpmDistribution.new # RpmDistribution | 
+
+begin
+  #Partially update a rpm distribution
+  result = api_instance.partial_update(rpm_distribution_href, data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling DistributionsRpmApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_distribution_href** | **String**| URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/ | 
+ **data** | [**RpmDistribution**](RpmDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> RpmDistribution read(rpm_distribution_href)
+
+Inspect a rpm distribution
+
+ViewSet for RPM Distributions.
+
+### 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::DistributionsRpmApi.new
+rpm_distribution_href = 'rpm_distribution_href_example' # String | URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/
+
+begin
+  #Inspect a rpm distribution
+  result = api_instance.read(rpm_distribution_href)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling DistributionsRpmApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_distribution_href** | **String**| URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/ | 
+
+### Return type
+
+[**RpmDistribution**](RpmDistribution.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(rpm_distribution_href, data)
+
+Update a rpm distribution
+
+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::DistributionsRpmApi.new
+rpm_distribution_href = 'rpm_distribution_href_example' # String | URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/
+data = PulpRpmClient::RpmDistribution.new # RpmDistribution | 
+
+begin
+  #Update a rpm distribution
+  result = api_instance.update(rpm_distribution_href, data)
+  p result
+rescue PulpRpmClient::ApiError => e
+  puts "Exception when calling DistributionsRpmApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rpm_distribution_href** | **String**| URI of Rpm Distribution. e.g.: /pulp/api/v3/distributions/rpm/rpm/1/ | 
+ **data** | [**RpmDistribution**](RpmDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InlineResponse200.md

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

data/docs/InlineResponse2001.md

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

data/docs/InlineResponse2002.md

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

data/docs/InlineResponse2003.md

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

data/docs/InlineResponse2004.md

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

data/docs/Package.md

@@ -0,0 +1,95 @@
+# PulpRpmClient::Package
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_type** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_artifact** | **String** | Artifact file representing the physical content | 
+**name** | **String** | Name of the package | 
+**epoch** | **String** | The package's epoch | [optional] 
+**version** | **String** | The version of the package. For example, '2.8.0' | 
+**release** | **String** | The release of a particular version of the package. e.g. '1.el7' or '3.f24' | 
+**arch** | **String** | The target architecture for a package.For example, 'x86_64', 'i686', or 'noarch' | 
+**pkg_id** | **String** | Checksum of the package file | 
+**checksum_type** | **String** | Type of checksum, e.g. 'sha256', 'md5' | 
+**summary** | **String** | Short description of the packaged software | [optional] 
+**description** | **String** | In-depth description of the packaged software | [optional] 
+**url** | **String** | URL with more information about the packaged software | [optional] 
+**changelogs** | **String** | Changelogs that package contains | [optional] [default to '[]']
+**files** | **String** | Files that package contains | [optional] [default to '[]']
+**requires** | **String** | Capabilities the package requires | [optional] [default to '[]']
+**provides** | **String** | Capabilities the package provides | [optional] [default to '[]']
+**conflicts** | **String** | Capabilities the package conflicts | [optional] [default to '[]']
+**obsoletes** | **String** | Capabilities the package obsoletes | [optional] [default to '[]']
+**suggests** | **String** | Capabilities the package suggests | [optional] [default to '[]']
+**enhances** | **String** | Capabilities the package enhances | [optional] [default to '[]']
+**recommends** | **String** | Capabilities the package recommends | [optional] [default to '[]']
+**supplements** | **String** | Capabilities the package supplements | [optional] [default to '[]']
+**location_base** | **String** | Base location of this package | [optional] 
+**location_href** | **String** | Relative location of package to the repodata | 
+**rpm_buildhost** | **String** | Hostname of the system that built the package | [optional] 
+**rpm_group** | **String** | RPM group (See: http://fedoraproject.org/wiki/RPMGroups) | [optional] 
+**rpm_license** | **String** | License term applicable to the package software (GPLv2, etc.) | [optional] 
+**rpm_packager** | **String** | Person or persons responsible for creating the package | [optional] 
+**rpm_sourcerpm** | **String** | Name of the source package (srpm) the package was built from | [optional] 
+**rpm_vendor** | **String** | Name of the organization that produced the package | [optional] 
+**rpm_header_start** | **Integer** | First byte of the header | 
+**rpm_header_end** | **Integer** | Last byte of the header | 
+**size_archive** | **Integer** | Size, in bytes, of the archive portion of the original package file | 
+**size_installed** | **Integer** | Total size, in bytes, of every file installed by this package | 
+**size_package** | **Integer** | Size, in bytes, of the package | 
+**time_build** | **Integer** | Time the package was built in seconds since the epoch | 
+**time_file** | **Integer** | The 'file' time attribute in the primary XML - file mtime in seconds since the epoch. | 
+**relative_path** | **String** | File name of the package | 
+
+## Code Sample
+
+```ruby
+require 'PulpRpmClient'
+
+instance = PulpRpmClient::Package.new(_href: null,
+                                 _type: null,
+                                 _created: null,
+                                 _artifact: null,
+                                 name: null,
+                                 epoch: null,
+                                 version: null,
+                                 release: null,
+                                 arch: null,
+                                 pkg_id: null,
+                                 checksum_type: null,
+                                 summary: null,
+                                 description: null,
+                                 url: null,
+                                 changelogs: null,
+                                 files: null,
+                                 requires: null,
+                                 provides: null,
+                                 conflicts: null,
+                                 obsoletes: null,
+                                 suggests: null,
+                                 enhances: null,
+                                 recommends: null,
+                                 supplements: null,
+                                 location_base: null,
+                                 location_href: null,
+                                 rpm_buildhost: null,
+                                 rpm_group: null,
+                                 rpm_license: null,
+                                 rpm_packager: null,
+                                 rpm_sourcerpm: null,
+                                 rpm_vendor: null,
+                                 rpm_header_start: null,
+                                 rpm_header_end: null,
+                                 size_archive: null,
+                                 size_installed: null,
+                                 size_package: null,
+                                 time_build: null,
+                                 time_file: null,
+                                 relative_path: null)
+```
+
+