pulp_npm_client 0.1.0a1

data/docs/DistributionsNpmApi.md

@@ -0,0 +1,364 @@
+# PulpNpmClient::DistributionsNpmApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution
+[**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
+[**list**](DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
+[**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
+[**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
+[**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(npm_npm_distribution)
+
+Create a npm distribution
+
+Trigger an asynchronous create 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::DistributionsNpmApi.new
+npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new # NpmNpmDistribution | 
+
+begin
+  #Create a npm distribution
+  result = api_instance.create(npm_npm_distribution)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling DistributionsNpmApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.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
+
+
+## delete
+
+> AsyncOperationResponse delete(npm_npm_distribution_href)
+
+Delete a npm distribution
+
+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::DistributionsNpmApi.new
+npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String | 
+
+begin
+  #Delete a npm distribution
+  result = api_instance.delete(npm_npm_distribution_href)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling DistributionsNpmApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_distribution_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatednpmNpmDistributionResponseList list(opts)
+
+List npm distributions
+
+ViewSet for NPM Distributions.
+
+### 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::DistributionsNpmApi.new
+opts = {
+  base_path: 'base_path_example', # String | base_path
+  base_path__contains: 'base_path__contains_example', # String | base_path__contains
+  base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
+  base_path__in: 'base_path__in_example', # String | base_path__in
+  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 distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling DistributionsNpmApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **base_path** | **String**| base_path | [optional] 
+ **base_path__contains** | **String**| base_path__contains | [optional] 
+ **base_path__icontains** | **String**| base_path__icontains | [optional] 
+ **base_path__in** | **String**| base_path__in | [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] 
+
+### Return type
+
+[**PaginatednpmNpmDistributionResponseList**](PaginatednpmNpmDistributionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(npm_npm_distribution_href, patchednpm_npm_distribution)
+
+Update a npm distribution
+
+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::DistributionsNpmApi.new
+npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String | 
+patchednpm_npm_distribution = PulpNpmClient::PatchednpmNpmDistribution.new # PatchednpmNpmDistribution | 
+
+begin
+  #Update a npm distribution
+  result = api_instance.partial_update(npm_npm_distribution_href, patchednpm_npm_distribution)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling DistributionsNpmApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_distribution_href** | **String**|  | 
+ **patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.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
+
+> NpmNpmDistributionResponse read(npm_npm_distribution_href, opts)
+
+Inspect a npm distribution
+
+ViewSet for NPM Distributions.
+
+### 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::DistributionsNpmApi.new
+npm_npm_distribution_href = 'npm_npm_distribution_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 distribution
+  result = api_instance.read(npm_npm_distribution_href, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling DistributionsNpmApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_distribution_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
+
+[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(npm_npm_distribution_href, npm_npm_distribution)
+
+Update a npm distribution
+
+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::DistributionsNpmApi.new
+npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String | 
+npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new # NpmNpmDistribution | 
+
+begin
+  #Update a npm distribution
+  result = api_instance.update(npm_npm_distribution_href, npm_npm_distribution)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling DistributionsNpmApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_distribution_href** | **String**|  | 
+ **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.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
+

data/docs/NpmNpmDistribution.md

@@ -0,0 +1,25 @@
+# PulpNpmClient::NpmNpmDistribution
+
+## 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\") | 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**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::NpmNpmDistribution.new(base_path: null,
+                                 content_guard: null,
+                                 name: null,
+                                 repository: null,
+                                 repository_version: null)
+```
+
+

data/docs/NpmNpmDistributionResponse.md

@@ -0,0 +1,31 @@
+# PulpNpmClient::NpmNpmDistributionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**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\") | 
+**base_url** | **String** | The URL for accessing the universe API as defined by this distribution. | [optional] [readonly] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**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::NpmNpmDistributionResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 base_path: null,
+                                 base_url: null,
+                                 content_guard: null,
+                                 name: null,
+                                 repository: null,
+                                 repository_version: null)
+```
+
+

data/docs/NpmNpmRemote.md

@@ -0,0 +1,37 @@
+# PulpNpmClient::NpmNpmRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**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::NpmNpmRemote.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)
+```
+
+