# pulpcore_client

PulpcoreClient - 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: 3.0.0rc3
- Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build pulpcore_client.gemspec
```

Then either install the gem locally:

```shell
gem install ./pulpcore_client-3.0.0rc3.gem
```

(for development, run `gem install --dev ./pulpcore_client-3.0.0rc3.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 'pulpcore_client', '~> 3.0.0rc3'

### 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 'pulpcore_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 'pulpcore_client'

# Setup authorization
PulpcoreClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpcoreClient::ArtifactsApi.new
opts = {
  file: File.new('/path/to/file'), # File | The stored file.
  size: 56, # Integer | The size of the file in bytes.
  md5: 'md5_example', # String | The MD5 checksum of the file if available.
  sha1: 'sha1_example', # String | The SHA-1 checksum of the file if available.
  sha224: 'sha224_example', # String | The SHA-224 checksum of the file if available.
  sha256: 'sha256_example', # String | The SHA-256 checksum of the file if available.
  sha384: 'sha384_example', # String | The SHA-384 checksum of the file if available.
  sha512: 'sha512_example', # String | The SHA-512 checksum of the file if available.
  upload: 'upload_example' # String | An href for an Upload.
}

begin
  #Create an artifact
  result = api_instance.create(opts)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling ArtifactsApi->create: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:24817*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PulpcoreClient::ArtifactsApi* | [**create**](docs/ArtifactsApi.md#create) | **POST** /pulp/api/v3/artifacts/ | Create an artifact
*PulpcoreClient::ArtifactsApi* | [**delete**](docs/ArtifactsApi.md#delete) | **DELETE** {artifact_href} | Delete an artifact
*PulpcoreClient::ArtifactsApi* | [**list**](docs/ArtifactsApi.md#list) | **GET** /pulp/api/v3/artifacts/ | List artifacts
*PulpcoreClient::ArtifactsApi* | [**read**](docs/ArtifactsApi.md#read) | **GET** {artifact_href} | Inspect an artifact
*PulpcoreClient::OrphansApi* | [**delete**](docs/OrphansApi.md#delete) | **DELETE** /pulp/api/v3/orphans/ | Delete orphans
*PulpcoreClient::RepositoriesApi* | [**create**](docs/RepositoriesApi.md#create) | **POST** /pulp/api/v3/repositories/ | Create a repository
*PulpcoreClient::RepositoriesApi* | [**delete**](docs/RepositoriesApi.md#delete) | **DELETE** {repository_href} | Delete a repository
*PulpcoreClient::RepositoriesApi* | [**list**](docs/RepositoriesApi.md#list) | **GET** /pulp/api/v3/repositories/ | List repositories
*PulpcoreClient::RepositoriesApi* | [**partial_update**](docs/RepositoriesApi.md#partial_update) | **PATCH** {repository_href} | Partially update a repository
*PulpcoreClient::RepositoriesApi* | [**read**](docs/RepositoriesApi.md#read) | **GET** {repository_href} | Inspect a repository
*PulpcoreClient::RepositoriesApi* | [**update**](docs/RepositoriesApi.md#update) | **PUT** {repository_href} | Update a repository
*PulpcoreClient::RepositoriesVersionsApi* | [**create**](docs/RepositoriesVersionsApi.md#create) | **POST** {repository_href}versions/ | Create a repository version
*PulpcoreClient::RepositoriesVersionsApi* | [**delete**](docs/RepositoriesVersionsApi.md#delete) | **DELETE** {repository_version_href} | Delete a repository version
*PulpcoreClient::RepositoriesVersionsApi* | [**list**](docs/RepositoriesVersionsApi.md#list) | **GET** {repository_href}versions/ | List repository versions
*PulpcoreClient::RepositoriesVersionsApi* | [**read**](docs/RepositoriesVersionsApi.md#read) | **GET** {repository_version_href} | Inspect a repository version
*PulpcoreClient::StatusApi* | [**status_read**](docs/StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
*PulpcoreClient::TasksApi* | [**delete**](docs/TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
*PulpcoreClient::TasksApi* | [**list**](docs/TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
*PulpcoreClient::TasksApi* | [**read**](docs/TasksApi.md#read) | **GET** {task_href} | Inspect a task
*PulpcoreClient::TasksApi* | [**tasks_cancel**](docs/TasksApi.md#tasks_cancel) | **PATCH** {task_href} | Cancel a task
*PulpcoreClient::UploadsApi* | [**commit**](docs/UploadsApi.md#commit) | **PUT** {upload_href}commit/ | Finish an Upload
*PulpcoreClient::UploadsApi* | [**create**](docs/UploadsApi.md#create) | **POST** /pulp/api/v3/uploads/ | Create an upload
*PulpcoreClient::UploadsApi* | [**delete**](docs/UploadsApi.md#delete) | **DELETE** {upload_href} | Delete an upload
*PulpcoreClient::UploadsApi* | [**list**](docs/UploadsApi.md#list) | **GET** /pulp/api/v3/uploads/ | List uploads
*PulpcoreClient::UploadsApi* | [**read**](docs/UploadsApi.md#read) | **GET** {upload_href} | Inspect an upload
*PulpcoreClient::UploadsApi* | [**update**](docs/UploadsApi.md#update) | **PUT** {upload_href} | Upload a file chunk
*PulpcoreClient::WorkersApi* | [**list**](docs/WorkersApi.md#list) | **GET** /pulp/api/v3/workers/ | List workers
*PulpcoreClient::WorkersApi* | [**read**](docs/WorkersApi.md#read) | **GET** {worker_href} | Inspect a worker


## Documentation for Models

 - [PulpcoreClient::Artifact](docs/Artifact.md)
 - [PulpcoreClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
 - [PulpcoreClient::ContentAppStatus](docs/ContentAppStatus.md)
 - [PulpcoreClient::DatabaseConnection](docs/DatabaseConnection.md)
 - [PulpcoreClient::InlineResponse200](docs/InlineResponse200.md)
 - [PulpcoreClient::InlineResponse2001](docs/InlineResponse2001.md)
 - [PulpcoreClient::InlineResponse2002](docs/InlineResponse2002.md)
 - [PulpcoreClient::InlineResponse2003](docs/InlineResponse2003.md)
 - [PulpcoreClient::InlineResponse2004](docs/InlineResponse2004.md)
 - [PulpcoreClient::InlineResponse2005](docs/InlineResponse2005.md)
 - [PulpcoreClient::ProgressReport](docs/ProgressReport.md)
 - [PulpcoreClient::RedisConnection](docs/RedisConnection.md)
 - [PulpcoreClient::Repository](docs/Repository.md)
 - [PulpcoreClient::RepositoryVersion](docs/RepositoryVersion.md)
 - [PulpcoreClient::RepositoryVersionCreate](docs/RepositoryVersionCreate.md)
 - [PulpcoreClient::Status](docs/Status.md)
 - [PulpcoreClient::Task](docs/Task.md)
 - [PulpcoreClient::TaskCancel](docs/TaskCancel.md)
 - [PulpcoreClient::Upload](docs/Upload.md)
 - [PulpcoreClient::UploadCommit](docs/UploadCommit.md)
 - [PulpcoreClient::Version](docs/Version.md)
 - [PulpcoreClient::Worker](docs/Worker.md)


## Documentation for Authorization


### Basic

- **Type**: HTTP basic authentication