aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_jb/docs/AuthApi.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_jb/docs/AuthApi.md')
-rw-r--r--jb-ui/src/api_jb/docs/AuthApi.md368
1 files changed, 368 insertions, 0 deletions
diff --git a/jb-ui/src/api_jb/docs/AuthApi.md b/jb-ui/src/api_jb/docs/AuthApi.md
new file mode 100644
index 0000000..c483415
--- /dev/null
+++ b/jb-ui/src/api_jb/docs/AuthApi.md
@@ -0,0 +1,368 @@
+# AuthApi
+
+All URIs are relative to *https://jamesbillings67.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteSessionAuthSessionDelete**](#deletesessionauthsessiondelete) | **DELETE** /auth/session/ | Delete Session|
+|[**exchangeAmtAccountLinkAuthLinkAmtExchangePost**](#exchangeamtaccountlinkauthlinkamtexchangepost) | **POST** /auth/link-amt/exchange/ | Exchange Amt Account Link|
+|[**exchangeMagicLinkAuthMagicLinkExchangePost**](#exchangemagiclinkauthmagiclinkexchangepost) | **POST** /auth/magic-link/exchange/ | Exchange Magic Link|
+|[**getSessionAuthSessionGet**](#getsessionauthsessionget) | **GET** /auth/session/ | Get Session|
+|[**inviteAmtAccountLinkAuthLinkAmtInvitePost**](#inviteamtaccountlinkauthlinkamtinvitepost) | **POST** /auth/link-amt/invite/ | Invite Amt Account Link|
+|[**linkAmtAccountAuthLinkAmtRequestPost**](#linkamtaccountauthlinkamtrequestpost) | **POST** /auth/link-amt/request/ | Link Amt Account|
+|[**requestMagicLinkAuthMagicLinkRequestPost**](#requestmagiclinkauthmagiclinkrequestpost) | **POST** /auth/magic-link/request/ | Request Magic Link|
+
+# **deleteSessionAuthSessionDelete**
+> deleteSessionAuthSessionDelete()
+
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+const { status, data } = await apiInstance.deleteSessionAuthSessionDelete();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **exchangeAmtAccountLinkAuthLinkAmtExchangePost**
+> exchangeAmtAccountLinkAuthLinkAmtExchangePost(magicLinkExchangeRequest)
+
+Validate the email link, then transition the bound AMT account.
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration,
+ MagicLinkExchangeRequest
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let magicLinkExchangeRequest: MagicLinkExchangeRequest; //
+
+const { status, data } = await apiInstance.exchangeAmtAccountLinkAuthLinkAmtExchangePost(
+ magicLinkExchangeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **magicLinkExchangeRequest** | **MagicLinkExchangeRequest**| | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response | - |
+|**422** | Validation Error | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **exchangeMagicLinkAuthMagicLinkExchangePost**
+> exchangeMagicLinkAuthMagicLinkExchangePost(magicLinkExchangeRequest)
+
+Exchange a magic link only after its landing page makes an explicit POST.
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration,
+ MagicLinkExchangeRequest
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let magicLinkExchangeRequest: MagicLinkExchangeRequest; //
+
+const { status, data } = await apiInstance.exchangeMagicLinkAuthMagicLinkExchangePost(
+ magicLinkExchangeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **magicLinkExchangeRequest** | **MagicLinkExchangeRequest**| | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response | - |
+|**422** | Validation Error | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSessionAuthSessionGet**
+> User getSessionAuthSessionGet()
+
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+const { status, data } = await apiInstance.getSessionAuthSessionGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**User**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **inviteAmtAccountLinkAuthLinkAmtInvitePost**
+> { [key: string]: string | null; } inviteAmtAccountLinkAuthLinkAmtInvitePost(amtAccountLink)
+
+Create a long-lived AMT account-link URL without sending an email.
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration,
+ AmtAccountLink
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let amtAccountLink: AmtAccountLink; //
+let authorization: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.inviteAmtAccountLinkAuthLinkAmtInvitePost(
+ amtAccountLink,
+ authorization
+);
+```
+
+### Parameters
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **amtAccountLink** | **AmtAccountLink**| | |
+| **authorization** | [**string**] | | (optional) defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: string | null; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response | - |
+|**422** | Validation Error | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **linkAmtAccountAuthLinkAmtRequestPost**
+> { [key: string]: string | null; } linkAmtAccountAuthLinkAmtRequestPost(amtAccountLink)
+
+Link an AMT account and login.
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration,
+ AmtAccountLink
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let amtAccountLink: AmtAccountLink; //
+
+const { status, data } = await apiInstance.linkAmtAccountAuthLinkAmtRequestPost(
+ amtAccountLink
+);
+```
+
+### Parameters
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **amtAccountLink** | **AmtAccountLink**| | |
+
+
+### Return type
+
+**{ [key: string]: string | null; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response | - |
+|**422** | Validation Error | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **requestMagicLinkAuthMagicLinkRequestPost**
+> { [key: string]: string | null; } requestMagicLinkAuthMagicLinkRequestPost(accountLogin)
+
+Create a magic link.
+
+### Example
+
+```typescript
+import {
+ AuthApi,
+ Configuration,
+ AccountLogin
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let accountLogin: AccountLogin; //
+
+const { status, data } = await apiInstance.requestMagicLinkAuthMagicLinkRequestPost(
+ accountLogin
+);
+```
+
+### Parameters
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **accountLogin** | **AccountLogin**| | |
+
+
+### Return type
+
+**{ [key: string]: string | null; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response | - |
+|**422** | Validation Error | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+