@handsondigital/idplugger-admin 2.1.2 → 2.2.1

package/docs/AdminUsersList200ResponsePagination.md

@@ -0,0 +1,40 @@
+# AdminUsersList200ResponsePagination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **number** |  | [optional] [default to undefined]
+**first_page_url** | **string** |  | [optional] [default to undefined]
+**from** | **number** |  | [optional] [default to undefined]
+**last_page** | **number** |  | [optional] [default to undefined]
+**last_page_url** | **string** |  | [optional] [default to undefined]
+**next_page_url** | **string** |  | [optional] [default to undefined]
+**path** | **string** |  | [optional] [default to undefined]
+**per_page** | **number** |  | [optional] [default to undefined]
+**prev_page_url** | **string** |  | [optional] [default to undefined]
+**to** | **number** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminUsersList200ResponsePagination } from '@handsondigital/idplugger-admin';
+
+const instance: AdminUsersList200ResponsePagination = {
+    current_page,
+    first_page_url,
+    from,
+    last_page,
+    last_page_url,
+    next_page_url,
+    path,
+    per_page,
+    prev_page_url,
+    to,
+    total,
+};
+```
+
+[[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/AdminUsersList200ResponseUsersInner.md

@@ -0,0 +1,30 @@
+# AdminUsersList200ResponseUsersInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**permissions** | [**Array<AdminUsersList200ResponseUsersInnerPermissionsInner>**](AdminUsersList200ResponseUsersInnerPermissionsInner.md) | Incluído apenas se _include=permissions | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminUsersList200ResponseUsersInner } from '@handsondigital/idplugger-admin';
+
+const instance: AdminUsersList200ResponseUsersInner = {
+    uuid,
+    username,
+    name,
+    email,
+    role,
+    permissions,
+};
+```
+
+[[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/AdminUsersList200ResponseUsersInnerPermissionsInner.md

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

@@ -0,0 +1,24 @@
+# AdminUsersList500Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminUsersList500Response } from '@handsondigital/idplugger-admin';
+
+const instance: AdminUsersList500Response = {
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ErrorsApi.md

@@ -0,0 +1,174 @@
+# ErrorsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminErrorsDestroy**](#adminerrorsdestroy) | **DELETE** /v3/admin/errors/{id} | Deletar relatório de erro|
+|[**adminErrorsIndex**](#adminerrorsindex) | **GET** /v3/admin/errors/ | Listar relatórios de erro|
+|[**adminErrorsShow**](#adminerrorsshow) | **GET** /v3/admin/errors/{id} | Visualizar erro específico|
+
+# **adminErrorsDestroy**
+> AdminErrorsDestroy200Response adminErrorsDestroy()
+
+
+### Example
+
+```typescript
+import {
+    ErrorsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ErrorsApi(configuration);
+
+let id: string; //ID do relatório de erro (default to undefined)
+
+const { status, data } = await apiInstance.adminErrorsDestroy(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID do relatório de erro | defaults to undefined|
+
+
+### Return type
+
+**AdminErrorsDestroy200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**404** | not found |  -  |
+|**401** | unauthorized |  -  |
+
+[[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)
+
+# **adminErrorsIndex**
+> AdminErrorsIndex200Response adminErrorsIndex()
+
+
+### Example
+
+```typescript
+import {
+    ErrorsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ErrorsApi(configuration);
+
+let q: string; //Buscar em id, mensagem, classe da exceção, arquivo (optional) (default to undefined)
+let _class: string; //Filtrar por classe da exceção (optional) (default to undefined)
+let date: string; //Filtrar por data (optional) (default to undefined)
+let page: number; //Número da página (optional) (default to 1)
+
+const { status, data } = await apiInstance.adminErrorsIndex(
+    q,
+    _class,
+    date,
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **q** | [**string**] | Buscar em id, mensagem, classe da exceção, arquivo | (optional) defaults to undefined|
+| **_class** | [**string**] | Filtrar por classe da exceção | (optional) defaults to undefined|
+| **date** | [**string**] | Filtrar por data | (optional) defaults to undefined|
+| **page** | [**number**] | Número da página | (optional) defaults to 1|
+
+
+### Return type
+
+**AdminErrorsIndex200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**401** | unauthorized |  -  |
+
+[[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)
+
+# **adminErrorsShow**
+> AdminErrorsShow200Response adminErrorsShow()
+
+
+### Example
+
+```typescript
+import {
+    ErrorsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ErrorsApi(configuration);
+
+let id: string; //ID do relatório de erro (default to undefined)
+
+const { status, data } = await apiInstance.adminErrorsShow(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID do relatório de erro | defaults to undefined|
+
+
+### Return type
+
+**AdminErrorsShow200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**404** | not found |  -  |
+|**401** | unauthorized |  -  |
+
+[[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/LogsApi.md

@@ -0,0 +1,133 @@
+# LogsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminLogsIndex**](#adminlogsindex) | **GET** /v3/admin/logs/ | Listar logs de requisições da API|
+|[**adminLogsShow**](#adminlogsshow) | **GET** /v3/admin/logs/{id} | Visualizar log específico|
+
+# **adminLogsIndex**
+> AdminLogsIndex200Response adminLogsIndex()
+
+
+### Example
+
+```typescript
+import {
+    LogsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new LogsApi(configuration);
+
+let path: string; //Filtrar por caminho da requisição (optional) (default to undefined)
+let method: string; //Filtrar por método HTTP (optional) (default to undefined)
+let status: number; //Filtrar por status code (optional) (default to undefined)
+let username: string; //Filtrar por username do usuário (optional) (default to undefined)
+let from: string; //Data inicial (YYYY-MM-DD) (optional) (default to undefined)
+let to: string; //Data final (YYYY-MM-DD) (optional) (default to undefined)
+let perPage: number; //Itens por página (optional) (default to 50)
+let page: number; //Número da página (optional) (default to 1)
+
+const { status, data } = await apiInstance.adminLogsIndex(
+    path,
+    method,
+    status,
+    username,
+    from,
+    to,
+    perPage,
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **path** | [**string**] | Filtrar por caminho da requisição | (optional) defaults to undefined|
+| **method** | [**string**] | Filtrar por método HTTP | (optional) defaults to undefined|
+| **status** | [**number**] | Filtrar por status code | (optional) defaults to undefined|
+| **username** | [**string**] | Filtrar por username do usuário | (optional) defaults to undefined|
+| **from** | [**string**] | Data inicial (YYYY-MM-DD) | (optional) defaults to undefined|
+| **to** | [**string**] | Data final (YYYY-MM-DD) | (optional) defaults to undefined|
+| **perPage** | [**number**] | Itens por página | (optional) defaults to 50|
+| **page** | [**number**] | Número da página | (optional) defaults to 1|
+
+
+### Return type
+
+**AdminLogsIndex200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**401** | unauthorized |  -  |
+
+[[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)
+
+# **adminLogsShow**
+> AdminLogsShow200Response adminLogsShow()
+
+
+### Example
+
+```typescript
+import {
+    LogsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new LogsApi(configuration);
+
+let id: number; //ID do log (default to undefined)
+
+const { status, data } = await apiInstance.adminLogsShow(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | ID do log | defaults to undefined|
+
+
+### Return type
+
+**AdminLogsShow200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**404** | not found |  -  |
+|**401** | unauthorized |  -  |
+
+[[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)
+