pulp_gem_client 0.1.0

data/docs/RepositoriesGemApi.md

@@ -0,0 +1,502 @@
+# PulpGemClient::RepositoriesGemApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RepositoriesGemApi.md#create) | **POST** /pulp/api/v3/repositories/gem/gem/ | Create a gem repository
+[**delete**](RepositoriesGemApi.md#delete) | **DELETE** {gem_gem_repository_href} | Delete a gem repository
+[**list**](RepositoriesGemApi.md#list) | **GET** /pulp/api/v3/repositories/gem/gem/ | List gem repositorys
+[**modify**](RepositoriesGemApi.md#modify) | **POST** {gem_gem_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesGemApi.md#partial_update) | **PATCH** {gem_gem_repository_href} | Update a gem repository
+[**read**](RepositoriesGemApi.md#read) | **GET** {gem_gem_repository_href} | Inspect a gem repository
+[**sync**](RepositoriesGemApi.md#sync) | **POST** {gem_gem_repository_href}sync/ | Sync from a remote
+[**update**](RepositoriesGemApi.md#update) | **PUT** {gem_gem_repository_href} | Update a gem repository
+
+
+
+## create
+
+> GemGemRepositoryResponse create(gem_gem_repository)
+
+Create a gem repository
+
+A ViewSet for GemRepository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository = PulpGemClient::GemGemRepository.new # GemGemRepository | 
+
+begin
+  #Create a gem repository
+  result = api_instance.create(gem_gem_repository)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository** | [**GemGemRepository**](GemGemRepository.md)|  | 
+
+### Return type
+
+[**GemGemRepositoryResponse**](GemGemRepositoryResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(gem_gem_repository_href)
+
+Delete a gem repository
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository_href = 'gem_gem_repository_href_example' # String | 
+
+begin
+  #Delete a gem repository
+  result = api_instance.delete(gem_gem_repository_href)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedgemGemRepositoryResponseList list(opts)
+
+List gem repositorys
+
+A ViewSet for GemRepository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+opts = {
+  latest_with_content: 'latest_with_content_example', # String | Content Unit referenced by HREF
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  remote: 'remote_example', # String | Foreign Key referenced by HREF
+  retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value
+  retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value
+  retain_repo_versions__gte: 56, # Integer | Filter results where retain_repo_versions is greater than or equal to value
+  retain_repo_versions__isnull: true, # Boolean | Filter results where retain_repo_versions has a null value
+  retain_repo_versions__lt: 56, # Integer | Filter results where retain_repo_versions is less than value
+  retain_repo_versions__lte: 56, # Integer | Filter results where retain_repo_versions is less than or equal to value
+  retain_repo_versions__ne: 56, # Integer | Filter results where retain_repo_versions not equal to value
+  retain_repo_versions__range: [56], # Array<Integer> | Filter results where retain_repo_versions is between two comma separated values
+  with_content: 'with_content_example', # String | Content Unit referenced by HREF
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List gem repositorys
+  result = api_instance.list(opts)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest_with_content** | **String**| Content Unit referenced by HREF | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;next_version&#x60; - Next version * &#x60;-next_version&#x60; - Next version (descending) * &#x60;retain_repo_versions&#x60; - Retain repo versions * &#x60;-retain_repo_versions&#x60; - Retain repo versions (descending) * &#x60;user_hidden&#x60; - User hidden * &#x60;-user_hidden&#x60; - User hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_label_select** | **String**| Filter labels by search string | [optional] 
+ **remote** | **String**| Foreign Key referenced by HREF | [optional] 
+ **retain_repo_versions** | **Integer**| Filter results where retain_repo_versions matches value | [optional] 
+ **retain_repo_versions__gt** | **Integer**| Filter results where retain_repo_versions is greater than value | [optional] 
+ **retain_repo_versions__gte** | **Integer**| Filter results where retain_repo_versions is greater than or equal to value | [optional] 
+ **retain_repo_versions__isnull** | **Boolean**| Filter results where retain_repo_versions has a null value | [optional] 
+ **retain_repo_versions__lt** | **Integer**| Filter results where retain_repo_versions is less than value | [optional] 
+ **retain_repo_versions__lte** | **Integer**| Filter results where retain_repo_versions is less than or equal to value | [optional] 
+ **retain_repo_versions__ne** | **Integer**| Filter results where retain_repo_versions not equal to value | [optional] 
+ **retain_repo_versions__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where retain_repo_versions is between two comma separated values | [optional] 
+ **with_content** | **String**| Content Unit referenced by HREF | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedgemGemRepositoryResponseList**](PaginatedgemGemRepositoryResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## modify
+
+> AsyncOperationResponse modify(gem_gem_repository_href, repository_add_remove_content)
+
+Modify Repository Content
+
+Trigger an asynchronous task to create a new repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository_href = 'gem_gem_repository_href_example' # String | 
+repository_add_remove_content = PulpGemClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+
+begin
+  #Modify Repository Content
+  result = api_instance.modify(gem_gem_repository_href, repository_add_remove_content)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository_href** | **String**|  | 
+ **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(gem_gem_repository_href, patchedgem_gem_repository)
+
+Update a gem repository
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository_href = 'gem_gem_repository_href_example' # String | 
+patchedgem_gem_repository = PulpGemClient::PatchedgemGemRepository.new # PatchedgemGemRepository | 
+
+begin
+  #Update a gem repository
+  result = api_instance.partial_update(gem_gem_repository_href, patchedgem_gem_repository)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository_href** | **String**|  | 
+ **patchedgem_gem_repository** | [**PatchedgemGemRepository**](PatchedgemGemRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## read
+
+> GemGemRepositoryResponse read(gem_gem_repository_href, opts)
+
+Inspect a gem repository
+
+A ViewSet for GemRepository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository_href = 'gem_gem_repository_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a gem repository
+  result = api_instance.read(gem_gem_repository_href, opts)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**GemGemRepositoryResponse**](GemGemRepositoryResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(gem_gem_repository_href, repository_sync_url)
+
+Sync from a remote
+
+Trigger an asynchronous task to sync gem content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository_href = 'gem_gem_repository_href_example' # String | 
+repository_sync_url = PulpGemClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  #Sync from a remote
+  result = api_instance.sync(gem_gem_repository_href, repository_sync_url)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository_href** | **String**|  | 
+ **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(gem_gem_repository_href, gem_gem_repository)
+
+Update a gem repository
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::RepositoriesGemApi.new
+gem_gem_repository_href = 'gem_gem_repository_href_example' # String | 
+gem_gem_repository = PulpGemClient::GemGemRepository.new # GemGemRepository | 
+
+begin
+  #Update a gem repository
+  result = api_instance.update(gem_gem_repository_href, gem_gem_repository)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling RepositoriesGemApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_repository_href** | **String**|  | 
+ **gem_gem_repository** | [**GemGemRepository**](GemGemRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+