gopadjs 2.8.0 → 2.9.0

package/.codacy.yml

@@ -3,4 +3,7 @@ exclude_paths:
   - .github/**
   - CHANGELOG.md
 
+  - api/**
+  - model/**
+
 ...

package/.github/RELEASE

@@ -1 +1 @@
-Mon Apr 21 08:13:43 UTC 2025
+Mon Apr 28 08:32:02 UTC 2025

package/.github/settings.yml

@@ -166,5 +166,8 @@ labels:
   - name: outdated
     color: cccccc
     description: This is out of scope and outdated
+  - name: openapi
+    color: 1f385c
+    description: Generated new SDK version from OpenAPI
 
 ...

package/.openapi-generator/FILES

@@ -8,6 +8,35 @@ api/user-api.ts
 base.ts
 common.ts
 configuration.ts
+docs/AuthApi.md
+docs/AuthToken.md
+docs/AuthVerify.md
+docs/CreateGroupRequest.md
+docs/CreateUserRequest.md
+docs/DeleteGroupFromUserRequest.md
+docs/DeleteUserFromGroupRequest.md
+docs/Group.md
+docs/GroupApi.md
+docs/ListGroupUsers200Response.md
+docs/ListGroups200Response.md
+docs/ListProviders200Response.md
+docs/ListUserGroups200Response.md
+docs/ListUsers200Response.md
+docs/LoginAuthRequest.md
+docs/Notification.md
+docs/PermitGroupUserRequest.md
+docs/PermitUserGroupRequest.md
+docs/Profile.md
+docs/ProfileApi.md
+docs/Provider.md
+docs/RedirectAuthRequest.md
+docs/UpdateProfileRequest.md
+docs/UpdateUserRequest.md
+docs/User.md
+docs/UserApi.md
+docs/UserAuth.md
+docs/UserGroup.md
+docs/Validation.md
 index.ts
 model/auth-token.ts
 model/auth-verify.ts

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.12.0
+7.13.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.9.0](https://github.com/gopad/gopad-js/compare/v2.8.0...v2.9.0) (2025-05-05)
+
+
+### Features
+
+* automated openapi client update ([8b0a0cf](https://github.com/gopad/gopad-js/commit/8b0a0cf82c5358cafdb8fac84c56b6d09b111b10))
+
 ## [2.8.0](https://github.com/gopad/gopad-js/compare/v2.7.0...v2.8.0) (2025-04-28)
 
 

package/README.md

@@ -6,7 +6,7 @@ This repository provides a client SDK for Typescript/Javascript. This SDK is
 automatically generated by the [OpenAPI Generator][generator] project:
 
 -   API version: 1.0.0-alpha1
--   Package version: 2.8.0
+-   Package version: 2.9.0
 -   Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen
 
 For more information, please visit [https://gopad.eu](https://gopad.eu)
@@ -39,7 +39,7 @@ the following command within your project directory, after that you can import
 it as other libraries:
 
 ```console
-npm install --save gopadjs@2.8.0
+npm install --save gopadjs@2.9.0
 ```
 
 ### Installation with Git

package/docs/AuthApi.md

@@ -0,0 +1,366 @@
+# AuthApi
+
+All URIs are relative to *https://try.gopad.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**callbackProvider**](#callbackprovider) | **GET** /auth/{provider}/callback | Callback to parse the defined provider|
+|[**listProviders**](#listproviders) | **GET** /auth/providers | Fetch the available auth providers|
+|[**loginAuth**](#loginauth) | **POST** /auth/login | Authenticate an user by credentials|
+|[**redirectAuth**](#redirectauth) | **POST** /auth/redirect | Retrieve real token after redirect|
+|[**refreshAuth**](#refreshauth) | **GET** /auth/refresh | Refresh an auth token before it expires|
+|[**requestProvider**](#requestprovider) | **GET** /auth/{provider}/request | Request the redirect to defined provider|
+|[**verifyAuth**](#verifyauth) | **GET** /auth/verify | Verify validity for an authentication token|
+
+# **callbackProvider**
+> callbackProvider()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let provider: string; //An identifier for the auth provider (default to undefined)
+let state: string; //Auth state (optional) (default to undefined)
+let code: string; //Auth code (optional) (default to undefined)
+
+const { status, data } = await apiInstance.callbackProvider(
+    provider,
+    state,
+    code
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **provider** | [**string**] | An identifier for the auth provider | defaults to undefined|
+| **state** | [**string**] | Auth state | (optional) defaults to undefined|
+| **code** | [**string**] | Auth code | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/html
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**308** | Generated expiring token |  -  |
+|**412** | Failed to initialize provider |  -  |
+|**404** | Provider not found |  -  |
+|**500** | 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)
+
+# **listProviders**
+> ListProviders200Response listProviders()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+const { status, data } = await apiInstance.listProviders();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ListProviders200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A collection of auth providers |  -  |
+
+[[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)
+
+# **loginAuth**
+> AuthToken loginAuth(loginAuthRequest)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    LoginAuthRequest
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let loginAuthRequest: LoginAuthRequest; //The credentials to authenticate
+
+const { status, data } = await apiInstance.loginAuth(
+    loginAuthRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **loginAuthRequest** | **LoginAuthRequest**| The credentials to authenticate | |
+
+
+### Return type
+
+**AuthToken**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Generated token with expire date |  -  |
+|**400** | Failed to parse request |  -  |
+|**401** | Unauthorized with wrong credentials |  -  |
+|**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)
+
+# **redirectAuth**
+> AuthToken redirectAuth(redirectAuthRequest)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    RedirectAuthRequest
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let redirectAuthRequest: RedirectAuthRequest; //The redirect token to authenticate
+
+const { status, data } = await apiInstance.redirectAuth(
+    redirectAuthRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **redirectAuthRequest** | **RedirectAuthRequest**| The redirect token to authenticate | |
+
+
+### Return type
+
+**AuthToken**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Generated token never expiring |  -  |
+|**400** | Failed to parse request |  -  |
+|**401** | Failed to generate or validate token |  -  |
+|**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)
+
+# **refreshAuth**
+> AuthToken refreshAuth()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+const { status, data } = await apiInstance.refreshAuth();
+```
+
+### 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** | Refreshed token with expire date |  -  |
+|**401** | Failed to generate or validate token |  -  |
+|**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)
+
+# **requestProvider**
+> requestProvider()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let provider: string; //An identifier for the auth provider (default to undefined)
+
+const { status, data } = await apiInstance.requestProvider(
+    provider
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **provider** | [**string**] | An identifier for the auth provider | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/html
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**308** | Redirect to the provider |  -  |
+|**404** | Provider not found |  -  |
+|**500** | 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)
+
+# **verifyAuth**
+> AuthVerify verifyAuth()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from 'gopadjs';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+const { status, data } = await apiInstance.verifyAuth();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuthVerify**
+
+### 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** | Metadata of the auth token |  -  |
+|**401** | Failed to generate or validate token |  -  |
+|**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/AuthToken.md

@@ -0,0 +1,22 @@
+# AuthToken
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [readonly] [default to undefined]
+**expires_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthToken } from 'gopadjs';
+
+const instance: AuthToken = {
+    token,
+    expires_at,
+};
+```
+
+[[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/AuthVerify.md

@@ -0,0 +1,22 @@
+# AuthVerify
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [readonly] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { AuthVerify } from 'gopadjs';
+
+const instance: AuthVerify = {
+    username,
+    created_at,
+};
+```
+
+[[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/CreateGroupRequest.md

@@ -0,0 +1,22 @@
+# CreateGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slug** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateGroupRequest } from 'gopadjs';
+
+const instance: CreateGroupRequest = {
+    slug,
+    name,
+};
+```
+
+[[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/CreateUserRequest.md

@@ -0,0 +1,30 @@
+# CreateUserRequest
+
+
+## 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 false]
+**active** | **boolean** |  | [optional] [default to true]
+
+## Example
+
+```typescript
+import { CreateUserRequest } from 'gopadjs';
+
+const instance: CreateUserRequest = {
+    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/DeleteGroupFromUserRequest.md

@@ -0,0 +1,20 @@
+# DeleteGroupFromUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteGroupFromUserRequest } from 'gopadjs';
+
+const instance: DeleteGroupFromUserRequest = {
+    user,
+};
+```
+
+[[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/DeleteUserFromGroupRequest.md

@@ -0,0 +1,20 @@
+# DeleteUserFromGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteUserFromGroupRequest } from 'gopadjs';
+
+const instance: DeleteUserFromGroupRequest = {
+    group,
+};
+```
+
+[[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/Group.md

@@ -0,0 +1,29 @@
+# Group
+
+Model to represent group
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Group } from 'gopadjs';
+
+const instance: Group = {
+    id,
+    slug,
+    name,
+    created_at,
+    updated_at,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)