https://github.com/bmlt-enabled/bmlt-server-swift-client
Swift5 Client for BMLT Admin API
https://github.com/bmlt-enabled/bmlt-server-swift-client
Last synced: 5 days ago
JSON representation
Swift5 Client for BMLT Admin API
- Host: GitHub
- URL: https://github.com/bmlt-enabled/bmlt-server-swift-client
- Owner: bmlt-enabled
- Created: 2022-10-24T14:19:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-09T02:21:01.000Z (5 months ago)
- Last Synced: 2026-02-09T08:19:57.986Z (5 months ago)
- Language: Swift
- Size: 108 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Swift5 API client for bmlt
BMLT Admin API Documentation
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version:
- Generator version: 7.20.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.Swift5ClientCodegen
## Installation
### Carthage
Run `carthage update`
### CocoaPods
Run `pod install`
## Documentation for API Endpoints
All URIs are relative to *http://localhost:8000/main_server*
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* | [**getSettings**](docs/RootServerAPI.md#getsettings) | **GET** /api/v1/settings | Retrieves all settings
*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* | [**updateSettings**](docs/RootServerAPI.md#updatesettings) | **PATCH** /api/v1/settings | Update settings
*RootServerAPI* | [**updateUser**](docs/RootServerAPI.md#updateuser) | **PUT** /api/v1/users/{userId} | Update single user
## Documentation For 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)
- [SettingsBase](docs/SettingsBase.md)
- [SettingsObject](docs/SettingsObject.md)
- [SettingsUpdate](docs/SettingsUpdate.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)
## Documentation For Authorization
Authentication schemes defined for the API:
### bmltToken
- **Type**: OAuth
- **Flow**: password
- **Authorization URL**:
- **Scopes**: N/A
# How do I migrate from the Swift 5 generator to the swift 6 generator?
https://openapi-generator.tech/docs/faq-generators#how-do-i-migrate-from-the-swift-5-generator-to-the-swift-6-generator
### How do I implement bearer token authentication with URLSession on the Swift 5 API client?
https://openapi-generator.tech/docs/faq-generators#how-do-i-implement-bearer-token-authentication-with-urlsession-on-the-swift-5-api-client
## Author