pulp_npm_client 0.1.0a1

data/docs/NpmNpmRemoteResponse.md

@@ -0,0 +1,43 @@
+# PulpNpmClient::NpmNpmRemoteResponse
+
+## 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 PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
+**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [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** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::NpmNpmRemoteResponse.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)
+```
+
+

data/docs/NpmNpmRepository.md

@@ -0,0 +1,21 @@
+# PulpNpmClient::NpmNpmRepository
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A unique name for this repository. | 
+**description** | **String** | An optional description. | [optional] 
+**remote** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::NpmNpmRepository.new(name: null,
+                                 description: null,
+                                 remote: null)
+```
+
+

data/docs/NpmNpmRepositoryResponse.md

@@ -0,0 +1,29 @@
+# PulpNpmClient::NpmNpmRepositoryResponse
+
+## 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] 
+**remote** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::NpmNpmRepositoryResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 versions_href: null,
+                                 latest_version_href: null,
+                                 name: null,
+                                 description: null,
+                                 remote: null)
+```
+
+

data/docs/NpmPackage.md

@@ -0,0 +1,27 @@
+# PulpNpmClient::NpmPackage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**artifact** | **String** | Artifact file representing the physical content | [optional] 
+**relative_path** | **String** |  | 
+**file** | **File** | An uploaded file that may be turned into the artifact of the content unit. | [optional] 
+**repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] 
+**name** | **String** |  | 
+**version** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::NpmPackage.new(artifact: null,
+                                 relative_path: null,
+                                 file: null,
+                                 repository: null,
+                                 name: null,
+                                 version: null)
+```
+
+

data/docs/NpmPackageResponse.md

@@ -0,0 +1,27 @@
+# PulpNpmClient::NpmPackageResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**artifact** | **String** | Artifact file representing the physical content | [optional] 
+**relative_path** | **String** |  | 
+**name** | **String** |  | 
+**version** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::NpmPackageResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifact: null,
+                                 relative_path: null,
+                                 name: null,
+                                 version: null)
+```
+
+

data/docs/PaginatedRepositoryVersionResponseList.md

@@ -0,0 +1,23 @@
+# PulpNpmClient::PaginatedRepositoryVersionResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PaginatedRepositoryVersionResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatednpmNpmDistributionResponseList.md

@@ -0,0 +1,23 @@
+# PulpNpmClient::PaginatednpmNpmDistributionResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<NpmNpmDistributionResponse>**](NpmNpmDistributionResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PaginatednpmNpmDistributionResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatednpmNpmRemoteResponseList.md

@@ -0,0 +1,23 @@
+# PulpNpmClient::PaginatednpmNpmRemoteResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<NpmNpmRemoteResponse>**](NpmNpmRemoteResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PaginatednpmNpmRemoteResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatednpmNpmRepositoryResponseList.md

@@ -0,0 +1,23 @@
+# PulpNpmClient::PaginatednpmNpmRepositoryResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<NpmNpmRepositoryResponse>**](NpmNpmRepositoryResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PaginatednpmNpmRepositoryResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatednpmPackageResponseList.md

@@ -0,0 +1,23 @@
+# PulpNpmClient::PaginatednpmPackageResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<NpmPackageResponse>**](NpmPackageResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PaginatednpmPackageResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PatchednpmNpmDistribution.md

@@ -0,0 +1,25 @@
+# PulpNpmClient::PatchednpmNpmDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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\") | [optional] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
+**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
+**repository_version** | **String** | RepositoryVersion to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PatchednpmNpmDistribution.new(base_path: null,
+                                 content_guard: null,
+                                 name: null,
+                                 repository: null,
+                                 repository_version: null)
+```
+
+

data/docs/PatchednpmNpmRemote.md

@@ -0,0 +1,37 @@
+# PulpNpmClient::PatchednpmNpmRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A unique name for this remote. | [optional] 
+**url** | **String** | The URL of an external content source. | [optional] 
+**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
+**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [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] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
+**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PatchednpmNpmRemote.new(name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 download_concurrency: null,
+                                 policy: null)
+```
+
+

data/docs/PatchednpmNpmRepository.md

@@ -0,0 +1,21 @@
+# PulpNpmClient::PatchednpmNpmRepository
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A unique name for this repository. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**remote** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PatchednpmNpmRepository.new(name: null,
+                                 description: null,
+                                 remote: null)
+```
+
+

data/docs/PolicyEnum.md

@@ -0,0 +1,16 @@
+# PulpNpmClient::PolicyEnum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::PolicyEnum.new()
+```
+
+

data/docs/PulpNpmPackagesApi.md

@@ -0,0 +1,60 @@
+# PulpNpmClient::PulpNpmPackagesApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](PulpNpmPackagesApi.md#get) | **GET** /pulp_npm/packages/{name}/ | 
+
+
+
+## get
+
+> get(name, opts)
+
+
+
+Return a published package.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_npm_client'
+
+api_instance = PulpNpmClient::PulpNpmPackagesApi.new
+name = 'name_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
+  api_instance.get(name, opts)
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling PulpNpmPackagesApi->get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **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
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/RemotesNpmApi.md

@@ -0,0 +1,368 @@
+# PulpNpmClient::RemotesNpmApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
+[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
+[**list**](RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
+[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
+[**read**](RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
+[**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
+
+
+
+## create
+
+> NpmNpmRemoteResponse create(npm_npm_remote)
+
+Create a npm remote
+
+A ViewSet for NpmRemote.  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::RemotesNpmApi.new
+npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
+
+begin
+  #Create a npm remote
+  result = api_instance.create(npm_npm_remote)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RemotesNpmApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
+
+### Return type
+
+[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.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_remote_href)
+
+Delete a npm remote
+
+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::RemotesNpmApi.new
+npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
+
+begin
+  #Delete a npm remote
+  result = api_instance.delete(npm_npm_remote_href)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RemotesNpmApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_remote_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatednpmNpmRemoteResponseList list(opts)
+
+List npm remotes
+
+A ViewSet for NpmRemote.  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::RemotesNpmApi.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.
+  pulp_last_updated: 'pulp_last_updated_example', # String | pulp_last_updated
+  pulp_last_updated__gt: 'pulp_last_updated__gt_example', # String | pulp_last_updated__gt
+  pulp_last_updated__gte: 'pulp_last_updated__gte_example', # String | pulp_last_updated__gte
+  pulp_last_updated__lt: 'pulp_last_updated__lt_example', # String | pulp_last_updated__lt
+  pulp_last_updated__lte: 'pulp_last_updated__lte_example', # String | pulp_last_updated__lte
+  pulp_last_updated__range: 'pulp_last_updated__range_example', # String | pulp_last_updated__range
+  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 remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RemotesNpmApi->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] 
+ **pulp_last_updated** | **String**| pulp_last_updated | [optional] 
+ **pulp_last_updated__gt** | **String**| pulp_last_updated__gt | [optional] 
+ **pulp_last_updated__gte** | **String**| pulp_last_updated__gte | [optional] 
+ **pulp_last_updated__lt** | **String**| pulp_last_updated__lt | [optional] 
+ **pulp_last_updated__lte** | **String**| pulp_last_updated__lte | [optional] 
+ **pulp_last_updated__range** | **String**| pulp_last_updated__range | [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
+
+[**PaginatednpmNpmRemoteResponseList**](PaginatednpmNpmRemoteResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote)
+
+Update a npm remote
+
+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::RemotesNpmApi.new
+npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
+patchednpm_npm_remote = PulpNpmClient::PatchednpmNpmRemote.new # PatchednpmNpmRemote | 
+
+begin
+  #Update a npm remote
+  result = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RemotesNpmApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_remote_href** | **String**|  | 
+ **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.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
+
+> NpmNpmRemoteResponse read(npm_npm_remote_href, opts)
+
+Inspect a npm remote
+
+A ViewSet for NpmRemote.  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::RemotesNpmApi.new
+npm_npm_remote_href = 'npm_npm_remote_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 remote
+  result = api_instance.read(npm_npm_remote_href, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RemotesNpmApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_remote_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
+
+[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(npm_npm_remote_href, npm_npm_remote)
+
+Update a npm remote
+
+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::RemotesNpmApi.new
+npm_npm_remote_href = 'npm_npm_remote_href_example' # String | 
+npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
+
+begin
+  #Update a npm remote
+  result = api_instance.update(npm_npm_remote_href, npm_npm_remote)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RemotesNpmApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_remote_href** | **String**|  | 
+ **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.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
+