Lumminary

A general-purpose API for accessing genomic data

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/lumminary/api-client-php.git"
    }
  ],
  "require": {
    "lumminary/api-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/Lumminary/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
$config = Lumminary\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Lumminary\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Lumminary\Client\Api\LumminaryAPISpecApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$productId = "productId_example"; // string | The UUID of the product
$seqNumStart = "seqNumStart_example"; // string | The first sequence number from which to fetch (the sequence number of the last processed authorization)
$xFields = "xFields_example"; // string | An optional fields mask

try {
    $result = $apiInstance->getAuthorizationsQueue($productId, $seqNumStart, $xFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LumminaryAPISpecApi->getAuthorizationsQueue: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.lumminary.com/v1

Class	Method	HTTP request	Description
LumminaryAPISpecApi	getAuthorizationsQueue	GET /products/{productId}/authorizations
LumminaryAPISpecApi	getClientGene	GET /clients/{clientId}/datasets/{datasetId}/genes/{geneSymbol}	Get gene by symbol
LumminaryAPISpecApi	getClientSnp	GET /clients/{clientId}/datasets/{datasetId}/snps/{snpId}	Get SNP information
LumminaryAPISpecApi	getClientSnpGroup	GET /clients/{clientId}/datasets/{datasetId}/snps/
LumminaryAPISpecApi	getGene	GET /reference/genes/databases/{databaseName}/accessions/{accession}	Generic gene information
LumminaryAPISpecApi	getProduct	GET /products/{productId}	Get product details
LumminaryAPISpecApi	getProductAuthorization	GET /products/{productId}/authorizations/{authorizationId}
LumminaryAPISpecApi	getReferenceChromosome	GET /reference/genomes/{genomeBuildAccession}/chromosomes/{chromosomeAccession}	Sequence for a region of the reference genome
LumminaryAPISpecApi	getReferenceGenome	GET /reference/genomes/{genomeBuildAccession}/chromosomes	Reference genome metadata
LumminaryAPISpecApi	getReferenceGenomesGroup	GET /reference/genomes/	Reference genome builds
LumminaryAPISpecApi	getReferenceSnp	GET /reference/snps/{snpAccession}	Reference SNP data
LumminaryAPISpecApi	postAuthorizationResultCredentials	POST /products/{productId}/authorizations/{authorizationId}/credentials	Provide a result for the authorization
LumminaryAPISpecApi	postAuthorizationResultFile	POST /products/{productId}/authorizations/{authorizationId}/file	Provide a file result to the authorization, e
LumminaryAPISpecApi	postClientSnpGroup	POST /clients/{clientId}/datasets/{datasetId}/snps/	Get a large group of SNPs
LumminaryAPISpecApi	postJwtAuth	POST /auth/jwt	General-purpose authentication
LumminaryAPISpecApi	postProductAuthorization	POST /products/{productId}/authorizations/{authorizationId}	Signal that processing is complete, without uploading any result
LumminaryAPISpecApi	postProductAuthorizationUnfulfillable	POST /products/{productId}/authorizations/{authorizationId}/unfulfillable	Catch-all Authorization state, for authorizations that passed all verifications and should reach the partner Product, but cannot be fulfilled for various reasons

Documentation For Models

• AccessScope
• Authorization
• ClientGene
• ClientSNP
• CustomerAddress
• CustomerName
• JavascriptWebToken
• MolecularLocation
• Product
• PublicGene
• PublicSNP
• ReferenceChromosomeOverview
• ReferenceGenomeOverview
• ReferenceSequence
• ReportCredentials
• ReportFile
• SnpsMinRequired

Documentation For Authorization

Bearer

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

Author