gopadjs 2.8.0 → 2.9.0

package/docs/Notification.md

@@ -0,0 +1,25 @@
+# Notification
+
+Generic response for errors and validations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **number** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**errors** | [**Array<Validation>**](Validation.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Notification } from 'gopadjs';
+
+const instance: Notification = {
+    status,
+    message,
+    errors,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PermitGroupUserRequest.md

@@ -0,0 +1,22 @@
+# PermitGroupUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **string** |  | [default to undefined]
+**perm** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermitGroupUserRequest } from 'gopadjs';
+
+const instance: PermitGroupUserRequest = {
+    user,
+    perm,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PermitUserGroupRequest.md

@@ -0,0 +1,22 @@
+# PermitUserGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **string** |  | [default to undefined]
+**perm** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermitUserGroupRequest } from 'gopadjs';
+
+const instance: PermitUserGroupRequest = {
+    group,
+    perm,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Profile.md

@@ -0,0 +1,43 @@
+# Profile
+
+Model to represent profile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**fullname** | **string** |  | [optional] [default to undefined]
+**profile** | **string** |  | [optional] [default to undefined]
+**admin** | **boolean** |  | [optional] [readonly] [default to undefined]
+**active** | **boolean** |  | [optional] [readonly] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+**auths** | [**Array<UserAuth>**](UserAuth.md) |  | [optional] [readonly] [default to undefined]
+**groups** | [**Array<UserGroup>**](UserGroup.md) |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Profile } from 'gopadjs';
+
+const instance: Profile = {
+    id,
+    username,
+    password,
+    email,
+    fullname,
+    profile,
+    admin,
+    active,
+    created_at,
+    updated_at,
+    auths,
+    groups,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProfileApi.md

@@ -0,0 +1,155 @@
+# ProfileApi
+
+All URIs are relative to *https://try.gopad.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**showProfile**](#showprofile) | **GET** /profile/self | Fetch profile details of the personal account|
+|[**tokenProfile**](#tokenprofile) | **GET** /profile/token | Retrieve an unlimited auth token|
+|[**updateProfile**](#updateprofile) | **PUT** /profile/self | Update your own profile information|
+
+# **showProfile**
+> Profile showProfile()
+
+
+### Example
+
+```typescript
+import {
+    ProfileApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new ProfileApi(configuration);
+
+const { status, data } = await apiInstance.showProfile();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Profile**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The current profile details |  -  |
+|**403** | User is not authorized |  -  |
+|**500** | Some internal server 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)
+
+# **tokenProfile**
+> AuthToken tokenProfile()
+
+
+### Example
+
+```typescript
+import {
+    ProfileApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new ProfileApi(configuration);
+
+const { status, data } = await apiInstance.tokenProfile();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuthToken**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Generated token never expiring |  -  |
+|**403** | User is not authorized |  -  |
+|**500** | Some internal server 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)
+
+# **updateProfile**
+> Profile updateProfile(updateProfileRequest)
+
+
+### Example
+
+```typescript
+import {
+    ProfileApi,
+    Configuration,
+    UpdateProfileRequest
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new ProfileApi(configuration);
+
+let updateProfileRequest: UpdateProfileRequest; //The profile data to update
+
+const { status, data } = await apiInstance.updateProfile(
+    updateProfileRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateProfileRequest** | **UpdateProfileRequest**| The profile data to update | |
+
+
+### Return type
+
+**Profile**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The current profile details |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server 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)
+

package/docs/Provider.md

@@ -0,0 +1,27 @@
+# Provider
+
+Model to represent auth provider
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [readonly] [default to undefined]
+**driver** | **string** |  | [optional] [readonly] [default to undefined]
+**display** | **string** |  | [optional] [readonly] [default to undefined]
+**icon** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Provider } from 'gopadjs';
+
+const instance: Provider = {
+    name,
+    driver,
+    display,
+    icon,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RedirectAuthRequest.md

@@ -0,0 +1,20 @@
+# RedirectAuthRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RedirectAuthRequest } from 'gopadjs';
+
+const instance: RedirectAuthRequest = {
+    token,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProfileRequest.md

@@ -0,0 +1,26 @@
+# UpdateProfileRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**fullname** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProfileRequest } from 'gopadjs';
+
+const instance: UpdateProfileRequest = {
+    username,
+    password,
+    email,
+    fullname,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateUserRequest.md

@@ -0,0 +1,30 @@
+# UpdateUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**fullname** | **string** |  | [optional] [default to undefined]
+**admin** | **boolean** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateUserRequest } from 'gopadjs';
+
+const instance: UpdateUserRequest = {
+    username,
+    password,
+    email,
+    fullname,
+    admin,
+    active,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/User.md

@@ -0,0 +1,41 @@
+# User
+
+Model to represent user
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**fullname** | **string** |  | [optional] [default to undefined]
+**profile** | **string** |  | [optional] [default to undefined]
+**admin** | **boolean** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+**auths** | [**Array<UserAuth>**](UserAuth.md) |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { User } from 'gopadjs';
+
+const instance: User = {
+    id,
+    username,
+    password,
+    email,
+    fullname,
+    profile,
+    admin,
+    active,
+    created_at,
+    updated_at,
+    auths,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)