pulp_npm_client 0.1.0a1

data/docs/RepositoriesNpmApi.md

@@ -0,0 +1,468 @@
+# PulpNpmClient::RepositoriesNpmApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
+[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
+[**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
+[**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
+[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
+[**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
+[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
+
+
+
+## create
+
+> NpmNpmRepositoryResponse create(npm_npm_repository)
+
+Create a npm repository
+
+A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
+
+begin
+  #Create a npm repository
+  result = api_instance.create(npm_npm_repository)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
+
+### Return type
+
+[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.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(npm_npm_repository_href)
+
+Delete a npm repository
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+
+begin
+  #Delete a npm repository
+  result = api_instance.delete(npm_npm_repository_href)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatednpmNpmRepositoryResponseList list(opts)
+
+List npm repositorys
+
+A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering 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 npm repositorys
+  result = api_instance.list(opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering 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
+
+[**PaginatednpmNpmRepositoryResponseList**](PaginatednpmNpmRepositoryResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## modify
+
+> AsyncOperationResponse modify(npm_npm_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_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+repository_add_remove_content = PulpNpmClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+
+begin
+  #Modify Repository Content
+  result = api_instance.modify(npm_npm_repository_href, repository_add_remove_content)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_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(npm_npm_repository_href, patchednpm_npm_repository)
+
+Update a npm repository
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+patchednpm_npm_repository = PulpNpmClient::PatchednpmNpmRepository.new # PatchednpmNpmRepository | 
+
+begin
+  #Update a npm repository
+  result = api_instance.partial_update(npm_npm_repository_href, patchednpm_npm_repository)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_href** | **String**|  | 
+ **patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.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
+
+> NpmNpmRepositoryResponse read(npm_npm_repository_href, opts)
+
+Inspect a npm repository
+
+A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+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 npm repository
+  result = api_instance.read(npm_npm_repository_href, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_href** | **String**|  | 
+ **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
+
+[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(npm_npm_repository_href, repository_sync_url)
+
+Sync from remote
+
+Trigger an asynchronous task to sync content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+repository_sync_url = PulpNpmClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  #Sync from remote
+  result = api_instance.sync(npm_npm_repository_href, repository_sync_url)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_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(npm_npm_repository_href, npm_npm_repository)
+
+Update a npm repository
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+# setup authorization
+PulpNpmClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpNpmClient::RepositoriesNpmApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
+
+begin
+  #Update a npm repository
+  result = api_instance.update(npm_npm_repository_href, npm_npm_repository)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_href** | **String**|  | 
+ **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.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
+