{"id":21451166,"url":"https://github.com/lenra-io/internal-api-client-lib-php","last_synced_at":"2025-03-17T02:41:17.418Z","repository":{"id":207787032,"uuid":"717699069","full_name":"lenra-io/internal-api-client-lib-php","owner":"lenra-io","description":"The PHP Lenra's app internal API client","archived":false,"fork":false,"pushed_at":"2023-11-29T13:45:04.000Z","size":1370,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-25T05:34:54.585Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lenra-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["lenra-io"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-11-12T09:50:18.000Z","updated_at":"2023-11-13T14:21:35.000Z","dependencies_parsed_at":"2023-11-17T16:39:47.355Z","dependency_job_id":"19d14c5f-432d-4785-abf9-6c2f2e4f69a6","html_url":"https://github.com/lenra-io/internal-api-client-lib-php","commit_stats":null,"previous_names":["lenra-io/internal-api-client-lib-php"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lenra-io","download_url":"https://codeload.github.com/lenra-io/internal-api-client-lib-php/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243963789,"owners_count":20375677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T04:18:28.769Z","updated_at":"2025-03-17T02:41:17.399Z","avatar_url":"https://github.com/lenra-io.png","language":"PHP","readme":"# OpenAPIClient-php\n\nThe API usable by the Lenra applications\n\nFor more information, please visit [https://www.lenra.io/contact.html](https://www.lenra.io/contact.html).\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.4 and later.\nShould also work with PHP 8.0.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/GIT_USER_ID/GIT_REPO_ID.git\"\n    }\n  ],\n  \"require\": {\n    \"GIT_USER_ID/GIT_REPO_ID\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/OpenAPIClient-php/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n// Configure Bearer authorization: bearerAuth\n$config = OpenAPI\\Client\\Configuration::getDefaultConfiguration()-\u003esetAccessToken('YOUR_ACCESS_TOKEN');\n\n\n$apiInstance = new OpenAPI\\Client\\Api\\DataApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n\ntry {\n    $apiInstance-\u003eabortTransaction();\n} catch (Exception $e) {\n    echo 'Exception when calling DataApi-\u003eabortTransaction: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n```\n\n## API Endpoints\n\nAll URIs are relative to *http://localhost:4001*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DataApi* | [**abortTransaction**](docs/Api/DataApi.md#aborttransaction) | **POST** /app-api/v1/data/transaction/abort | Aborts a transaction\n*DataApi* | [**commitTransaction**](docs/Api/DataApi.md#committransaction) | **POST** /app-api/v1/data/transaction/commit | Commits a transaction\n*DataApi* | [**createDocument**](docs/Api/DataApi.md#createdocument) | **POST** /app-api/v1/data/colls/{coll}/docs | Creates a document in database\n*DataApi* | [**createTransaction**](docs/Api/DataApi.md#createtransaction) | **POST** /app-api/v1/data/transaction | Creates a transaction\n*DataApi* | [**deleteCollection**](docs/Api/DataApi.md#deletecollection) | **DELETE** /app-api/v1-api/v1/data/colls/{coll} | Deletes a collection from database\n*DataApi* | [**deleteDocumentById**](docs/Api/DataApi.md#deletedocumentbyid) | **DELETE** /app-api/v1/data/colls/{coll}/docs/{id} | Deletes a document from database\n*DataApi* | [**findDocuments**](docs/Api/DataApi.md#finddocuments) | **POST** /app-api/v1/data/colls/{coll}/find | Finds documents in database\n*DataApi* | [**getDocumentById**](docs/Api/DataApi.md#getdocumentbyid) | **GET** /app-api/v1/data/colls/{coll}/docs/{id} | Gets a document from database\n*DataApi* | [**getDocuments**](docs/Api/DataApi.md#getdocuments) | **GET** /app-api/v1/data/colls/{coll}/docs | Gets documents from database\n*DataApi* | [**updateDocumentById**](docs/Api/DataApi.md#updatedocumentbyid) | **PUT** /app-api/v1/data/colls/{coll}/docs/{id} | Updates a document in database\n*DataApi* | [**updateManyDocuments**](docs/Api/DataApi.md#updatemanydocuments) | **POST** /app-api/v1/data/colls/{coll}/updateMany | Updates many documents in database\n\n## Models\n\n- [FindDocumentsRequest](docs/Model/FindDocumentsRequest.md)\n- [UpdateManyDocumentsRequest](docs/Model/UpdateManyDocumentsRequest.md)\n\n## Authorization\n\nAuthentication schemes defined for the API:\n### bearerAuth\n\n- **Type**: Bearer authentication\n\n## Tests\n\nTo run the tests, use:\n\n```bash\ncomposer install\nvendor/bin/phpunit\n```\n\n## Author\n\n\n\n## About this package\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: `0.0.0`\n- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`\n","funding_links":["https://github.com/sponsors/lenra-io"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flenra-io%2Finternal-api-client-lib-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flenra-io%2Finternal-api-client-lib-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flenra-io%2Finternal-api-client-lib-php/lists"}