pulp_npm_client 0.1.0a1.dev01595640515 → 0.1.0a1.dev01595986114

data/docs/RepositoriesNpmApi.md

@@ -4,24 +4,24 @@ 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_repository_href} | Delete a npm repository
-[**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
+[**create**](RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | 
+[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_repository_href} | 
+[**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | 
 [**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_repository_href}modify/ | Modify Repository Content
-[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_repository_href} | Partially update a npm repository
-[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_repository_href} | Inspect a npm repository
+[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_repository_href} | 
+[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_repository_href} | 
 [**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_repository_href}sync/ | Sync from remote
-[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_repository_href} | Update a npm repository
+[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_repository_href} | 
 
 
 
 ## create
 
-> NpmNpmRepository create(data)
+> NpmNpmRepositoryResponse create(npm_npm_repository)
 
-Create a npm repository
 
-Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
 ### Example
 
@@ -30,17 +30,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::RepositoriesNpmApi.new
-data = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
+npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
 
 begin
-  #Create a npm repository
-  result = api_instance.create(data)
+  result = api_instance.create(npm_npm_repository)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->create: #{e}"
@@ -52,27 +51,27 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **data** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
+ **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
 
 ### Return type
 
-[**NpmNpmRepository**](NpmNpmRepository.md)
+[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.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_repository_href)
+> AsyncOperationResponse delete(npm_repository_href, opts)
+
 
-Delete a npm repository
 
 Trigger an asynchronous delete task
 
@@ -83,17 +82,21 @@ 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::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/
+npm_repository_href = 'npm_repository_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.
+}
 
 begin
-  #Delete a npm repository
-  result = api_instance.delete(npm_repository_href)
+  result = api_instance.delete(npm_repository_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->delete: #{e}"
@@ -105,7 +108,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**| URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/ | 
+ **npm_repository_href** | **String**|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -113,7 +119,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -125,9 +131,9 @@ Name | Type | Description  | Notes
 
 > InlineResponse2003 list(opts)
 
-List npm repositorys
 
-Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
 ### Example
 
@@ -136,24 +142,23 @@ 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::RepositoriesNpmApi.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
   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
@@ -166,11 +171,11 @@ 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] 
  **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] 
 
@@ -180,7 +185,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -190,7 +195,7 @@ Name | Type | Description  | Notes
 
 ## modify
 
-> AsyncOperationResponse modify(npm_repository_href, data)
+> AsyncOperationResponse modify(npm_repository_href, repository_add_remove_content)
 
 Modify Repository Content
 
@@ -203,18 +208,18 @@ Trigger an asynchronous task to create a new repository version.
 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::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/
-data = PulpNpmClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+npm_repository_href = 'npm_repository_href_example' # String | 
+repository_add_remove_content = PulpNpmClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
 
 begin
   #Modify Repository Content
-  result = api_instance.modify(npm_repository_href, data)
+  result = api_instance.modify(npm_repository_href, repository_add_remove_content)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->modify: #{e}"
@@ -226,8 +231,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**| URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/ | 
- **data** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
+ **npm_repository_href** | **String**|  | 
+ **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
 
 ### Return type
 
@@ -235,19 +240,19 @@ 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
 
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(npm_repository_href, data)
+> AsyncOperationResponse partial_update(npm_repository_href, patchednpm_npm_repository, opts)
+
 
-Partially update a npm repository
 
 Trigger an asynchronous partial update task
 
@@ -258,18 +263,22 @@ 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::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/
-data = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
+npm_repository_href = 'npm_repository_href_example' # String | 
+patchednpm_npm_repository = PulpNpmClient::PatchednpmNpmRepository.new # PatchednpmNpmRepository | 
+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.
+}
 
 begin
-  #Partially update a npm repository
-  result = api_instance.partial_update(npm_repository_href, data)
+  result = api_instance.partial_update(npm_repository_href, patchednpm_npm_repository, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->partial_update: #{e}"
@@ -281,8 +290,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**| URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/ | 
- **data** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
+ **npm_repository_href** | **String**|  | 
+ **patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -290,21 +302,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
 
-> NpmNpmRepository read(npm_repository_href, opts)
+> NpmNpmRepositoryResponse read(npm_repository_href, opts)
+
 
-Inspect a npm repository
 
-Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet for NpmRepository.  Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
 
 ### Example
 
@@ -313,20 +325,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::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/
+npm_repository_href = '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_repository_href, opts)
   p result
 rescue PulpNpmClient::ApiError => e
@@ -339,17 +350,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**| URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/ | 
+ **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
 
-[**NpmNpmRepository**](NpmNpmRepository.md)
+[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -359,7 +370,7 @@ Name | Type | Description  | Notes
 
 ## sync
 
-> AsyncOperationResponse sync(npm_repository_href, data)
+> AsyncOperationResponse sync(npm_repository_href, repository_sync_url)
 
 Sync from remote
 
@@ -372,18 +383,18 @@ Trigger an asynchronous task to sync content.
 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::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/
-data = PulpNpmClient::RepositorySyncURL.new # RepositorySyncURL | 
+npm_repository_href = 'npm_repository_href_example' # String | 
+repository_sync_url = PulpNpmClient::RepositorySyncURL.new # RepositorySyncURL | 
 
 begin
   #Sync from remote
-  result = api_instance.sync(npm_repository_href, data)
+  result = api_instance.sync(npm_repository_href, repository_sync_url)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->sync: #{e}"
@@ -395,8 +406,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**| URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/ | 
- **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+ **npm_repository_href** | **String**|  | 
+ **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
 
 ### Return type
 
@@ -404,19 +415,19 @@ 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
 
 
 ## update
 
-> AsyncOperationResponse update(npm_repository_href, data)
+> AsyncOperationResponse update(npm_repository_href, npm_npm_repository, opts)
+
 
-Update a npm repository
 
 Trigger an asynchronous update task
 
@@ -427,18 +438,22 @@ 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::RepositoriesNpmApi.new
-npm_repository_href = 'npm_repository_href_example' # String | URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/
-data = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
+npm_repository_href = 'npm_repository_href_example' # String | 
+npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository | 
+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.
+}
 
 begin
-  #Update a npm repository
-  result = api_instance.update(npm_repository_href, data)
+  result = api_instance.update(npm_repository_href, npm_npm_repository, opts)
   p result
 rescue PulpNpmClient::ApiError => e
   puts "Exception when calling RepositoriesNpmApi->update: #{e}"
@@ -450,8 +465,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **npm_repository_href** | **String**| URI of Npm Repository. e.g.: /pulp/api/v3/repositories/npm/npm/1/ | 
- **data** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
+ **npm_repository_href** | **String**|  | 
+ **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -459,10 +477,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