@digital8/laravel-auth-template-ts-sdk 0.0.7 → 0.0.8

package/docs/GeneralApi.md

@@ -0,0 +1,597 @@
+# GeneralApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyUser**](GeneralApi.md#destroyuser) | **POST** /api/users/{user}/delete | Auto-generated: destroyUser |
+| [**indexUser**](GeneralApi.md#indexuseroperation) | **POST** /api/users/search | Auto-generated: indexUser |
+| [**loginAuth**](GeneralApi.md#loginauthoperation) | **POST** /api/auth/login | Auto-generated: loginAuth |
+| [**logoutAuth**](GeneralApi.md#logoutauth) | **POST** /api/auth/logout | Auto-generated: logoutAuth |
+| [**resetPasswordAuth**](GeneralApi.md#resetpasswordauthoperation) | **POST** /api/auth/reset-password | Auto-generated: resetPasswordAuth |
+| [**sendForgotPasswordLinkAuth**](GeneralApi.md#sendforgotpasswordlinkauthoperation) | **POST** /api/auth/forgot-password | Auto-generated: sendForgotPasswordLinkAuth |
+| [**storeAssetFile**](GeneralApi.md#storeassetfileoperation) | **POST** /api/assets/file | Auto-generated: storeAssetFile |
+| [**storeUser**](GeneralApi.md#storeuseroperation) | **POST** /api/auth/register | Auto-generated: storeUser |
+| [**updateUser**](GeneralApi.md#updateuseroperation) | **POST** /api/users/{user}/update | Auto-generated: updateUser |
+
+
+
+## destroyUser
+
+> GenericResponse destroyUser(user)
+
+Auto-generated: destroyUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { DestroyUserRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // number | The id of the user
+    user: 56,
+  } satisfies DestroyUserRequest;
+
+  try {
+    const data = await api.destroyUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **user** | `number` | The id of the user | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## indexUser
+
+> PaginatedUserResourceResponse indexUser(indexUserRequest)
+
+Auto-generated: indexUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { IndexUserOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // IndexUserRequest (optional)
+    indexUserRequest: ...,
+  } satisfies IndexUserOperationRequest;
+
+  try {
+    const data = await api.indexUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexUserRequest** | [IndexUserRequest](IndexUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedUserResourceResponse**](PaginatedUserResourceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\UserResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## loginAuth
+
+> UserAuthTokenResource loginAuth(loginAuthRequest)
+
+Auto-generated: loginAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { LoginAuthOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // LoginAuthRequest (optional)
+    loginAuthRequest: ...,
+  } satisfies LoginAuthOperationRequest;
+
+  try {
+    const data = await api.loginAuth(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **loginAuthRequest** | [LoginAuthRequest](LoginAuthRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UserAuthTokenResource**](UserAuthTokenResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## logoutAuth
+
+> GenericResponse logoutAuth()
+
+Auto-generated: logoutAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { LogoutAuthRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  try {
+    const data = await api.logoutAuth();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## resetPasswordAuth
+
+> GenericResponse resetPasswordAuth(resetPasswordAuthRequest)
+
+Auto-generated: resetPasswordAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { ResetPasswordAuthOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // ResetPasswordAuthRequest (optional)
+    resetPasswordAuthRequest: ...,
+  } satisfies ResetPasswordAuthOperationRequest;
+
+  try {
+    const data = await api.resetPasswordAuth(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resetPasswordAuthRequest** | [ResetPasswordAuthRequest](ResetPasswordAuthRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## sendForgotPasswordLinkAuth
+
+> GenericResponse sendForgotPasswordLinkAuth(sendForgotPasswordLinkAuthRequest)
+
+Auto-generated: sendForgotPasswordLinkAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { SendForgotPasswordLinkAuthOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // SendForgotPasswordLinkAuthRequest (optional)
+    sendForgotPasswordLinkAuthRequest: ...,
+  } satisfies SendForgotPasswordLinkAuthOperationRequest;
+
+  try {
+    const data = await api.sendForgotPasswordLinkAuth(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sendForgotPasswordLinkAuthRequest** | [SendForgotPasswordLinkAuthRequest](SendForgotPasswordLinkAuthRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## storeAssetFile
+
+> AssetFileForUploadResource storeAssetFile(storeAssetFileRequest)
+
+Auto-generated: storeAssetFile
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { StoreAssetFileOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // StoreAssetFileRequest (optional)
+    storeAssetFileRequest: ...,
+  } satisfies StoreAssetFileOperationRequest;
+
+  try {
+    const data = await api.storeAssetFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeAssetFileRequest** | [StoreAssetFileRequest](StoreAssetFileRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AssetFileForUploadResource**](AssetFileForUploadResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## storeUser
+
+> UserResource storeUser(storeUserRequest)
+
+Auto-generated: storeUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { StoreUserOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // StoreUserRequest (optional)
+    storeUserRequest: ...,
+  } satisfies StoreUserOperationRequest;
+
+  try {
+    const data = await api.storeUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeUserRequest** | [StoreUserRequest](StoreUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UserResource**](UserResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateUser
+
+> UserResource updateUser(user, updateUserRequest)
+
+Auto-generated: updateUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeneralApi,
+} from '@digital8/laravel-auth-template-ts-sdk';
+import type { UpdateUserOperationRequest } from '@digital8/laravel-auth-template-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
+  const api = new GeneralApi();
+
+  const body = {
+    // number | The id of the user
+    user: 56,
+    // UpdateUserRequest (optional)
+    updateUserRequest: ...,
+  } satisfies UpdateUserOperationRequest;
+
+  try {
+    const data = await api.updateUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **user** | `number` | The id of the user | [Defaults to `undefined`] |
+| **updateUserRequest** | [UpdateUserRequest](UpdateUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**UserResource**](UserResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[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/GenericResponse.md

@@ -0,0 +1,34 @@
+
+# GenericResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { GenericResponse } from '@digital8/laravel-auth-template-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies GenericResponse
+
+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 GenericResponse
+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/IndexUserRequest.md

@@ -0,0 +1,42 @@
+
+# IndexUserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+
+## Example
+
+```typescript
+import type { IndexUserRequest } from '@digital8/laravel-auth-template-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "perPage": null,
+  "page": null,
+} satisfies IndexUserRequest
+
+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 IndexUserRequest
+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/LoginAuthRequest.md

@@ -0,0 +1,36 @@
+
+# LoginAuthRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { LoginAuthRequest } from '@digital8/laravel-auth-template-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "password": null,
+} satisfies LoginAuthRequest
+
+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 LoginAuthRequest
+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)
+
+