pulp_npm_client 0.1.0a1

data/docs/RepositoriesNpmVersionsApi.md

@@ -0,0 +1,271 @@
+# PulpNpmClient::RepositoriesNpmVersionsApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
+[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
+[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
+[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ | 
+
+
+
+## delete
+
+> AsyncOperationResponse delete(npm_npm_repository_version_href)
+
+Delete a repository version
+
+Trigger an asynchronous task to delete a repositroy version.
+
+### 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::RepositoriesNpmVersionsApi.new
+npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # String | 
+
+begin
+  #Delete a repository version
+  result = api_instance.delete(npm_npm_repository_version_href)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_version_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedRepositoryVersionResponseList list(npm_npm_repository_href, opts)
+
+List repository versions
+
+A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
+
+### 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::RepositoriesNpmVersionsApi.new
+npm_npm_repository_href = 'npm_npm_repository_href_example' # String | 
+opts = {
+  content: 'content_example', # String | content
+  content__in: 'content__in_example', # String | content__in
+  limit: 56, # Integer | Number of results to return per page.
+  number: 'number_example', # String | number
+  number__gt: 'number__gt_example', # String | number__gt
+  number__gte: 'number__gte_example', # String | number__gte
+  number__lt: 'number__lt_example', # String | number__lt
+  number__lte: 'number__lte_example', # String | number__lte
+  number__range: 'number__range_example', # String | number__range
+  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_created: 'pulp_created_example', # String | pulp_created
+  pulp_created__gt: 'pulp_created__gt_example', # String | pulp_created__gt
+  pulp_created__gte: 'pulp_created__gte_example', # String | pulp_created__gte
+  pulp_created__lt: 'pulp_created__lt_example', # String | pulp_created__lt
+  pulp_created__lte: 'pulp_created__lte_example', # String | pulp_created__lte
+  pulp_created__range: 'pulp_created__range_example', # String | pulp_created__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 repository versions
+  result = api_instance.list(npm_npm_repository_href, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_href** | **String**|  | 
+ **content** | **String**| content | [optional] 
+ **content__in** | **String**| content__in | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **number** | **String**| number | [optional] 
+ **number__gt** | **String**| number__gt | [optional] 
+ **number__gte** | **String**| number__gte | [optional] 
+ **number__lt** | **String**| number__lt | [optional] 
+ **number__lte** | **String**| number__lte | [optional] 
+ **number__range** | **String**| number__range | [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_created** | **String**| pulp_created | [optional] 
+ **pulp_created__gt** | **String**| pulp_created__gt | [optional] 
+ **pulp_created__gte** | **String**| pulp_created__gte | [optional] 
+ **pulp_created__lt** | **String**| pulp_created__lt | [optional] 
+ **pulp_created__lte** | **String**| pulp_created__lte | [optional] 
+ **pulp_created__range** | **String**| pulp_created__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
+
+[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> RepositoryVersionResponse read(npm_npm_repository_version_href, opts)
+
+Inspect a repository version
+
+A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
+
+### 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::RepositoriesNpmVersionsApi.new
+npm_npm_repository_version_href = 'npm_npm_repository_version_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 repository version
+  result = api_instance.read(npm_npm_repository_version_href, opts)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmVersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_version_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
+
+[**RepositoryVersionResponse**](RepositoryVersionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## repair
+
+> AsyncOperationResponse repair(npm_npm_repository_version_href, repository_version)
+
+
+
+Trigger an asynchronous task to repair a repositroy version.
+
+### 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::RepositoriesNpmVersionsApi.new
+npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # String | 
+repository_version = PulpNpmClient::RepositoryVersion.new # RepositoryVersion | 
+
+begin
+  result = api_instance.repair(npm_npm_repository_version_href, repository_version)
+  p result
+rescue PulpNpmClient::ApiError => e
+  puts "Exception when calling RepositoriesNpmVersionsApi->repair: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **npm_npm_repository_version_href** | **String**|  | 
+ **repository_version** | [**RepositoryVersion**](RepositoryVersion.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/RepositoryAddRemoveContent.md

@@ -0,0 +1,21 @@
+# PulpNpmClient::RepositoryAddRemoveContent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**add_content_units** | **Array<Object>** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional] 
+**remove_content_units** | **Array<Object>** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional] 
+**base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::RepositoryAddRemoveContent.new(add_content_units: null,
+                                 remove_content_units: null,
+                                 base_version: null)
+```
+
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,19 @@
+# PulpNpmClient::RepositorySyncURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] 
+**mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::RepositorySyncURL.new(remote: null,
+                                 mirror: null)
+```
+
+

data/docs/RepositoryVersion.md

@@ -0,0 +1,17 @@
+# PulpNpmClient::RepositoryVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::RepositoryVersion.new(base_version: null)
+```
+
+

data/docs/RepositoryVersionResponse.md

@@ -0,0 +1,25 @@
+# PulpNpmClient::RepositoryVersionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**number** | **Integer** |  | [optional] [readonly] 
+**base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] 
+**content_summary** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpNpmClient'
+
+instance = PulpNpmClient::RepositoryVersionResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 number: null,
+                                 base_version: null,
+                                 content_summary: null)
+```
+
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/pulp_npm_client.rb

@@ -0,0 +1,69 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+# Common files
+require 'pulp_npm_client/api_client'
+require 'pulp_npm_client/api_error'
+require 'pulp_npm_client/version'
+require 'pulp_npm_client/configuration'
+
+# Models
+require 'pulp_npm_client/models/async_operation_response'
+require 'pulp_npm_client/models/content_summary'
+require 'pulp_npm_client/models/content_summary_response'
+require 'pulp_npm_client/models/npm_npm_distribution'
+require 'pulp_npm_client/models/npm_npm_distribution_response'
+require 'pulp_npm_client/models/npm_npm_remote'
+require 'pulp_npm_client/models/npm_npm_remote_response'
+require 'pulp_npm_client/models/npm_npm_repository'
+require 'pulp_npm_client/models/npm_npm_repository_response'
+require 'pulp_npm_client/models/npm_package'
+require 'pulp_npm_client/models/npm_package_response'
+require 'pulp_npm_client/models/paginated_repository_version_response_list'
+require 'pulp_npm_client/models/paginatednpm_npm_distribution_response_list'
+require 'pulp_npm_client/models/paginatednpm_npm_remote_response_list'
+require 'pulp_npm_client/models/paginatednpm_npm_repository_response_list'
+require 'pulp_npm_client/models/paginatednpm_package_response_list'
+require 'pulp_npm_client/models/patchednpm_npm_distribution'
+require 'pulp_npm_client/models/patchednpm_npm_remote'
+require 'pulp_npm_client/models/patchednpm_npm_repository'
+require 'pulp_npm_client/models/policy_enum'
+require 'pulp_npm_client/models/repository_add_remove_content'
+require 'pulp_npm_client/models/repository_sync_url'
+require 'pulp_npm_client/models/repository_version'
+require 'pulp_npm_client/models/repository_version_response'
+
+# APIs
+require 'pulp_npm_client/api/content_packages_api'
+require 'pulp_npm_client/api/distributions_npm_api'
+require 'pulp_npm_client/api/pulp_npm_packages_api'
+require 'pulp_npm_client/api/remotes_npm_api'
+require 'pulp_npm_client/api/repositories_npm_api'
+require 'pulp_npm_client/api/repositories_npm_versions_api'
+
+module PulpNpmClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   PulpNpmClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end