pulp_ansible_client 0.2.0b1

data/docs/RemotesAnsibleApi.md

@@ -0,0 +1,411 @@
+# PulpAnsibleClient::RemotesAnsibleApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesAnsibleApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/ansible/ | Create an ansible remote
+[**delete**](RemotesAnsibleApi.md#delete) | **DELETE** {ansible_remote_href} | Delete an ansible remote
+[**list**](RemotesAnsibleApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/ansible/ | List ansible remotes
+[**partial_update**](RemotesAnsibleApi.md#partial_update) | **PATCH** {ansible_remote_href} | Partially update an ansible remote
+[**read**](RemotesAnsibleApi.md#read) | **GET** {ansible_remote_href} | Inspect an ansible remote
+[**sync**](RemotesAnsibleApi.md#sync) | **POST** {ansible_remote_href}sync/ | 
+[**update**](RemotesAnsibleApi.md#update) | **PUT** {ansible_remote_href} | Update an ansible remote
+
+
+
+## create
+
+> AnsibleRemote create(data)
+
+Create an ansible remote
+
+ViewSet for Ansible Remotes.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+data = PulpAnsibleClient::AnsibleRemote.new # AnsibleRemote | 
+
+begin
+  #Create an ansible remote
+  result = api_instance.create(data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**AnsibleRemote**](AnsibleRemote.md)|  | 
+
+### Return type
+
+[**AnsibleRemote**](AnsibleRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(ansible_remote_href)
+
+Delete an ansible remote
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+ansible_remote_href = 'ansible_remote_href_example' # String | URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/
+
+begin
+  #Delete an ansible remote
+  result = api_instance.delete(ansible_remote_href)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_remote_href** | **String**| URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/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 ansible remotes
+
+ViewSet for Ansible Remotes.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  _last_updated__lt: '_last_updated__lt_example', # String | Filter results where _last_updated is less than value
+  _last_updated__lte: '_last_updated__lte_example', # String | Filter results where _last_updated is less than or equal to value
+  _last_updated__gt: '_last_updated__gt_example', # String | Filter results where _last_updated is greater than value
+  _last_updated__gte: '_last_updated__gte_example', # String | Filter results where _last_updated is greater than or equal to value
+  _last_updated__range: '_last_updated__range_example', # String | Filter results where _last_updated is between two comma separated values
+  _last_updated: '_last_updated_example', # String | ISO 8601 formatted dates are supported
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List ansible remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->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] 
+ **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional] 
+ **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional] 
+ **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional] 
+ **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional] 
+ **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional] 
+ **_last_updated** | **String**| ISO 8601 formatted dates are supported | [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
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(ansible_remote_href, data)
+
+Partially update an ansible remote
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+ansible_remote_href = 'ansible_remote_href_example' # String | URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/
+data = PulpAnsibleClient::AnsibleRemote.new # AnsibleRemote | 
+
+begin
+  #Partially update an ansible remote
+  result = api_instance.partial_update(ansible_remote_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_remote_href** | **String**| URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/ | 
+ **data** | [**AnsibleRemote**](AnsibleRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> AnsibleRemote read(ansible_remote_href)
+
+Inspect an ansible remote
+
+ViewSet for Ansible Remotes.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+ansible_remote_href = 'ansible_remote_href_example' # String | URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/
+
+begin
+  #Inspect an ansible remote
+  result = api_instance.read(ansible_remote_href)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_remote_href** | **String**| URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/ | 
+
+### Return type
+
+[**AnsibleRemote**](AnsibleRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(ansible_remote_href, data)
+
+
+
+Trigger an asynchronous task to sync Ansible content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+ansible_remote_href = 'ansible_remote_href_example' # String | URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/
+data = PulpAnsibleClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  result = api_instance.sync(ansible_remote_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_remote_href** | **String**| URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/ | 
+ **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(ansible_remote_href, data)
+
+Update an ansible remote
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesAnsibleApi.new
+ansible_remote_href = 'ansible_remote_href_example' # String | URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/
+data = PulpAnsibleClient::AnsibleRemote.new # AnsibleRemote | 
+
+begin
+  #Update an ansible remote
+  result = api_instance.update(ansible_remote_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesAnsibleApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_remote_href** | **String**| URI of Ansible Remote. e.g.: /pulp/api/v3/remotes/ansible/ansible/1/ | 
+ **data** | [**AnsibleRemote**](AnsibleRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+