bmlt-server-client 2.0.0 → 2.0.1

package/docs/Token.md

@@ -0,0 +1,40 @@
+
+# Token
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessToken` | string
+`expiresAt` | number
+`tokenType` | string
+`userId` | number
+
+## Example
+
+```typescript
+import type { Token } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessToken": 2|tR6PIqa8tiBJWMu4zyb3qw4eECuERjLd7xeLKgBu,
+  "expiresAt": 1667342171,
+  "tokenType": bearer,
+  "userId": 1,
+} satisfies Token
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Token
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TokenCredentials.md

@@ -0,0 +1,36 @@
+
+# TokenCredentials
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { TokenCredentials } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": MyUsername,
+  "password": PassWord12345,
+} satisfies TokenCredentials
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TokenCredentials
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/User.md

@@ -0,0 +1,48 @@
+
+# User
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`type` | string
+`displayName` | string
+`description` | string
+`email` | string
+`ownerId` | number
+`id` | number
+`lastLoginAt` | Date
+
+## Example
+
+```typescript
+import type { User } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": string,
+  "type": string,
+  "displayName": string,
+  "description": string,
+  "email": string,
+  "ownerId": 0,
+  "id": 0,
+  "lastLoginAt": 2019-05-02T05:05Z,
+} satisfies User
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as User
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UserBase.md

@@ -0,0 +1,44 @@
+
+# UserBase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`type` | string
+`displayName` | string
+`description` | string
+`email` | string
+`ownerId` | number
+
+## Example
+
+```typescript
+import type { UserBase } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": string,
+  "type": string,
+  "displayName": string,
+  "description": string,
+  "email": string,
+  "ownerId": 0,
+} satisfies UserBase
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UserBase
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UserCreate.md

@@ -0,0 +1,46 @@
+
+# UserCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`type` | string
+`displayName` | string
+`description` | string
+`email` | string
+`ownerId` | number
+`password` | string
+
+## Example
+
+```typescript
+import type { UserCreate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": string,
+  "type": string,
+  "displayName": string,
+  "description": string,
+  "email": string,
+  "ownerId": 0,
+  "password": string,
+} satisfies UserCreate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UserCreate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UserPartialUpdate.md

@@ -0,0 +1,46 @@
+
+# UserPartialUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`type` | string
+`displayName` | string
+`description` | string
+`email` | string
+`ownerId` | number
+`password` | string
+
+## Example
+
+```typescript
+import type { UserPartialUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": string,
+  "type": string,
+  "displayName": string,
+  "description": string,
+  "email": string,
+  "ownerId": 0,
+  "password": string,
+} satisfies UserPartialUpdate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UserPartialUpdate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UserUpdate.md

@@ -0,0 +1,46 @@
+
+# UserUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`type` | string
+`displayName` | string
+`description` | string
+`email` | string
+`ownerId` | number
+`password` | string
+
+## Example
+
+```typescript
+import type { UserUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": string,
+  "type": string,
+  "displayName": string,
+  "description": string,
+  "email": string,
+  "ownerId": 0,
+  "password": string,
+} satisfies UserUpdate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UserUpdate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ValidationError.md

@@ -0,0 +1,36 @@
+
+# ValidationError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`errors` | { [key: string]: Array<string>; }
+
+## Example
+
+```typescript
+import type { ValidationError } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": The field is required. (and 1 more error),
+  "errors": null,
+} satisfies ValidationError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ValidationError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+