Download the PHP package lenra/internal-api-client without Composer
On this page you can find all versions of the php package lenra/internal-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lenra/internal-api-client
More information about lenra/internal-api-client
Files in lenra/internal-api-client
Package internal-api-client
Short Description The API usable by the Lenra applications
License MIT
Homepage https://openapi-generator.tech
Informations about the package internal-api-client
OpenAPIClient-php
The API usable by the Lenra applications
For more information, please visit https://www.lenra.io/contact.html.
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
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Getting Started
Please follow the installation procedure and then run the following:
API Endpoints
All URIs are relative to http://localhost:4001
Class | Method | HTTP request | Description |
---|---|---|---|
DataApi | abortTransaction | POST /app-api/v1/data/transaction/abort | Aborts a transaction |
DataApi | commitTransaction | POST /app-api/v1/data/transaction/commit | Commits a transaction |
DataApi | createDocument | POST /app-api/v1/data/colls/{coll}/docs | Creates a document in database |
DataApi | createTransaction | POST /app-api/v1/data/transaction | Creates a transaction |
DataApi | deleteCollection | DELETE /app-api/v1-api/v1/data/colls/{coll} | Deletes a collection from database |
DataApi | deleteDocumentById | DELETE /app-api/v1/data/colls/{coll}/docs/{id} | Deletes a document from database |
DataApi | findDocuments | POST /app-api/v1/data/colls/{coll}/find | Finds documents in database |
DataApi | getDocumentById | GET /app-api/v1/data/colls/{coll}/docs/{id} | Gets a document from database |
DataApi | getDocuments | GET /app-api/v1/data/colls/{coll}/docs | Gets documents from database |
DataApi | updateDocumentById | PUT /app-api/v1/data/colls/{coll}/docs/{id} | Updates a document in database |
DataApi | updateManyDocuments | POST /app-api/v1/data/colls/{coll}/updateMany | Updates many documents in database |
Models
- FindDocumentsRequest
- UpdateManyDocumentsRequest
Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
Tests
To run the tests, use:
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
0.0.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen
All versions of internal-api-client with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0