beekube-app / blup-php-sdk
Official Brevo provided RESTFul API V3 php library
1.0.7
2025-01-12 23:03 UTC
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/psr7: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- overtrue/phplint: ^9.0
- phpunit/phpunit: ^9.0
README
SDK PHP pour l'API BLUP de Beekube - Calcul génétique des abeilles mellifères
For more information, please visit https://www.beekube.com.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "require": { "beekube-app/blup-php-sdk": "*" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/blup-php-sdk/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Beekube\BlupSDK\Api\BlupApi( // 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() ); $bLUPInput = new \Beekube\BlupSDK\Models\BLUPInput(); // \Beekube\BlupSDK\Models\BLUPInput try { $result = $apiInstance->calulateBlupPost($bLUPInput); print_r($result); } catch (Exception $e) { echo 'Exception when calling BlupApi->calulateBlupPost: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://mellifera.beekube.com
Class | Method | HTTP request | Description |
---|---|---|---|
BlupApi | calulateBlupPost | POST /blup | Perform BLUP calculation |
BlupApi | welcomeGet | GET / | Welcome endpoint |
Models
- BLUPInput
- BLUPOutput
- BLUPResultOutput
- ErrorResponse
- Evaluation
- HeritabilityStats
- MatingSuggestion
- MethodsValue
- QueenBeeInput
- QueenBeeOutput
- Results
- ValidationErrorModel
- WelcomeResponse
Authorization
All endpoints do not require authorization.
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0
- Package version:
1.0.7
- Generator version:
7.10.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen