pulp_python_client 3.0.0b9

data/docs/InlineResponse2003.md

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

data/docs/InlineResponse2004.md

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

data/docs/InlineResponse2005.md

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

data/docs/ProjectSpecifier.md

@@ -0,0 +1,19 @@
+# PulpPythonClient::ProjectSpecifier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A python project name. | 
+**version_specifier** | **String** | A version specifier accepts standard python versions syntax: `>=`, `<=`, `==`, `~=`, `>`, `<`, `!` and can be used in conjunction with other specifiers i.e. `>1`,`<=3`,`!=3.0.2`. Note that the specifiers treat pre-released versions as `<` released versions, so 3.0.0a1 < 3.0.0. Not setting the version_specifier will sync all the pre-released and released versions. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::ProjectSpecifier.new(name: null,
+                                 version_specifier: null)
+```
+
+

data/docs/PublicationsPypiApi.md

@@ -0,0 +1,253 @@
+# PulpPythonClient::PublicationsPypiApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication
+[**delete**](PublicationsPypiApi.md#delete) | **DELETE** {python_publication_href} | Delete a python publication
+[**list**](PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications
+[**read**](PublicationsPypiApi.md#read) | **GET** {python_publication_href} | Inspect a python publication
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a python publication
+
+Trigger an asynchronous task to publish python 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::PublicationsPypiApi.new
+data = PulpPythonClient::PythonPythonPublication.new # PythonPythonPublication | 
+
+begin
+  #Create a python publication
+  result = api_instance.create(data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PythonPythonPublication**](PythonPythonPublication.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(python_publication_href)
+
+Delete a python publication
+
+ Python Publications refer to the Python Package content in a repository version, and include metadata about that 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::PublicationsPypiApi.new
+python_publication_href = 'python_publication_href_example' # String | URI of Python Publication. e.g.: /pulp/api/v3/publications/python/pypi/1/
+
+begin
+  #Delete a python publication
+  api_instance.delete(python_publication_href)
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_publication_href** | **String**| URI of Python Publication. e.g.: /pulp/api/v3/publications/python/pypi/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2002 list(opts)
+
+List python publications
+
+ Python Publications refer to the Python Package content in a repository version, and include metadata about that 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::PublicationsPypiApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  pulp_created__lt: 'pulp_created__lt_example', # String | Filter results where pulp_created is less than value
+  pulp_created__lte: 'pulp_created__lte_example', # String | Filter results where pulp_created is less than or equal to value
+  pulp_created__gt: 'pulp_created__gt_example', # String | Filter results where pulp_created is greater than value
+  pulp_created__gte: 'pulp_created__gte_example', # String | Filter results where pulp_created is greater than or equal to value
+  pulp_created__range: 'pulp_created__range_example', # String | Filter results where pulp_created is between two comma separated values
+  pulp_created: 'pulp_created_example', # String | ISO 8601 formatted dates are supported
+  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 publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **pulp_created__lt** | **String**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **String**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__gt** | **String**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **String**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__range** | **String**| Filter results where pulp_created is between two comma separated values | [optional] 
+ **pulp_created** | **String**| ISO 8601 formatted dates are supported | [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
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> PythonPythonPublicationRead read(python_publication_href, opts)
+
+Inspect a python publication
+
+ Python Publications refer to the Python Package content in a repository version, and include metadata about that 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::PublicationsPypiApi.new
+python_publication_href = 'python_publication_href_example' # String | URI of Python Publication. e.g.: /pulp/api/v3/publications/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 publication
+  result = api_instance.read(python_publication_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_publication_href** | **String**| URI of Python Publication. e.g.: /pulp/api/v3/publications/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
+
+[**PythonPythonPublicationRead**](PythonPythonPublicationRead.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PythonPythonDistribution.md

@@ -0,0 +1,29 @@
+# PulpPythonClient::PythonPythonDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | 
+**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**publication** | **String** | Publication to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonDistribution.new(pulp_href: null,
+                                 pulp_created: null,
+                                 base_path: null,
+                                 base_url: null,
+                                 content_guard: null,
+                                 name: null,
+                                 publication: null)
+```
+
+

data/docs/PythonPythonDistributionRead.md

@@ -0,0 +1,29 @@
+# PulpPythonClient::PythonPythonDistributionRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | 
+**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**publication** | **String** | Publication to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonDistributionRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 base_path: null,
+                                 base_url: null,
+                                 content_guard: null,
+                                 name: null,
+                                 publication: null)
+```
+
+

data/docs/PythonPythonPackageContentRead.md

@@ -0,0 +1,69 @@
+# PulpPythonClient::PythonPythonPackageContentRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**artifact** | **String** | Artifact file representing the physical content | [optional] 
+**filename** | **String** | The name of the distribution package, usually of the format: {distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.{packagetype} | 
+**packagetype** | **String** | The type of the distribution package (e.g. sdist, bdist_wheel, bdist_egg, etc) | [optional] [readonly] 
+**name** | **String** | The name of the python project. | [optional] [readonly] 
+**version** | **String** | The packages version number. | [optional] [readonly] 
+**metadata_version** | **String** | Version of the file format | [optional] [readonly] 
+**summary** | **String** | A one-line summary of what the package does. | [optional] 
+**description** | **String** | A longer description of the package that can run to several paragraphs. | [optional] 
+**keywords** | **String** | Additional keywords to be used to assist searching for the package in a larger catalog. | [optional] 
+**home_page** | **String** | The URL for the package's home page. | [optional] 
+**download_url** | **String** | Legacy field denoting the URL from which this package can be downloaded. | [optional] 
+**author** | **String** | Text containing the author's name. Contact information can also be added, separated with newlines. | [optional] 
+**author_email** | **String** | The author's e-mail address.  | [optional] 
+**maintainer** | **String** | The maintainer's name at a minimum; additional contact information may be provided. | [optional] 
+**maintainer_email** | **String** | The maintainer's e-mail address. | [optional] 
+**license** | **String** | Text indicating the license covering the distribution | [optional] 
+**requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional] 
+**project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional] 
+**platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional] 
+**supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled.  | [optional] 
+**requires_dist** | [**Object**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional] 
+**provides_dist** | [**Object**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional] 
+**obsoletes_dist** | [**Object**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional] 
+**requires_external** | [**Object**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional] 
+**classifiers** | [**Object**](.md) | A JSON list containing classification values for a Python package. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonPackageContentRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifact: null,
+                                 filename: null,
+                                 packagetype: null,
+                                 name: null,
+                                 version: null,
+                                 metadata_version: null,
+                                 summary: null,
+                                 description: null,
+                                 keywords: null,
+                                 home_page: null,
+                                 download_url: null,
+                                 author: null,
+                                 author_email: null,
+                                 maintainer: null,
+                                 maintainer_email: null,
+                                 license: null,
+                                 requires_python: null,
+                                 project_url: null,
+                                 platform: null,
+                                 supported_platform: null,
+                                 requires_dist: null,
+                                 provides_dist: null,
+                                 obsoletes_dist: null,
+                                 requires_external: null,
+                                 classifiers: null)
+```
+
+