pulp_maven_client 0.1.0b2

data/docs/DistributionsApi.md

@@ -0,0 +1,352 @@
+# PulpMavenClient::DistributionsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**distributions_maven_maven_create**](DistributionsApi.md#distributions_maven_maven_create) | **POST** /pulp/api/v3/distributions/maven/maven/ | Create a maven distribution
+[**distributions_maven_maven_delete**](DistributionsApi.md#distributions_maven_maven_delete) | **DELETE** {maven_distribution_href} | Delete a maven distribution
+[**distributions_maven_maven_list**](DistributionsApi.md#distributions_maven_maven_list) | **GET** /pulp/api/v3/distributions/maven/maven/ | List maven distributions
+[**distributions_maven_maven_partial_update**](DistributionsApi.md#distributions_maven_maven_partial_update) | **PATCH** {maven_distribution_href} | Partially update a maven distribution
+[**distributions_maven_maven_read**](DistributionsApi.md#distributions_maven_maven_read) | **GET** {maven_distribution_href} | Inspect a maven distribution
+[**distributions_maven_maven_update**](DistributionsApi.md#distributions_maven_maven_update) | **PUT** {maven_distribution_href} | Update a maven distribution
+
+
+
+## distributions_maven_maven_create
+
+> AsyncOperationResponse distributions_maven_maven_create(data)
+
+Create a maven distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::DistributionsApi.new
+data = PulpMavenClient::MavenDistribution.new # MavenDistribution | 
+
+begin
+  #Create a maven distribution
+  result = api_instance.distributions_maven_maven_create(data)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling DistributionsApi->distributions_maven_maven_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**MavenDistribution**](MavenDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## distributions_maven_maven_delete
+
+> AsyncOperationResponse distributions_maven_maven_delete(maven_distribution_href)
+
+Delete a maven distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::DistributionsApi.new
+maven_distribution_href = 'maven_distribution_href_example' # String | URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/
+
+begin
+  #Delete a maven distribution
+  result = api_instance.distributions_maven_maven_delete(maven_distribution_href)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling DistributionsApi->distributions_maven_maven_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_distribution_href** | **String**| URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## distributions_maven_maven_list
+
+> InlineResponse2001 distributions_maven_maven_list(opts)
+
+List maven distributions
+
+ViewSet for Maven Distributions.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::DistributionsApi.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 maven distributions
+  result = api_instance.distributions_maven_maven_list(opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling DistributionsApi->distributions_maven_maven_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
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## distributions_maven_maven_partial_update
+
+> AsyncOperationResponse distributions_maven_maven_partial_update(maven_distribution_href, data)
+
+Partially update a maven distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::DistributionsApi.new
+maven_distribution_href = 'maven_distribution_href_example' # String | URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/
+data = PulpMavenClient::MavenDistribution.new # MavenDistribution | 
+
+begin
+  #Partially update a maven distribution
+  result = api_instance.distributions_maven_maven_partial_update(maven_distribution_href, data)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling DistributionsApi->distributions_maven_maven_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_distribution_href** | **String**| URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/ | 
+ **data** | [**MavenDistribution**](MavenDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## distributions_maven_maven_read
+
+> MavenDistribution distributions_maven_maven_read(maven_distribution_href)
+
+Inspect a maven distribution
+
+ViewSet for Maven Distributions.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::DistributionsApi.new
+maven_distribution_href = 'maven_distribution_href_example' # String | URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/
+
+begin
+  #Inspect a maven distribution
+  result = api_instance.distributions_maven_maven_read(maven_distribution_href)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling DistributionsApi->distributions_maven_maven_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_distribution_href** | **String**| URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/ | 
+
+### Return type
+
+[**MavenDistribution**](MavenDistribution.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## distributions_maven_maven_update
+
+> AsyncOperationResponse distributions_maven_maven_update(maven_distribution_href, data)
+
+Update a maven distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::DistributionsApi.new
+maven_distribution_href = 'maven_distribution_href_example' # String | URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/
+data = PulpMavenClient::MavenDistribution.new # MavenDistribution | 
+
+begin
+  #Update a maven distribution
+  result = api_instance.distributions_maven_maven_update(maven_distribution_href, data)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling DistributionsApi->distributions_maven_maven_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_distribution_href** | **String**| URI of Maven Distribution. e.g.: /pulp/api/v3/distributions/maven/maven/1/ | 
+ **data** | [**MavenDistribution**](MavenDistribution.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 @@
+# PulpMavenClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**count** | **Integer** |  | 
+**results** | [**Array<MavenArtifact>**](MavenArtifact.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpMavenClient'
+
+instance = PulpMavenClient::InlineResponse200.new(_next: null,
+                                 previous: null,
+                                 count: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2001.md

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

data/docs/InlineResponse2002.md

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

data/docs/MavenArtifact.md

@@ -0,0 +1,33 @@
+# PulpMavenClient::MavenArtifact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**_artifact** | **String** | Artifact file representing the physical content | 
+**_relative_path** | **String** | Path where the artifact is located relative to distributions base_path | 
+**group_id** | **String** | Group Id of the artifact's package. | [optional] 
+**artifact_id** | **String** | Artifact Id of the artifact's package. | [optional] 
+**version** | **String** | Version of the artifact's package. | [optional] 
+**filename** | **String** | Filename of the artifact. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpMavenClient'
+
+instance = PulpMavenClient::MavenArtifact.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 _artifact: null,
+                                 _relative_path: null,
+                                 group_id: null,
+                                 artifact_id: null,
+                                 version: null,
+                                 filename: null)
+```
+
+

data/docs/MavenDistribution.md

@@ -0,0 +1,29 @@
+# PulpMavenClient::MavenDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**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] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpMavenClient'
+
+instance = PulpMavenClient::MavenDistribution.new(_href: null,
+                                 _created: null,
+                                 base_path: null,
+                                 base_url: null,
+                                 content_guard: null,
+                                 name: null,
+                                 remote: null)
+```
+
+

data/docs/MavenRemote.md

@@ -0,0 +1,47 @@
+# PulpMavenClient::MavenRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**name** | **String** | A unique name for this remote. | 
+**url** | **String** | The URL of an external content source. | 
+**validate** | **Boolean** | If True, the plugin will validate imported artifacts. | [optional] 
+**ssl_ca_certificate** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. Returns SHA256 sum on GET. | [optional] 
+**ssl_client_certificate** | **String** | A PEM encoded client certificate used for authentication. Returns SHA256 sum on GET. | [optional] 
+**ssl_client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional] 
+**ssl_validation** | **Boolean** | If True, SSL 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] 
+**_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] 
+**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']
+
+## Code Sample
+
+```ruby
+require 'PulpMavenClient'
+
+instance = PulpMavenClient::MavenRemote.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 name: null,
+                                 url: null,
+                                 validate: null,
+                                 ssl_ca_certificate: null,
+                                 ssl_client_certificate: null,
+                                 ssl_client_key: null,
+                                 ssl_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 _last_updated: null,
+                                 download_concurrency: null,
+                                 policy: null)
+```
+
+