pulp_python_client 3.0.0b9

data/docs/PythonPythonPublication.md

@@ -0,0 +1,25 @@
+# PulpPythonClient::PythonPythonPublication
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+**distributions** | **Array<String>** | This publication is currently being hosted as configured by these distributions. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonPublication.new(pulp_href: null,
+                                 pulp_created: null,
+                                 repository_version: null,
+                                 repository: null,
+                                 distributions: null)
+```
+
+

data/docs/PythonPythonPublicationRead.md

@@ -0,0 +1,25 @@
+# PulpPythonClient::PythonPythonPublicationRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+**distributions** | **Array<String>** | This publication is currently being hosted as configured by these distributions. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonPublicationRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 repository_version: null,
+                                 repository: null,
+                                 distributions: null)
+```
+
+

data/docs/PythonPythonRemote.md

@@ -0,0 +1,49 @@
+# PulpPythonClient::PythonPythonRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | A unique name for this remote. | 
+**url** | **String** | The URL of an external content source. | 
+**ca_cert** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. | [optional] 
+**client_cert** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. | [optional] 
+**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
+**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
+**policy** | **String** | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional] [default to 'immediate']
+**includes** | [**Array<ProjectSpecifier>**](ProjectSpecifier.md) | AKA \"Whitelist\". A list of dictionaries, expand for more information.         Example:          [{\"name\": \"django\", \"version_specifier\":\"~=2.0\"}]  | [optional] 
+**excludes** | [**Array<ProjectSpecifier>**](ProjectSpecifier.md) | \"AKA \"Blacklist\". A list of dictionaries, expand for more information.         Example:          [{\"name\": \"django\", \"version_specifier\":\"~=2.0\"}]  | [optional] 
+**prereleases** | **Boolean** | Whether or not to include pre-release packages in the sync. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonRemote.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 pulp_last_updated: null,
+                                 download_concurrency: null,
+                                 policy: null,
+                                 includes: null,
+                                 excludes: null,
+                                 prereleases: null)
+```
+
+

data/docs/PythonPythonRemoteRead.md

@@ -0,0 +1,49 @@
+# PulpPythonClient::PythonPythonRemoteRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | A unique name for this remote. | 
+**url** | **String** | The URL of an external content source. | 
+**ca_cert** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. | [optional] 
+**client_cert** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. | [optional] 
+**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
+**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
+**policy** | **String** | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional] [default to 'immediate']
+**includes** | [**Array<ProjectSpecifier>**](ProjectSpecifier.md) | AKA \"Whitelist\". A list of dictionaries, expand for more information.         Example:          [{\"name\": \"django\", \"version_specifier\":\"~=2.0\"}]  | [optional] 
+**excludes** | [**Array<ProjectSpecifier>**](ProjectSpecifier.md) | \"AKA \"Blacklist\". A list of dictionaries, expand for more information.         Example:          [{\"name\": \"django\", \"version_specifier\":\"~=2.0\"}]  | [optional] 
+**prereleases** | **Boolean** | Whether or not to include pre-release packages in the sync. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonRemoteRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 pulp_last_updated: null,
+                                 download_concurrency: null,
+                                 policy: null,
+                                 includes: null,
+                                 excludes: null,
+                                 prereleases: null)
+```
+
+

data/docs/PythonPythonRepository.md

@@ -0,0 +1,27 @@
+# PulpPythonClient::PythonPythonRepository
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**versions_href** | **String** |  | [optional] [readonly] 
+**latest_version_href** | **String** |  | [optional] [readonly] 
+**name** | **String** | A unique name for this repository. | 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonRepository.new(pulp_href: null,
+                                 pulp_created: null,
+                                 versions_href: null,
+                                 latest_version_href: null,
+                                 name: null,
+                                 description: null)
+```
+
+

data/docs/PythonPythonRepositoryRead.md

@@ -0,0 +1,27 @@
+# PulpPythonClient::PythonPythonRepositoryRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**versions_href** | **String** |  | [optional] [readonly] 
+**latest_version_href** | **String** |  | [optional] [readonly] 
+**name** | **String** | A unique name for this repository. | 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PythonPythonRepositoryRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 versions_href: null,
+                                 latest_version_href: null,
+                                 name: null,
+                                 description: null)
+```
+
+

data/docs/RemotesPythonApi.md

@@ -0,0 +1,368 @@
+# PulpPythonClient::RemotesPythonApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
+[**delete**](RemotesPythonApi.md#delete) | **DELETE** {python_remote_href} | Delete a python remote
+[**list**](RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes
+[**partial_update**](RemotesPythonApi.md#partial_update) | **PATCH** {python_remote_href} | Partially update a python remote
+[**read**](RemotesPythonApi.md#read) | **GET** {python_remote_href} | Inspect a python remote
+[**update**](RemotesPythonApi.md#update) | **PUT** {python_remote_href} | Update a python remote
+
+
+
+## create
+
+> PythonPythonRemoteRead create(data)
+
+Create a python remote
+
+ Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
+
+### 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::RemotesPythonApi.new
+data = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote | 
+
+begin
+  #Create a python remote
+  result = api_instance.create(data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PythonPythonRemote**](PythonPythonRemote.md)|  | 
+
+### Return type
+
+[**PythonPythonRemoteRead**](PythonPythonRemoteRead.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(python_remote_href)
+
+Delete a python remote
+
+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::RemotesPythonApi.new
+python_remote_href = 'python_remote_href_example' # String | URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/1/
+
+begin
+  #Delete a python remote
+  result = api_instance.delete(python_remote_href)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_remote_href** | **String**| URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2003 list(opts)
+
+List python remotes
+
+ Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
+
+### 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::RemotesPythonApi.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
+  pulp_last_updated__lt: 'pulp_last_updated__lt_example', # String | Filter results where pulp_last_updated is less than value
+  pulp_last_updated__lte: 'pulp_last_updated__lte_example', # String | Filter results where pulp_last_updated is less than or equal to value
+  pulp_last_updated__gt: 'pulp_last_updated__gt_example', # String | Filter results where pulp_last_updated is greater than value
+  pulp_last_updated__gte: 'pulp_last_updated__gte_example', # String | Filter results where pulp_last_updated is greater than or equal to value
+  pulp_last_updated__range: 'pulp_last_updated__range_example', # String | Filter results where pulp_last_updated is between two comma separated values
+  pulp_last_updated: 'pulp_last_updated_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 remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->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] 
+ **pulp_last_updated__lt** | **String**| Filter results where pulp_last_updated is less than value | [optional] 
+ **pulp_last_updated__lte** | **String**| Filter results where pulp_last_updated is less than or equal to value | [optional] 
+ **pulp_last_updated__gt** | **String**| Filter results where pulp_last_updated is greater than value | [optional] 
+ **pulp_last_updated__gte** | **String**| Filter results where pulp_last_updated is greater than or equal to value | [optional] 
+ **pulp_last_updated__range** | **String**| Filter results where pulp_last_updated is between two comma separated values | [optional] 
+ **pulp_last_updated** | **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
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(python_remote_href, data)
+
+Partially update a python remote
+
+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::RemotesPythonApi.new
+python_remote_href = 'python_remote_href_example' # String | URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/1/
+data = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote | 
+
+begin
+  #Partially update a python remote
+  result = api_instance.partial_update(python_remote_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_remote_href** | **String**| URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/1/ | 
+ **data** | [**PythonPythonRemote**](PythonPythonRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> PythonPythonRemoteRead read(python_remote_href, opts)
+
+Inspect a python remote
+
+ Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
+
+### 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::RemotesPythonApi.new
+python_remote_href = 'python_remote_href_example' # String | URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/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 remote
+  result = api_instance.read(python_remote_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_remote_href** | **String**| URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/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
+
+[**PythonPythonRemoteRead**](PythonPythonRemoteRead.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(python_remote_href, data)
+
+Update a python remote
+
+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::RemotesPythonApi.new
+python_remote_href = 'python_remote_href_example' # String | URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/1/
+data = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote | 
+
+begin
+  #Update a python remote
+  result = api_instance.update(python_remote_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_remote_href** | **String**| URI of Python Remote. e.g.: /pulp/api/v3/remotes/python/python/1/ | 
+ **data** | [**PythonPythonRemote**](PythonPythonRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+