@space-cow-media/spellbook-client 4.8.13 → 4.8.15

package/spellbook-client/docs/TokenApi.md

@@ -0,0 +1,212 @@
+# TokenApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**tokenCreate**](TokenApi.md#tokencreate) | **POST** /token/ |  |
+| [**tokenRefreshCreate**](TokenApi.md#tokenrefreshcreate) | **POST** /token/refresh/ |  |
+| [**tokenVerifyCreate**](TokenApi.md#tokenverifycreate) | **POST** /token/verify/ |  |
+
+
+
+## tokenCreate
+
+> TokenObtainPair tokenCreate(tokenObtainPairRequest)
+
+
+
+Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokenApi,
+} from '';
+import type { TokenCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new TokenApi();
+
+  const body = {
+    // TokenObtainPairRequest (optional)
+    tokenObtainPairRequest: ...,
+  } satisfies TokenCreateRequest;
+
+  try {
+    const data = await api.tokenCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenObtainPairRequest** | [TokenObtainPairRequest](TokenObtainPairRequest.md) |  | [Optional] |
+
+### Return type
+
+[**TokenObtainPair**](TokenObtainPair.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## tokenRefreshCreate
+
+> TokenRefresh tokenRefreshCreate(tokenRefreshRequest)
+
+
+
+Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokenApi,
+} from '';
+import type { TokenRefreshCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new TokenApi();
+
+  const body = {
+    // TokenRefreshRequest
+    tokenRefreshRequest: ...,
+  } satisfies TokenRefreshCreateRequest;
+
+  try {
+    const data = await api.tokenRefreshCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenRefreshRequest** | [TokenRefreshRequest](TokenRefreshRequest.md) |  | |
+
+### Return type
+
+[**TokenRefresh**](TokenRefresh.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## tokenVerifyCreate
+
+> tokenVerifyCreate(tokenVerifyRequest)
+
+
+
+Takes a token and indicates if it is valid.  This view provides no information about a token\'s fitness for a particular use.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokenApi,
+} from '';
+import type { TokenVerifyCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new TokenApi();
+
+  const body = {
+    // TokenVerifyRequest
+    tokenVerifyRequest: ...,
+  } satisfies TokenVerifyCreateRequest;
+
+  try {
+    const data = await api.tokenVerifyCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenVerifyRequest** | [TokenVerifyRequest](TokenVerifyRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/x-www-form-urlencoded`, `multipart/form-data`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | No response body |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/spellbook-client/docs/TokenObtainPair.md

@@ -0,0 +1,36 @@
+
+# TokenObtainPair
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`refresh` | string
+`access` | string
+
+## Example
+
+```typescript
+import type { TokenObtainPair } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "refresh": null,
+  "access": null,
+} satisfies TokenObtainPair
+
+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 TokenObtainPair
+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/spellbook-client/docs/TokenObtainPairRequest.md

@@ -0,0 +1,38 @@
+
+# TokenObtainPairRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`password` | string
+`code` | string
+
+## Example
+
+```typescript
+import type { TokenObtainPairRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "password": null,
+  "code": null,
+} satisfies TokenObtainPairRequest
+
+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 TokenObtainPairRequest
+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/spellbook-client/docs/TokenRefresh.md

@@ -0,0 +1,34 @@
+
+# TokenRefresh
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`access` | string
+
+## Example
+
+```typescript
+import type { TokenRefresh } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "access": null,
+} satisfies TokenRefresh
+
+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 TokenRefresh
+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/spellbook-client/docs/TokenRefreshRequest.md

@@ -0,0 +1,34 @@
+
+# TokenRefreshRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`refresh` | string
+
+## Example
+
+```typescript
+import type { TokenRefreshRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "refresh": null,
+} satisfies TokenRefreshRequest
+
+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 TokenRefreshRequest
+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/spellbook-client/docs/TokenVerifyRequest.md

@@ -0,0 +1,34 @@
+
+# TokenVerifyRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`token` | string
+
+## Example
+
+```typescript
+import type { TokenVerifyRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "token": null,
+} satisfies TokenVerifyRequest
+
+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 TokenVerifyRequest
+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/spellbook-client/docs/User.md

@@ -0,0 +1,36 @@
+
+# User
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`username` | string
+
+## Example
+
+```typescript
+import type { User } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "username": null,
+} 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/spellbook-client/docs/UserDetail.md

@@ -0,0 +1,46 @@
+
+# UserDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`username` | string
+`email` | string
+`isStaff` | boolean
+`isActive` | boolean
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { UserDetail } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "username": null,
+  "email": null,
+  "isStaff": null,
+  "isActive": null,
+  "firstName": null,
+  "lastName": null,
+} satisfies UserDetail
+
+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 UserDetail
+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/spellbook-client/docs/UserDetailRequest.md

@@ -0,0 +1,38 @@
+
+# UserDetailRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`password` | string
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { UserDetailRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "password": null,
+  "firstName": null,
+  "lastName": null,
+} satisfies UserDetailRequest
+
+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 UserDetailRequest
+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/spellbook-client/docs/UserRequest.md

@@ -0,0 +1,34 @@
+
+# UserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+
+## Example
+
+```typescript
+import type { UserRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+} satisfies UserRequest
+
+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 UserRequest
+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)
+
+