README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://slis.services.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/slis/hub-php-adapter.git"
    }
  ],
  "require": {
    "slis/hub-php-adapter": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/HubAdapter/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



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


$apiInstance = new SLIS\Adapter\Hub\Api\BenutzerApi(
    // 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
);
$uuid = 'uuid_example'; // string | Resource identifier

try {
    $apiInstance->deleteBenutzerItem($uuid);
} catch (Exception $e) {
    echo 'Exception when calling BenutzerApi->deleteBenutzerItem: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
BenutzerApi	deleteBenutzerItem	DELETE /benutzers/{uuid}	Removes the Benutzer resource.
BenutzerApi	getBenutzerCollection	GET /benutzers	Retrieves the collection of Benutzer resources.
BenutzerApi	getBenutzerItem	GET /benutzers/{uuid}	Retrieves a Benutzer resource.
BenutzerApi	postBenutzerCollection	POST /benutzers	Creates a Benutzer resource.
BenutzerApi	putBenutzerItem	PUT /benutzers/{uuid}	Replaces the Benutzer resource.
BestellungApi	apiKundesBestellungensGetSubresourceKundeSubresource	GET /kundes/{uuid}/bestellungens	Retrieves a Kunde resource.
BestellungApi	deleteBestellungItem	DELETE /bestellung/{uuid}	Removes the Bestellung resource.
BestellungApi	getAvaliblePositionsBestellungCollection	GET /bestellung/positionen/_available	Get a list of all available order positions
BestellungApi	getBestellungCollection	GET /bestellung	Retrieves the collection of Bestellung resources.
BestellungApi	getBestellungItem	GET /bestellung/{uuid}	Retrieves a Bestellung resource.
BestellungApi	patchBestellungItem	PATCH /bestellung/{uuid}	Updates the Bestellung resource.
BestellungApi	postBestellungCollection	POST /bestellung	Creates a Bestellung resource.
FirewallApi	apiFirewallsServiceLevelAgreementGetSubresourceFirewallSubresource	GET /firewalls/{uuid}/service_level_agreement	Retrieves a Firewall resource.
FirewallApi	deleteFirewallItem	DELETE /firewalls/{uuid}	Removes the Firewall resource.
FirewallApi	getFirewallCollection	GET /firewalls	Retrieves the collection of Firewall resources.
FirewallApi	getFirewallItem	GET /firewalls/{uuid}	Retrieves a Firewall resource.
FirewallApi	postFirewallCollection	POST /firewalls	Creates a Firewall resource.
FirewallApi	putFirewallItem	PUT /firewalls/{uuid}	Replaces the Firewall resource.
GeraetApi	deleteGeraetItem	DELETE /geraets/{uuid}	Removes the Geraet resource.
GeraetApi	getGeraetCollection	GET /geraets	Retrieves the collection of Geraet resources.
GeraetApi	getGeraetItem	GET /geraets/{uuid}	Retrieves a Geraet resource.
GeraetApi	putGeraetItem	PUT /geraets/{uuid}	Replaces the Geraet resource.
GeraetTypApi	deleteGeraetTypItem	DELETE /geraet-typ/{uuid}	Removes the GeraetTyp resource.
GeraetTypApi	getGeraetTypCollection	GET /geraet-typ	Retrieves the collection of GeraetTyp resources.
GeraetTypApi	getGeraetTypItem	GET /geraet-typ/{uuid}	Retrieves a GeraetTyp resource.
GeraetTypApi	postGeraetTypCollection	POST /geraet-typ	Creates a GeraetTyp resource.
HerstellerApi	deleteHerstellerItem	DELETE /herstellers/{uuid}	Removes the Hersteller resource.
HerstellerApi	getHerstellerCollection	GET /herstellers	Retrieves the collection of Hersteller resources.
HerstellerApi	getHerstellerItem	GET /herstellers/{uuid}	Retrieves a Hersteller resource.
HerstellerApi	postHerstellerCollection	POST /herstellers	Creates a Hersteller resource.
HerstellerApi	putHerstellerItem	PUT /herstellers/{uuid}	Replaces the Hersteller resource.
KategorieApi	deleteKategorieItem	DELETE /kategories/{name}	Removes the Kategorie resource.
KategorieApi	getKategorieCollection	GET /kategories	Retrieves the collection of Kategorie resources.
KategorieApi	getKategorieItem	GET /kategories/{name}	Retrieves a Kategorie resource.
KategorieApi	postKategorieCollection	POST /kategories	Creates a Kategorie resource.
KategorieApi	putKategorieItem	PUT /kategories/{name}	Replaces the Kategorie resource.
KimApi	deleteKimItem	DELETE /kims/{id}	Removes the Kim resource.
KimApi	getKimCollection	GET /kims	Retrieves the collection of Kim resources.
KimApi	getKimItem	GET /kims/{id}	Retrieves a Kim resource.
KimApi	patchKimItem	PATCH /kims/{id}	Updates the Kim resource.
KimApi	postKimCollection	POST /kims	Creates a Kim resource.
KimApi	putKimItem	PUT /kims/{id}	Replaces the Kim resource.
KundeApi	apiKundesBestellungensGetSubresourceKundeSubresource	GET /kundes/{uuid}/bestellungens	Retrieves a Kunde resource.
KundeApi	deleteKundeItem	DELETE /kunden/{uuid}	Removes the Kunde resource.
KundeApi	getKundeCollection	GET /kunden	Retrieves the collection of Kunde resources.
KundeApi	getKundeItem	GET /kunden/{uuid}	Retrieves a Kunde resource.
KundeApi	postKundeCollection	POST /kunden	Creates a Kunde resource.
KundeApi	putKundeItem	PUT /kunden/{uuid}	Replaces the Kunde resource.
NetzwerkApi	apiStandortsNetzwerkesGetSubresourceStandortSubresource	GET /standorts/{uuid}/netzwerkes	Retrieves a Standort resource.
NetzwerkApi	deleteNetzwerkItem	DELETE /netzwerk/{uuid}	Removes the Netzwerk resource.
NetzwerkApi	getNetzwerkCollection	GET /netzwerk	Retrieves the collection of Netzwerk resources.
NetzwerkApi	getNetzwerkItem	GET /netzwerk/{uuid}	Retrieves a Netzwerk resource.
NetzwerkApi	postNetzwerkCollection	POST /netzwerk	Creates a Netzwerk resource.
ServiceLevelAgreementApi	apiFirewallsServiceLevelAgreementGetSubresourceFirewallSubresource	GET /firewalls/{uuid}/service_level_agreement	Retrieves a Firewall resource.
ServiceLevelAgreementApi	deleteServiceLevelAgreementItem	DELETE /sla/{uuid}	Removes the ServiceLevelAgreement resource.
ServiceLevelAgreementApi	getServiceLevelAgreementCollection	GET /sla	Retrieves the collection of ServiceLevelAgreement resources.
ServiceLevelAgreementApi	getServiceLevelAgreementItem	GET /sla/{uuid}	Retrieves a ServiceLevelAgreement resource.
ServiceLevelAgreementApi	postServiceLevelAgreementCollection	POST /sla	Creates a ServiceLevelAgreement resource.
StandortApi	apiStandortsNetzwerkesGetSubresourceStandortSubresource	GET /standorts/{uuid}/netzwerkes	Retrieves a Standort resource.
StandortApi	deleteStandortItem	DELETE /standorte/{uuid}	Removes the Standort resource.
StandortApi	getStandortCollection	GET /standorte	Retrieves the collection of Standort resources.
StandortApi	getStandortItem	GET /standorte/{uuid}	Retrieves a Standort resource.
StandortApi	postStandortCollection	POST /standorte	Creates a Standort resource.
StatusApi	getStatusCollection	GET /statuses	Retrieves the collection of Status resources.
StatusApi	getStatusItem	GET /statuses/{uuid}	Retrieves a Status resource.
TagApi	deleteTagItem	DELETE /tags/{uuid}	Removes the Tag resource.
TagApi	getTagCollection	GET /tags	Retrieves the collection of Tag resources.
TagApi	getTagItem	GET /tags/{uuid}	Retrieves a Tag resource.
TagApi	postTagCollection	POST /tags	Creates a Tag resource.
TagApi	putTagItem	PUT /tags/{uuid}	Replaces the Tag resource.
TokenApi	postCredentialsItem	POST /authentication_token	Get JWT token to login.

Models

Authorization

JWT

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

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

dev@slis.io

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 0.7.4
- Package version: 0.7.4
Build package: org.openapitools.codegen.languages.PhpClientCodegen

slis / hub-php-adapter

Maintainers

Details