The Ruby SDK
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
viswiz_sdk.gemspec Ruby SDK

ViswizSdk - the Ruby gem for the API Documentation

This SDK allows you to query and create new projects, builds or images within the VisWiz service.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

For more information, please visit


Build a gem

To build the Ruby code into a gem:

gem build viswiz_sdk.gemspec

Then either install the gem locally:

gem install ./viswiz_sdk-1.0.0.gem

(for development, run gem install --dev ./viswiz_sdk-1.0.0.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 'viswiz_sdk', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository:, then add the following in the Gemfile:

gem 'viswiz_sdk', :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:

require 'viswiz_sdk'

# Setup authorization
ViswizSdk.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'Bearer'

api_instance =

  result = api_instance.get_projects()
  p result
rescue ViswizSdk::ApiError => e
  puts "Exception when calling ProjectsApi->get_projects: #{e}"

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
ViswizSdk::AccountApi create_webhook POST /webhooks Create a new webhook
ViswizSdk::AccountApi get_account GET /account Get account info
ViswizSdk::AccountApi get_webhooks GET /webhooks Get all webhooks
ViswizSdk::BuildsApi create_build POST /projects/{projectID}/builds Create a build
ViswizSdk::BuildsApi finish_build POST /builds/{buildID}/finish Finish a build
ViswizSdk::BuildsApi get_build_results GET /builds/{buildID}/results Get results for a build
ViswizSdk::BuildsApi get_builds GET /projects/{projectID}/builds Get builds for a project
ViswizSdk::ImagesApi create_image POST /builds/{buildID}/images Create an image
ViswizSdk::ImagesApi get_images GET /builds/{buildID}/images Get images for a build
ViswizSdk::PlansApi cancel_plan DELETE /account/cancel-plan Cancel the active plan
ViswizSdk::PlansApi get_plans GET /plans Get all plans
ViswizSdk::ProjectsApi create_project POST /projects Create a project
ViswizSdk::ProjectsApi get_project_notifications GET /projects/{projectID}/notifications Get notifications settings
ViswizSdk::ProjectsApi get_projects GET /projects Get all projects
ViswizSdk::ProjectsApi update_project_notifications PUT /projects/{projectID}/notifications Update notifications settings

Documentation for Models

Documentation for Authorization


  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header