cloudsmith-api

CloudsmithApi - the Ruby gem for the Cloudsmith API

The API to the Cloudsmith Service

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 0.30.7
• Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://help.cloudsmith.io

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudsmith-api.gemspec

Then either install the gem locally:

gem install ./cloudsmith-api-0.30.7.gem

(for development, run gem install --dev ./cloudsmith-api-0.30.7.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cloudsmith-api', '~> 0.30.7'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/cloudsmith-io/cloudsmith-api, then add the following in the Gemfile:

gem 'cloudsmith-api', :git => 'https://github.com/cloudsmith-io/cloudsmith-api.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cloudsmith-api'

# Setup authorization
CloudsmithApi.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-Api-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-Api-Key'] = 'Bearer'

  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: csrf_token
  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-CSRFToken'] = 'Bearer'
end

api_instance = CloudsmithApi::DistrosApi.new

begin
  #Get a list of all supported distributions.
  result = api_instance.distros_list
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling DistrosApi->distros_list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.cloudsmith.io/v1

Class	Method	HTTP request	Description
CloudsmithApi::DistrosApi	distros_list	GET /distros/	Get a list of all supported distributions.
CloudsmithApi::DistrosApi	distros_read	GET /distros/slug/	View for viewing/listing package formats.
CloudsmithApi::EntitlementsApi	entitlements_create	POST /entitlements/owner/repo/	Create a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi	entitlements_delete	DELETE /entitlements/owner/repo/identifier/	Delete a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi	entitlements_disable	POST /entitlements/owner/repo/identifier/disable/	Disable an entitlement token in a repository.
CloudsmithApi::EntitlementsApi	entitlements_enable	POST /entitlements/owner/repo/identifier/enable/	Enable an entitlement token in a repository.
CloudsmithApi::EntitlementsApi	entitlements_list	GET /entitlements/owner/repo/	Get a list of all entitlements in a repository.
CloudsmithApi::EntitlementsApi	entitlements_partial_update	PATCH /entitlements/owner/repo/identifier/	Update a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi	entitlements_read	GET /entitlements/owner/repo/identifier/	Get a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi	entitlements_refresh	POST /entitlements/owner/repo/identifier/refresh/	Refresh an entitlement token in a repository.
CloudsmithApi::EntitlementsApi	entitlements_reset	POST /entitlements/owner/repo/identifier/reset/	Reset the statistics for an entitlement token in a repository.
CloudsmithApi::EntitlementsApi	entitlements_sync	POST /entitlements/owner/repo/sync/	Synchronise tokens from a source repository.
CloudsmithApi::FilesApi	files_create	POST /files/owner/repo/	Request URL(s) to POST new package file upload(s) to.
CloudsmithApi::FilesApi	files_validate	POST /files/owner/repo/validate/	Validate parameters used for create.
CloudsmithApi::FormatsApi	formats_list	GET /formats/	Get a list of all supported package formats.
CloudsmithApi::FormatsApi	formats_read	GET /formats/slug/	Get a specific supported package format.
CloudsmithApi::NamespacesApi	namespaces_list	GET /namespaces/	Get a list of all namespaces the user belongs to.
CloudsmithApi::NamespacesApi	namespaces_read	GET /namespaces/slug/	Views for working with namespaces.
CloudsmithApi::OrgsApi	orgs_list	GET /orgs/	Get a list of all the organizations you are associated with.
CloudsmithApi::OrgsApi	orgs_read	GET /orgs/slug/	Views for working with organizations.
CloudsmithApi::PackagesApi	packages_copy	POST /packages/owner/repo/identifier/copy/	Copy a package to another repository.
CloudsmithApi::PackagesApi	packages_delete	DELETE /packages/owner/repo/identifier/	Delete a specific package in a repository.
CloudsmithApi::PackagesApi	packages_list	GET /packages/owner/repo/	Views for working with repository packages.
CloudsmithApi::PackagesApi	packages_move	POST /packages/owner/repo/identifier/move/	Move a package to another repository.
CloudsmithApi::PackagesApi	packages_read	GET /packages/owner/repo/identifier/	Get a specific package in a repository.
CloudsmithApi::PackagesApi	packages_resync	POST /packages/owner/repo/identifier/resync/	Schedule a package for resynchronisation.
CloudsmithApi::PackagesApi	packages_status	GET /packages/owner/repo/identifier/status/	Get the synchronisation status for a package.
CloudsmithApi::PackagesApi	packages_upload_composer	POST /packages/owner/repo/upload/composer/	Create a new Composer package
CloudsmithApi::PackagesApi	packages_upload_deb	POST /packages/owner/repo/upload/deb/	Create a new Debian package
CloudsmithApi::PackagesApi	packages_upload_maven	POST /packages/owner/repo/upload/maven/	Create a new Maven package
CloudsmithApi::PackagesApi	packages_upload_python	POST /packages/owner/repo/upload/python/	Create a new Python package
CloudsmithApi::PackagesApi	packages_upload_raw	POST /packages/owner/repo/upload/raw/	Create a new Raw package
CloudsmithApi::PackagesApi	packages_upload_rpm	POST /packages/owner/repo/upload/rpm/	Create a new RedHat package
CloudsmithApi::PackagesApi	packages_upload_ruby	POST /packages/owner/repo/upload/ruby/	Create a new Ruby package
CloudsmithApi::PackagesApi	packages_upload_vagrant	POST /packages/owner/repo/upload/vagrant/	Create a new Vagrant package
CloudsmithApi::PackagesApi	packages_validate_upload_composer	POST /packages/owner/repo/validate-upload/composer/	Validate parameters for create Composer package
CloudsmithApi::PackagesApi	packages_validate_upload_deb	POST /packages/owner/repo/validate-upload/deb/	Validate parameters for create Debian package
CloudsmithApi::PackagesApi	packages_validate_upload_maven	POST /packages/owner/repo/validate-upload/maven/	Validate parameters for create Maven package
CloudsmithApi::PackagesApi	packages_validate_upload_python	POST /packages/owner/repo/validate-upload/python/	Validate parameters for create Python package
CloudsmithApi::PackagesApi	packages_validate_upload_raw	POST /packages/owner/repo/validate-upload/raw/	Validate parameters for create Raw package
CloudsmithApi::PackagesApi	packages_validate_upload_rpm	POST /packages/owner/repo/validate-upload/rpm/	Validate parameters for create RedHat package
CloudsmithApi::PackagesApi	packages_validate_upload_ruby	POST /packages/owner/repo/validate-upload/ruby/	Validate parameters for create Ruby package
CloudsmithApi::PackagesApi	packages_validate_upload_vagrant	POST /packages/owner/repo/validate-upload/vagrant/	Validate parameters for create Vagrant package
CloudsmithApi::RatesApi	rates_limits_list	GET /rates/limits/	Endpoint to check rate limits for current user.
CloudsmithApi::ReposApi	repos_list	GET /repos/	Get a list of all repositories associated with current user.
CloudsmithApi::ReposApi	repos_list0	GET /repos/owner/	Get a list of all repositories within a namespace.
CloudsmithApi::ReposApi	repos_read	GET /repos/owner/slug/	Views for working with repositories.
CloudsmithApi::StatusApi	status_check_basic	GET /status/check/basic/	Endpoint to check basic API connectivity.
CloudsmithApi::UserApi	user_self	GET /user/self/	Provide a brief for the current user (if any).
CloudsmithApi::UserApi	user_token_create	POST /user/token/	Retrieve the API key/token for the authenticated user.
CloudsmithApi::UsersApi	users_profile_read	GET /users/profile/slug/	Provide a brief for the specified user (if any).
CloudsmithApi::WebhooksApi	webhooks_create	POST /webhooks/owner/repo/	Create a specific webhook in a repository.
CloudsmithApi::WebhooksApi	webhooks_delete	DELETE /webhooks/owner/repo/identifier/	Delete a specific webhook in a repository.
CloudsmithApi::WebhooksApi	webhooks_list	GET /webhooks/owner/repo/	Get a list of all webhooks in a repository.
CloudsmithApi::WebhooksApi	webhooks_partial_update	PATCH /webhooks/owner/repo/identifier/	Update a specific webhook in a repository.
CloudsmithApi::WebhooksApi	webhooks_read	GET /webhooks/owner/repo/identifier/	Views for working with repository webhooks.

Documentation for Models

• CloudsmithApi::Distribution
• CloudsmithApi::DistrosVersions
• CloudsmithApi::EntitlementsCreate
• CloudsmithApi::EntitlementsPartialUpdate
• CloudsmithApi::EntitlementsRefresh
• CloudsmithApi::EntitlementsSync
• CloudsmithApi::FilesCreate
• CloudsmithApi::FilesValidate
• CloudsmithApi::Format
• CloudsmithApi::FormatsDistributions
• CloudsmithApi::MavenPackageUpload
• CloudsmithApi::Namespace
• CloudsmithApi::Organization
• CloudsmithApi::Package
• CloudsmithApi::PackageCopy
• CloudsmithApi::PackageFileUpload
• CloudsmithApi::PackageMove
• CloudsmithApi::PackageStatus
• CloudsmithApi::PackagesCopy
• CloudsmithApi::PackagesMove
• CloudsmithApi::PackagesUploadComposer
• CloudsmithApi::PackagesUploadDeb
• CloudsmithApi::PackagesUploadMaven
• CloudsmithApi::PackagesUploadPython
• CloudsmithApi::PackagesUploadRaw
• CloudsmithApi::PackagesUploadRpm
• CloudsmithApi::PackagesUploadRuby
• CloudsmithApi::PackagesUploadVagrant
• CloudsmithApi::PackagesValidateuploadComposer
• CloudsmithApi::PackagesValidateuploadDeb
• CloudsmithApi::PackagesValidateuploadMaven
• CloudsmithApi::PackagesValidateuploadPython
• CloudsmithApi::PackagesValidateuploadRaw
• CloudsmithApi::PackagesValidateuploadRpm
• CloudsmithApi::PackagesValidateuploadRuby
• CloudsmithApi::PackagesValidateuploadVagrant
• CloudsmithApi::PackagesownerrepoArchitectures
• CloudsmithApi::PackagesownerrepoFiles
• CloudsmithApi::RawPackageUpload
• CloudsmithApi::ReposGpgKeys
• CloudsmithApi::Repository
• CloudsmithApi::RepositoryToken
• CloudsmithApi::RepositoryTokenRefresh
• CloudsmithApi::RepositoryTokenSync
• CloudsmithApi::RepositoryTokenSyncTokens
• CloudsmithApi::RepositoryWebhook
• CloudsmithApi::ResourcesRateCheck
• CloudsmithApi::Status
• CloudsmithApi::StatusBasic
• CloudsmithApi::UserAuthToken
• CloudsmithApi::UserBrief
• CloudsmithApi::UserProfile
• CloudsmithApi::UserTokenCreate
• CloudsmithApi::VagrantPackageUpload
• CloudsmithApi::WebhooksCreate
• CloudsmithApi::WebhooksPartialUpdate
• CloudsmithApi::WebhooksownerrepoTemplates

Documentation for Authorization

apikey

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

basic

• Type: HTTP basic authentication

csrf_token

• Type: API key
• API key parameter name: X-CSRFToken
• Location: HTTP header