pulp_certguard_client 0.1.0rc3.dev01581432076

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8b4be69c707d19d23688a1422d2d5e22061dfa39fa58a972d71257906c9238a
+  data.tar.gz: 9128c04d0ec537dae5445f1e8e4cec217eecb64ff318ab849e267dde02a8f4a4
+SHA512:
+  metadata.gz: e79547bd6c5fdce7b50e23e9eb41cd3d6ad1ea183719278baa80bed6cbc997603efd1947199ddb616244a7c8036b0df129b06517b42f7409e931c847dda91a84
+  data.tar.gz: 2305d1040b914a5b7596ebddde6fbbc57bcb6615c761f903ad9232c33e500f9070b7f983033ef45253071524e05575ee076be68292b6f562f62b040f3f3765e4

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,109 @@
+# pulp_certguard_client
+
+PulpCertguardClient - the Ruby gem for the Pulp 3 API
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 0.1.0rc3.dev01581432076
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pulp_certguard_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./pulp_certguard_client-0.1.0rc3.dev01581432076.gem
+```
+
+(for development, run `gem install --dev ./pulp_certguard_client-0.1.0rc3.dev01581432076.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_certguard_client', '~> 0.1.0rc3.dev01581432076'
+
+### 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_certguard_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_certguard_client'
+
+# Setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+name = 'name_example' # String | The unique name.
+ca_certificate = File.new('/path/to/file') # File | The Certificate Authority (CA) certificate.
+opts = {
+  description: 'description_example' # String | An optional description.
+}
+
+begin
+  #Create a x509 cert guard
+  result = api_instance.create(name, ca_certificate, opts)
+  p result
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->create: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:24817*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PulpCertguardClient::ContentguardsX509Api* | [**create**](docs/ContentguardsX509Api.md#create) | **POST** /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard
+*PulpCertguardClient::ContentguardsX509Api* | [**delete**](docs/ContentguardsX509Api.md#delete) | **DELETE** {x509_cert_guard_href} | Delete a x509 cert guard
+*PulpCertguardClient::ContentguardsX509Api* | [**list**](docs/ContentguardsX509Api.md#list) | **GET** /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards
+*PulpCertguardClient::ContentguardsX509Api* | [**partial_update**](docs/ContentguardsX509Api.md#partial_update) | **PATCH** {x509_cert_guard_href} | Partially update a x509 cert guard
+*PulpCertguardClient::ContentguardsX509Api* | [**read**](docs/ContentguardsX509Api.md#read) | **GET** {x509_cert_guard_href} | Inspect a x509 cert guard
+*PulpCertguardClient::ContentguardsX509Api* | [**update**](docs/ContentguardsX509Api.md#update) | **PUT** {x509_cert_guard_href} | Update a x509 cert guard
+
+
+## Documentation for Models
+
+ - [PulpCertguardClient::CertguardX509CertGuard](docs/CertguardX509CertGuard.md)
+ - [PulpCertguardClient::InlineResponse200](docs/InlineResponse200.md)
+
+
+## Documentation for Authorization
+
+
+### Basic
+
+- **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/CertguardX509CertGuard.md

@@ -0,0 +1,23 @@
+# PulpCertguardClient::CertguardX509CertGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | The unique name. | 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpCertguardClient'
+
+instance = PulpCertguardClient::CertguardX509CertGuard.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 description: null)
+```
+
+

data/docs/ContentguardsX509Api.md

@@ -0,0 +1,371 @@
+# PulpCertguardClient::ContentguardsX509Api
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentguardsX509Api.md#create) | **POST** /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard
+[**delete**](ContentguardsX509Api.md#delete) | **DELETE** {x509_cert_guard_href} | Delete a x509 cert guard
+[**list**](ContentguardsX509Api.md#list) | **GET** /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards
+[**partial_update**](ContentguardsX509Api.md#partial_update) | **PATCH** {x509_cert_guard_href} | Partially update a x509 cert guard
+[**read**](ContentguardsX509Api.md#read) | **GET** {x509_cert_guard_href} | Inspect a x509 cert guard
+[**update**](ContentguardsX509Api.md#update) | **PUT** {x509_cert_guard_href} | Update a x509 cert guard
+
+
+
+## create
+
+> CertguardX509CertGuard create(name, ca_certificate, opts)
+
+Create a x509 cert guard
+
+X509CertGuard API Viewsets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_certguard_client'
+# setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+name = 'name_example' # String | The unique name.
+ca_certificate = File.new('/path/to/file') # File | The Certificate Authority (CA) certificate.
+opts = {
+  description: 'description_example' # String | An optional description.
+}
+
+begin
+  #Create a x509 cert guard
+  result = api_instance.create(name, ca_certificate, opts)
+  p result
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The unique name. | 
+ **ca_certificate** | **File**| The Certificate Authority (CA) certificate. | 
+ **description** | **String**| An optional description. | [optional] 
+
+### Return type
+
+[**CertguardX509CertGuard**](CertguardX509CertGuard.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## delete
+
+> delete(x509_cert_guard_href)
+
+Delete a x509 cert guard
+
+X509CertGuard API Viewsets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_certguard_client'
+# setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+x509_cert_guard_href = 'x509_cert_guard_href_example' # String | URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/
+
+begin
+  #Delete a x509 cert guard
+  api_instance.delete(x509_cert_guard_href)
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x509_cert_guard_href** | **String**| URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse200 list(opts)
+
+List x509 cert guards
+
+X509CertGuard API Viewsets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_certguard_client'
+# setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+opts = {
+  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.
+  offset: 56, # Integer | The initial index from which to return 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 x509 cert guards
+  result = api_instance.list(opts)
+  p result
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **offset** | **Integer**| The initial index from which to return 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
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> CertguardX509CertGuard partial_update(x509_cert_guard_href, name, ca_certificate, opts)
+
+Partially update a x509 cert guard
+
+X509CertGuard API Viewsets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_certguard_client'
+# setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+x509_cert_guard_href = 'x509_cert_guard_href_example' # String | URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/
+name = 'name_example' # String | The unique name.
+ca_certificate = File.new('/path/to/file') # File | The Certificate Authority (CA) certificate.
+opts = {
+  description: 'description_example' # String | An optional description.
+}
+
+begin
+  #Partially update a x509 cert guard
+  result = api_instance.partial_update(x509_cert_guard_href, name, ca_certificate, opts)
+  p result
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x509_cert_guard_href** | **String**| URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/ | 
+ **name** | **String**| The unique name. | 
+ **ca_certificate** | **File**| The Certificate Authority (CA) certificate. | 
+ **description** | **String**| An optional description. | [optional] 
+
+### Return type
+
+[**CertguardX509CertGuard**](CertguardX509CertGuard.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## read
+
+> CertguardX509CertGuard read(x509_cert_guard_href, opts)
+
+Inspect a x509 cert guard
+
+X509CertGuard API Viewsets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_certguard_client'
+# setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+x509_cert_guard_href = 'x509_cert_guard_href_example' # String | URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/
+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 x509 cert guard
+  result = api_instance.read(x509_cert_guard_href, opts)
+  p result
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x509_cert_guard_href** | **String**| URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/ | 
+ **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
+
+[**CertguardX509CertGuard**](CertguardX509CertGuard.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> CertguardX509CertGuard update(x509_cert_guard_href, name, ca_certificate, opts)
+
+Update a x509 cert guard
+
+X509CertGuard API Viewsets.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_certguard_client'
+# setup authorization
+PulpCertguardClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCertguardClient::ContentguardsX509Api.new
+x509_cert_guard_href = 'x509_cert_guard_href_example' # String | URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/
+name = 'name_example' # String | The unique name.
+ca_certificate = File.new('/path/to/file') # File | The Certificate Authority (CA) certificate.
+opts = {
+  description: 'description_example' # String | An optional description.
+}
+
+begin
+  #Update a x509 cert guard
+  result = api_instance.update(x509_cert_guard_href, name, ca_certificate, opts)
+  p result
+rescue PulpCertguardClient::ApiError => e
+  puts "Exception when calling ContentguardsX509Api->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x509_cert_guard_href** | **String**| URI of X509 Cert Guard. e.g.: /pulp/api/v3/contentguards/certguard/x509/1/ | 
+ **name** | **String**| The unique name. | 
+ **ca_certificate** | **File**| The Certificate Authority (CA) certificate. | 
+ **description** | **String**| An optional description. | [optional] 
+
+### Return type
+
+[**CertguardX509CertGuard**](CertguardX509CertGuard.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+