pulp_python_client 3.0.0b9

data/docs/ContentSummary.md

@@ -0,0 +1,21 @@
+# PulpPythonClient::ContentSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**added** | **Hash<String, Hash<String, String>>** |  | 
+**removed** | **Hash<String, Hash<String, String>>** |  | 
+**present** | **Hash<String, Hash<String, String>>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::ContentSummary.new(added: null,
+                                 removed: null,
+                                 present: null)
+```
+
+

data/docs/DistributionsPypiApi.md

@@ -0,0 +1,364 @@
+# PulpPythonClient::DistributionsPypiApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
+[**delete**](DistributionsPypiApi.md#delete) | **DELETE** {python_distribution_href} | Delete a python distribution
+[**list**](DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions
+[**partial_update**](DistributionsPypiApi.md#partial_update) | **PATCH** {python_distribution_href} | Partially update a python distribution
+[**read**](DistributionsPypiApi.md#read) | **GET** {python_distribution_href} | Inspect a python distribution
+[**update**](DistributionsPypiApi.md#update) | **PUT** {python_distribution_href} | Update a python distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a python distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::DistributionsPypiApi.new
+data = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution | 
+
+begin
+  #Create a python distribution
+  result = api_instance.create(data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling DistributionsPypiApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PythonPythonDistribution**](PythonPythonDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(python_distribution_href)
+
+Delete a python distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::DistributionsPypiApi.new
+python_distribution_href = 'python_distribution_href_example' # String | URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/
+
+begin
+  #Delete a python distribution
+  result = api_instance.delete(python_distribution_href)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling DistributionsPypiApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_distribution_href** | **String**| URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2001 list(opts)
+
+List python distributions
+
+ Pulp Python Distributions are used to distribute Python Publications.  Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::DistributionsPypiApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  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.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List python distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling DistributionsPypiApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **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] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(python_distribution_href, data)
+
+Partially update a python distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::DistributionsPypiApi.new
+python_distribution_href = 'python_distribution_href_example' # String | URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/
+data = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution | 
+
+begin
+  #Partially update a python distribution
+  result = api_instance.partial_update(python_distribution_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling DistributionsPypiApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_distribution_href** | **String**| URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/ | 
+ **data** | [**PythonPythonDistribution**](PythonPythonDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> PythonPythonDistributionRead read(python_distribution_href, opts)
+
+Inspect a python distribution
+
+ Pulp Python Distributions are used to distribute Python Publications.  Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::DistributionsPypiApi.new
+python_distribution_href = 'python_distribution_href_example' # String | URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a python distribution
+  result = api_instance.read(python_distribution_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling DistributionsPypiApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_distribution_href** | **String**| URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PythonPythonDistributionRead**](PythonPythonDistributionRead.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(python_distribution_href, data)
+
+Update a python distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::DistributionsPypiApi.new
+python_distribution_href = 'python_distribution_href_example' # String | URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/
+data = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution | 
+
+begin
+  #Update a python distribution
+  result = api_instance.update(python_distribution_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling DistributionsPypiApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_distribution_href** | **String**| URI of Python Distribution. e.g.: /pulp/api/v3/distributions/python/pypi/1/ | 
+ **data** | [**PythonPythonDistribution**](PythonPythonDistribution.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 @@
+# PulpPythonClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<PythonPythonPackageContentRead>**](PythonPythonPackageContentRead.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::InlineResponse200.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2001.md

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

data/docs/InlineResponse2002.md

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