pulp_npm_client 0.1.0a1.dev01595640515 → 0.1.0a1.dev01595986114

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/RemotesNpmApi.md

@@ -4,22 +4,22 @@ 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_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_remote_href} | Partially update a npm remote
-[**read**](RemotesNpmApi.md#read) | **GET** {npm_remote_href} | Inspect a npm remote
-[**update**](RemotesNpmApi.md#update) | **PUT** {npm_remote_href} | Update a npm remote
+[**create**](RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | 
+[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_remote_href} | 
+[**list**](RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | 
+[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_remote_href} | 
+[**read**](RemotesNpmApi.md#read) | **GET** {npm_remote_href} | 
+[**update**](RemotesNpmApi.md#update) | **PUT** {npm_remote_href} | 
 
 
 
 ## create
 
-> NpmNpmRemote create(data)
+> NpmNpmRemoteResponse create(npm_npm_remote)
 
-Create a npm remote
 
-Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+A ViewSet for NpmRemote.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
 ### Example
 
@@ -28,17 +28,16 @@ Similar to the PackageViewSet above, define endpoint_name, queryset and serializ
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-data = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
+npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
 
 begin
-  #Create a npm remote
-  result = api_instance.create(data)
+  result = api_instance.create(npm_npm_remote)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->create: #{e}"
@@ -50,27 +49,27 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **data** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
+ **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
 
 ### Return type
 
-[**NpmNpmRemote**](NpmNpmRemote.md)
+[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## delete
 
-> AsyncOperationResponse delete(npm_remote_href)
+> AsyncOperationResponse delete(npm_remote_href, opts)
+
 
-Delete a npm remote
 
 Trigger an asynchronous delete task
 
@@ -81,17 +80,27 @@ Trigger an asynchronous delete task
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/
+npm_remote_href = 'npm_remote_href_example' # String | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  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
+}
 
 begin
-  #Delete a npm remote
-  result = api_instance.delete(npm_remote_href)
+  result = api_instance.delete(npm_remote_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->delete: #{e}"
@@ -103,7 +112,16 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**| URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/ | 
+ **npm_remote_href** | **String**|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [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] 
 
 ### Return type
 
@@ -111,7 +129,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -123,9 +141,9 @@ Name | Type | Description  | Notes
 
 > InlineResponse2002 list(opts)
 
-List npm remotes
 
-Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+A ViewSet for NpmRemote.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
 ### Example
 
@@ -134,30 +152,29 @@ Similar to the PackageViewSet above, define endpoint_name, queryset and serializ
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
-  name: 'name_example', # String | 
-  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
-  pulp_last_updated__lt: 'pulp_last_updated__lt_example', # String | Filter results where pulp_last_updated is less than value
-  pulp_last_updated__lte: 'pulp_last_updated__lte_example', # String | Filter results where pulp_last_updated is less than or equal to value
-  pulp_last_updated__gt: 'pulp_last_updated__gt_example', # String | Filter results where pulp_last_updated is greater than value
-  pulp_last_updated__gte: 'pulp_last_updated__gte_example', # String | Filter results where pulp_last_updated is greater than or equal to value
-  pulp_last_updated__range: 'pulp_last_updated__range_example', # String | Filter results where pulp_last_updated is between two comma separated values
-  pulp_last_updated: 'pulp_last_updated_example', # String | ISO 8601 formatted dates are supported
   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
@@ -170,17 +187,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
- **name** | **String**|  | [optional] 
- **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
- **pulp_last_updated__lt** | **String**| Filter results where pulp_last_updated is less than value | [optional] 
- **pulp_last_updated__lte** | **String**| Filter results where pulp_last_updated is less than or equal to value | [optional] 
- **pulp_last_updated__gt** | **String**| Filter results where pulp_last_updated is greater than value | [optional] 
- **pulp_last_updated__gte** | **String**| Filter results where pulp_last_updated is greater than or equal to value | [optional] 
- **pulp_last_updated__range** | **String**| Filter results where pulp_last_updated is between two comma separated values | [optional] 
- **pulp_last_updated** | **String**| ISO 8601 formatted dates are supported | [optional] 
  **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] 
 
@@ -190,7 +207,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -200,9 +217,9 @@ Name | Type | Description  | Notes
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(npm_remote_href, data)
+> AsyncOperationResponse partial_update(npm_remote_href, patchednpm_npm_remote, opts)
+
 
-Partially update a npm remote
 
 Trigger an asynchronous partial update task
 
@@ -213,18 +230,28 @@ Trigger an asynchronous partial update task
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/
-data = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
+npm_remote_href = 'npm_remote_href_example' # String | 
+patchednpm_npm_remote = PulpNpmClient::PatchednpmNpmRemote.new # PatchednpmNpmRemote | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  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
+}
 
 begin
-  #Partially update a npm remote
-  result = api_instance.partial_update(npm_remote_href, data)
+  result = api_instance.partial_update(npm_remote_href, patchednpm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->partial_update: #{e}"
@@ -236,8 +263,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**| URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/ | 
- **data** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
+ **npm_remote_href** | **String**|  | 
+ **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [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] 
 
 ### Return type
 
@@ -245,21 +281,21 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## read
 
-> NpmNpmRemote read(npm_remote_href, opts)
+> NpmNpmRemoteResponse read(npm_remote_href, opts)
+
 
-Inspect a npm remote
 
-Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet for NpmRemote.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
 ### Example
 
@@ -268,20 +304,19 @@ Similar to the PackageViewSet above, define endpoint_name, queryset and serializ
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/
+npm_remote_href = '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_remote_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
@@ -294,17 +329,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**| URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/ | 
+ **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
 
-[**NpmNpmRemote**](NpmNpmRemote.md)
+[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -314,9 +349,9 @@ Name | Type | Description  | Notes
 
 ## update
 
-> AsyncOperationResponse update(npm_remote_href, data)
+> AsyncOperationResponse update(npm_remote_href, npm_npm_remote, opts)
+
 
-Update a npm remote
 
 Trigger an asynchronous update task
 
@@ -327,18 +362,28 @@ Trigger an asynchronous update task
 require 'pulp_npm_client'
 # setup authorization
 PulpNpmClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpNpmClient::RemotesNpmApi.new
-npm_remote_href = 'npm_remote_href_example' # String | URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/
-data = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
+npm_remote_href = 'npm_remote_href_example' # String | 
+npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  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
+}
 
 begin
-  #Update a npm remote
-  result = api_instance.update(npm_remote_href, data)
+  result = api_instance.update(npm_remote_href, npm_npm_remote, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RemotesNpmApi->update: #{e}"
@@ -350,8 +395,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_remote_href** | **String**| URI of Npm Remote. e.g.: /pulp/api/v3/remotes/npm/npm/1/ | 
- **data** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
+ **npm_remote_href** | **String**|  | 
+ **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [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] 
 
 ### Return type
 
@@ -359,10 +413,10 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json