pulp_npm_client 0.1.0a1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9371b0d6c6a0799a3dbb1373bcc536584de4127227b0dace2fc7089e4d7c7a5f
+  data.tar.gz: 5c05d8f8fe15895f3f57e2da261fb6079cdfcc45072eb4afe6ffc1bf0e288317
+SHA512:
+  metadata.gz: 8ebbf923f7b91fed761f7d2da0ba8cc9f25abeba250550a05fcf336d75708c88a9dad220b04c7a592863db4fb47adf533369f53c07d44f61755694e8bfe39c39
+  data.tar.gz: b6e15a6e56e855a8bdf3e669cdfe4e083bfff33dabd6310faa06a00c39b5c491e30b614552146d28d8d749476980ef75f50d5c86ad6f6b2d45f23b611b96a6cc

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,157 @@
+# pulp_npm_client
+
+PulpNpmClient - the Ruby gem for the Pulp 3 API
+
+Fetch, Upload, Organize, and Distribute Software Packages
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 0.1.0a1
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://pulpproject.org](https://pulpproject.org)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pulp_npm_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./pulp_npm_client-0.1.0a1.gem
+```
+
+(for development, run `gem install --dev ./pulp_npm_client-0.1.0a1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pulp_npm_client', '~> 0.1.0a1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'pulp_npm_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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::ContentPackagesApi.new
+relative_path = 'relative_path_example' # String | 
+name = 'name_example' # String | 
+version = 'version_example' # String | 
+opts = {
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
+  repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
+}
+
+begin
+  #Create a package
+  result = api_instance.create(relative_path, name, version, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->create: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://pulp*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PulpNpmClient::ContentPackagesApi* | [**create**](docs/ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ | Create a package
+*PulpNpmClient::ContentPackagesApi* | [**list**](docs/ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ | List packages
+*PulpNpmClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
+*PulpNpmClient::DistributionsNpmApi* | [**create**](docs/DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution
+*PulpNpmClient::DistributionsNpmApi* | [**delete**](docs/DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
+*PulpNpmClient::DistributionsNpmApi* | [**list**](docs/DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
+*PulpNpmClient::DistributionsNpmApi* | [**partial_update**](docs/DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
+*PulpNpmClient::DistributionsNpmApi* | [**read**](docs/DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
+*PulpNpmClient::DistributionsNpmApi* | [**update**](docs/DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
+*PulpNpmClient::PulpNpmPackagesApi* | [**get**](docs/PulpNpmPackagesApi.md#get) | **GET** /pulp_npm/packages/{name}/ | 
+*PulpNpmClient::RemotesNpmApi* | [**create**](docs/RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
+*PulpNpmClient::RemotesNpmApi* | [**delete**](docs/RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
+*PulpNpmClient::RemotesNpmApi* | [**list**](docs/RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
+*PulpNpmClient::RemotesNpmApi* | [**partial_update**](docs/RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
+*PulpNpmClient::RemotesNpmApi* | [**read**](docs/RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
+*PulpNpmClient::RemotesNpmApi* | [**update**](docs/RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
+*PulpNpmClient::RepositoriesNpmApi* | [**create**](docs/RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
+*PulpNpmClient::RepositoriesNpmApi* | [**delete**](docs/RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
+*PulpNpmClient::RepositoriesNpmApi* | [**list**](docs/RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
+*PulpNpmClient::RepositoriesNpmApi* | [**modify**](docs/RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
+*PulpNpmClient::RepositoriesNpmApi* | [**partial_update**](docs/RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
+*PulpNpmClient::RepositoriesNpmApi* | [**read**](docs/RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
+*PulpNpmClient::RepositoriesNpmApi* | [**sync**](docs/RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
+*PulpNpmClient::RepositoriesNpmApi* | [**update**](docs/RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
+*PulpNpmClient::RepositoriesNpmVersionsApi* | [**delete**](docs/RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
+*PulpNpmClient::RepositoriesNpmVersionsApi* | [**list**](docs/RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
+*PulpNpmClient::RepositoriesNpmVersionsApi* | [**read**](docs/RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
+*PulpNpmClient::RepositoriesNpmVersionsApi* | [**repair**](docs/RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ | 
+
+
+## Documentation for Models
+
+ - [PulpNpmClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
+ - [PulpNpmClient::ContentSummary](docs/ContentSummary.md)
+ - [PulpNpmClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
+ - [PulpNpmClient::NpmNpmDistribution](docs/NpmNpmDistribution.md)
+ - [PulpNpmClient::NpmNpmDistributionResponse](docs/NpmNpmDistributionResponse.md)
+ - [PulpNpmClient::NpmNpmRemote](docs/NpmNpmRemote.md)
+ - [PulpNpmClient::NpmNpmRemoteResponse](docs/NpmNpmRemoteResponse.md)
+ - [PulpNpmClient::NpmNpmRepository](docs/NpmNpmRepository.md)
+ - [PulpNpmClient::NpmNpmRepositoryResponse](docs/NpmNpmRepositoryResponse.md)
+ - [PulpNpmClient::NpmPackage](docs/NpmPackage.md)
+ - [PulpNpmClient::NpmPackageResponse](docs/NpmPackageResponse.md)
+ - [PulpNpmClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
+ - [PulpNpmClient::PaginatednpmNpmDistributionResponseList](docs/PaginatednpmNpmDistributionResponseList.md)
+ - [PulpNpmClient::PaginatednpmNpmRemoteResponseList](docs/PaginatednpmNpmRemoteResponseList.md)
+ - [PulpNpmClient::PaginatednpmNpmRepositoryResponseList](docs/PaginatednpmNpmRepositoryResponseList.md)
+ - [PulpNpmClient::PaginatednpmPackageResponseList](docs/PaginatednpmPackageResponseList.md)
+ - [PulpNpmClient::PatchednpmNpmDistribution](docs/PatchednpmNpmDistribution.md)
+ - [PulpNpmClient::PatchednpmNpmRemote](docs/PatchednpmNpmRemote.md)
+ - [PulpNpmClient::PatchednpmNpmRepository](docs/PatchednpmNpmRepository.md)
+ - [PulpNpmClient::PolicyEnum](docs/PolicyEnum.md)
+ - [PulpNpmClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
+ - [PulpNpmClient::RepositorySyncURL](docs/RepositorySyncURL.md)
+ - [PulpNpmClient::RepositoryVersion](docs/RepositoryVersion.md)
+ - [PulpNpmClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
+
+
+## Documentation for Authorization
+
+
+### basicAuth
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AsyncOperationResponse.md

@@ -0,0 +1,17 @@
+# PulpNpmClient::AsyncOperationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | The href of the task. | 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::AsyncOperationResponse.new(task: null)
+```
+
+

data/docs/ContentPackagesApi.md

@@ -0,0 +1,208 @@
+# PulpNpmClient::ContentPackagesApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/npm/packages/ | Create a package
+[**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/npm/packages/ | List packages
+[**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
+
+
+
+## create
+
+> NpmPackageResponse create(relative_path, name, version, opts)
+
+Create a package
+
+Perform bookkeeping when saving Content.  \"Artifacts\" need to be popped off and saved indpendently, as they are not actually part of the Content model.
+
+### 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::ContentPackagesApi.new
+relative_path = 'relative_path_example' # String | 
+name = 'name_example' # String | 
+version = 'version_example' # String | 
+opts = {
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
+  repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
+}
+
+begin
+  #Create a package
+  result = api_instance.create(relative_path, name, version, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **relative_path** | **String**|  | 
+ **name** | **String**|  | 
+ **version** | **String**|  | 
+ **artifact** | **String**| Artifact file representing the physical content | [optional] 
+ **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] 
+
+### Return type
+
+[**NpmPackageResponse**](NpmPackageResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## list
+
+> PaginatednpmPackageResponseList list(opts)
+
+List packages
+
+A ViewSet for Package.  Define endpoint name which will appear in the API endpoint for this content type. For example::     http://pulp.example.com/pulp/api/v3/content/npm/units/  Also specify queryset and serializer for Package.
+
+### 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::ContentPackagesApi.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.
+  repository_version: 'repository_version_example', # String | repository_version
+  repository_version_added: 'repository_version_added_example', # String | repository_version_added
+  repository_version_removed: 'repository_version_removed_example', # String | repository_version_removed
+  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 packages
+  result = api_instance.list(opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->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] 
+ **repository_version** | **String**| repository_version | [optional] 
+ **repository_version_added** | **String**| repository_version_added | [optional] 
+ **repository_version_removed** | **String**| repository_version_removed | [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
+
+[**PaginatednpmPackageResponseList**](PaginatednpmPackageResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> NpmPackageResponse read(npm_package_href, opts)
+
+Inspect a package
+
+A ViewSet for Package.  Define endpoint name which will appear in the API endpoint for this content type. For example::     http://pulp.example.com/pulp/api/v3/content/npm/units/  Also specify queryset and serializer for Package.
+
+### 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::ContentPackagesApi.new
+npm_package_href = 'npm_package_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 package
+  result = api_instance.read(npm_package_href, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling ContentPackagesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_package_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
+
+[**NpmPackageResponse**](NpmPackageResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentSummary.md

@@ -0,0 +1,21 @@
+# PulpNpmClient::ContentSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**added** | [**Object**](.md) |  | 
+**removed** | [**Object**](.md) |  | 
+**present** | [**Object**](.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::ContentSummary.new(added: null,
+                                 removed: null,
+                                 present: null)
+```
+
+

data/docs/ContentSummaryResponse.md

@@ -0,0 +1,21 @@
+# PulpNpmClient::ContentSummaryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**added** | [**Object**](.md) |  | 
+**removed** | [**Object**](.md) |  | 
+**present** | [**Object**](.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::ContentSummaryResponse.new(added: null,
+                                 removed: null,
+                                 present: null)
+```
+
+