bmlt-server-client 1.3.3 → 1.3.5

package/.github/workflows/release.yml

@@ -5,15 +5,15 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Setup Node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
-          node-version: '18.x'
+          node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies and build 🔧

package/.openapi-generator/FILES

@@ -1,6 +1,43 @@
 .gitignore
 .npmignore
 README.md
+docs/AuthenticationError.md
+docs/AuthorizationError.md
+docs/ConflictError.md
+docs/ErrorTest.md
+docs/Format.md
+docs/FormatBase.md
+docs/FormatCreate.md
+docs/FormatPartialUpdate.md
+docs/FormatTranslation.md
+docs/FormatUpdate.md
+docs/Meeting.md
+docs/MeetingBase.md
+docs/MeetingChangeResource.md
+docs/MeetingCreate.md
+docs/MeetingPartialUpdate.md
+docs/MeetingUpdate.md
+docs/NotFoundError.md
+docs/RootServer.md
+docs/RootServerApi.md
+docs/RootServerBase.md
+docs/RootServerBaseStatistics.md
+docs/RootServerBaseStatisticsMeetings.md
+docs/RootServerBaseStatisticsServiceBodies.md
+docs/ServerError.md
+docs/ServiceBody.md
+docs/ServiceBodyBase.md
+docs/ServiceBodyCreate.md
+docs/ServiceBodyPartialUpdate.md
+docs/ServiceBodyUpdate.md
+docs/Token.md
+docs/TokenCredentials.md
+docs/User.md
+docs/UserBase.md
+docs/UserCreate.md
+docs/UserPartialUpdate.md
+docs/UserUpdate.md
+docs/ValidationError.md
 package.json
 src/apis/RootServerApi.ts
 src/apis/index.ts
@@ -43,4 +80,5 @@ src/models/UserUpdate.ts
 src/models/ValidationError.ts
 src/models/index.ts
 src/runtime.ts
+tsconfig.esm.json
 tsconfig.json

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.14.0-SNAPSHOT
+7.18.0-SNAPSHOT

package/Makefile

@@ -9,6 +9,7 @@ generate: openapi.json
 	    -g typescript-fetch \
 	    -p npmName=bmlt-server-client \
 	    -p npmVersion=latest \
+	    -p supportsES6=true \
 	    --git-repo-id=bmlt-server-typescript-client \
 	    --git-user-id=bmlt-enabled \
 	    -o .

package/README.md

@@ -1,46 +1,185 @@
-## bmlt-server-client@latest
+# bmlt-server-client@latest
 
-This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+A TypeScript SDK client for the localhost API.
 
-Environment
-* Node.js
-* Webpack
-* Browserify
+## Usage
 
-Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
+First, install the SDK from npm.
 
-Module system
-* CommonJS
-* ES6 module system
+```bash
+npm install bmlt-server-client --save
+```
 
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+Next, try it out.
 
-### Building
 
-To build and compile the typescript sources to javascript use:
-```
-npm install
-npm run build
+```ts
+import {
+  Configuration,
+  RootServerApi,
+} from 'bmlt-server-client';
+import type { AuthLogoutRequest } from 'bmlt-server-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: bmltToken password
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RootServerApi(config);
+
+  try {
+    const data = await api.authLogout();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
 ```
 
-### Publishing
 
-First build the package then run `npm publish`
+## Documentation
 
-### Consuming
+### API Endpoints
 
-navigate to the folder of your consuming project and run one of the following commands.
+All URIs are relative to *http://localhost:8000/main_server*
 
-_published:_
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*RootServerApi* | [**authLogout**](docs/RootServerApi.md#authlogout) | **POST** /api/v1/auth/logout | Revokes a token
+*RootServerApi* | [**authRefresh**](docs/RootServerApi.md#authrefresh) | **POST** /api/v1/auth/refresh | Revokes and issues a new token
+*RootServerApi* | [**authToken**](docs/RootServerApi.md#authtoken) | **POST** /api/v1/auth/token | Creates a token
+*RootServerApi* | [**createErrorTest**](docs/RootServerApi.md#createerrortest) | **POST** /api/v1/errortest | Tests some errors
+*RootServerApi* | [**createFormat**](docs/RootServerApi.md#createformat) | **POST** /api/v1/formats | Creates a format
+*RootServerApi* | [**createMeeting**](docs/RootServerApi.md#createmeeting) | **POST** /api/v1/meetings | Creates a meeting
+*RootServerApi* | [**createServiceBody**](docs/RootServerApi.md#createservicebody) | **POST** /api/v1/servicebodies | Creates a service body
+*RootServerApi* | [**createUser**](docs/RootServerApi.md#createuser) | **POST** /api/v1/users | Creates a user
+*RootServerApi* | [**deleteFormat**](docs/RootServerApi.md#deleteformat) | **DELETE** /api/v1/formats/{formatId} | Deletes a format
+*RootServerApi* | [**deleteMeeting**](docs/RootServerApi.md#deletemeeting) | **DELETE** /api/v1/meetings/{meetingId} | Deletes a meeting
+*RootServerApi* | [**deleteServiceBody**](docs/RootServerApi.md#deleteservicebody) | **DELETE** /api/v1/servicebodies/{serviceBodyId} | Deletes a service body
+*RootServerApi* | [**deleteUser**](docs/RootServerApi.md#deleteuser) | **DELETE** /api/v1/users/{userId} | Deletes a user
+*RootServerApi* | [**getFormat**](docs/RootServerApi.md#getformat) | **GET** /api/v1/formats/{formatId} | Retrieves a format
+*RootServerApi* | [**getFormats**](docs/RootServerApi.md#getformats) | **GET** /api/v1/formats | Retrieves formats
+*RootServerApi* | [**getLaravelLog**](docs/RootServerApi.md#getlaravellog) | **GET** /api/v1/logs/laravel | Retrieves laravel log
+*RootServerApi* | [**getMeeting**](docs/RootServerApi.md#getmeeting) | **GET** /api/v1/meetings/{meetingId} | Retrieves a meeting
+*RootServerApi* | [**getMeetingChanges**](docs/RootServerApi.md#getmeetingchanges) | **GET** /api/v1/meetings/{meetingId}/changes | Retrieve changes for a meeting
+*RootServerApi* | [**getMeetings**](docs/RootServerApi.md#getmeetings) | **GET** /api/v1/meetings | Retrieves meetings
+*RootServerApi* | [**getRootServer**](docs/RootServerApi.md#getrootserver) | **GET** /api/v1/rootservers/{rootServerId} | Retrieves a root server
+*RootServerApi* | [**getRootServers**](docs/RootServerApi.md#getrootservers) | **GET** /api/v1/rootservers | Retrieves root servers
+*RootServerApi* | [**getServiceBodies**](docs/RootServerApi.md#getservicebodies) | **GET** /api/v1/servicebodies | Retrieves service bodies
+*RootServerApi* | [**getServiceBody**](docs/RootServerApi.md#getservicebody) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body
+*RootServerApi* | [**getUser**](docs/RootServerApi.md#getuser) | **GET** /api/v1/users/{userId} | Retrieves a single user
+*RootServerApi* | [**getUsers**](docs/RootServerApi.md#getusers) | **GET** /api/v1/users | Retrieves users
+*RootServerApi* | [**partialUpdateUser**](docs/RootServerApi.md#partialupdateuser) | **PATCH** /api/v1/users/{userId} | Patches a user
+*RootServerApi* | [**patchFormat**](docs/RootServerApi.md#patchformat) | **PATCH** /api/v1/formats/{formatId} | Patches a format
+*RootServerApi* | [**patchMeeting**](docs/RootServerApi.md#patchmeeting) | **PATCH** /api/v1/meetings/{meetingId} | Patches a meeting
+*RootServerApi* | [**patchServiceBody**](docs/RootServerApi.md#patchservicebody) | **PATCH** /api/v1/servicebodies/{serviceBodyId} | Patches a service body
+*RootServerApi* | [**updateFormat**](docs/RootServerApi.md#updateformat) | **PUT** /api/v1/formats/{formatId} | Updates a format
+*RootServerApi* | [**updateMeeting**](docs/RootServerApi.md#updatemeeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting
+*RootServerApi* | [**updateServiceBody**](docs/RootServerApi.md#updateservicebody) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body
+*RootServerApi* | [**updateUser**](docs/RootServerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update single user
 
-```
-npm install bmlt-server-client@latest --save
-```
 
-_unPublished (not recommended):_
+### Models
+
+- [AuthenticationError](docs/AuthenticationError.md)
+- [AuthorizationError](docs/AuthorizationError.md)
+- [ConflictError](docs/ConflictError.md)
+- [ErrorTest](docs/ErrorTest.md)
+- [Format](docs/Format.md)
+- [FormatBase](docs/FormatBase.md)
+- [FormatCreate](docs/FormatCreate.md)
+- [FormatPartialUpdate](docs/FormatPartialUpdate.md)
+- [FormatTranslation](docs/FormatTranslation.md)
+- [FormatUpdate](docs/FormatUpdate.md)
+- [Meeting](docs/Meeting.md)
+- [MeetingBase](docs/MeetingBase.md)
+- [MeetingChangeResource](docs/MeetingChangeResource.md)
+- [MeetingCreate](docs/MeetingCreate.md)
+- [MeetingPartialUpdate](docs/MeetingPartialUpdate.md)
+- [MeetingUpdate](docs/MeetingUpdate.md)
+- [NotFoundError](docs/NotFoundError.md)
+- [RootServer](docs/RootServer.md)
+- [RootServerBase](docs/RootServerBase.md)
+- [RootServerBaseStatistics](docs/RootServerBaseStatistics.md)
+- [RootServerBaseStatisticsMeetings](docs/RootServerBaseStatisticsMeetings.md)
+- [RootServerBaseStatisticsServiceBodies](docs/RootServerBaseStatisticsServiceBodies.md)
+- [ServerError](docs/ServerError.md)
+- [ServiceBody](docs/ServiceBody.md)
+- [ServiceBodyBase](docs/ServiceBodyBase.md)
+- [ServiceBodyCreate](docs/ServiceBodyCreate.md)
+- [ServiceBodyPartialUpdate](docs/ServiceBodyPartialUpdate.md)
+- [ServiceBodyUpdate](docs/ServiceBodyUpdate.md)
+- [Token](docs/Token.md)
+- [TokenCredentials](docs/TokenCredentials.md)
+- [User](docs/User.md)
+- [UserBase](docs/UserBase.md)
+- [UserCreate](docs/UserCreate.md)
+- [UserPartialUpdate](docs/UserPartialUpdate.md)
+- [UserUpdate](docs/UserUpdate.md)
+- [ValidationError](docs/ValidationError.md)
+
+### Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bmltToken-password"></a>
+#### bmltToken password
+
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+
+## About
 
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `1.0.0`
+- Package version: `latest`
+- Generator version: `7.18.0-SNAPSHOT`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
 ```
-npm install PATH_TO_GENERATED_PACKAGE --save
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
 ```
+
+## License
+
+[MIT](https://github.com/bmlt-enabled/bmlt-root-server/blob/main/LICENSE)