Module: Mosaic::Sdk

Extended by:
Configuration
Defined in:
lib/mosaic/sdk.rb,
lib/mosaic/sdk/client.rb,
lib/mosaic/sdk/version.rb,
lib/mosaic/sdk/models/dna.rb,
lib/mosaic/sdk/models/nav.rb,
lib/mosaic/sdk/models/bank.rb,
lib/mosaic/sdk/models/base.rb,
lib/mosaic/sdk/models/clone.rb,
lib/mosaic/sdk/configuration.rb

Overview

Main module of the Mosaic SDK.

Provides factory methods to access API resources (banks, DNAs, clones) and configuration management via Configuration.

Examples:

Configure the SDK

Mosaic::Sdk.configure do |config|
  config.client_id = 'your_client_id'
  config.client_secret = 'your_client_secret'
end

Access resources

Mosaic::Sdk.Bank.list          # list all banks
Mosaic::Sdk.Bank(42).data      # get a specific bank
Mosaic::Sdk.Dna(1).clones.list # list clones for a DNA

Defined Under Namespace

Modules: Configuration, Models Classes: Client

Constant Summary collapse

VERSION = 
'0.4.0'

Class Method Summary collapse

Methods included from Configuration

config, configure

Class Method Details

.Bank(id = nil) ⇒ Models::Bank, Models::Bank::Instance

Returns a bank collection or a specific bank instance.

Parameters:

  • id (String, Integer, nil) (defaults to: nil) —

    the bank ID, or nil for the collection

Returns:

.Clone(id = nil) ⇒ Models::Clone, Models::Clone::Instance

Returns a clone collection or a specific clone instance.

Parameters:

  • id (String, Integer, nil) (defaults to: nil) —

    the clone ID, or nil for the collection

Returns:

.Dna(id = nil) ⇒ Models::Dna, Models::Dna::Instance

Returns a DNA collection or a specific DNA instance.

Parameters:

  • id (String, Integer, nil) (defaults to: nil) —

    the DNA ID, or nil for the collection

Returns: