@handsondigital/idplugger-admin 1.0.0

package/docs/RolesApi.md

@@ -0,0 +1,376 @@
+# RolesApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**rolesAttachPermissions**](#rolesattachpermissions) | **POST** /v3/admin/roles/{id}/permissions | Atualizar permissões de uma role|
+|[**rolesDestroy**](#rolesdestroy) | **DELETE** /v3/admin/roles/{id} | Remover role|
+|[**rolesIndex**](#rolesindex) | **GET** /v3/admin/roles | Listar roles|
+|[**rolesPermissions**](#rolespermissions) | **GET** /v3/admin/roles/{id}/permissions | Listar permissões de uma role|
+|[**rolesShow**](#rolesshow) | **GET** /v3/admin/roles/{id} | Exibir detalhes da role|
+|[**rolesStore**](#rolesstore) | **POST** /v3/admin/roles | Criar role|
+|[**rolesUpdate**](#rolesupdate) | **PATCH** /v3/admin/roles/{id} | Atualizar role|
+
+# **rolesAttachPermissions**
+> RolesAttachPermissions200Response rolesAttachPermissions()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration,
+    RolesAttachPermissionsRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let id: number; //ID da role (default to undefined)
+let rolesAttachPermissionsRequest: RolesAttachPermissionsRequest; // (optional)
+
+const { status, data } = await apiInstance.rolesAttachPermissions(
+    id,
+    rolesAttachPermissionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rolesAttachPermissionsRequest** | **RolesAttachPermissionsRequest**|  | |
+| **id** | [**number**] | ID da role | defaults to undefined|
+
+
+### Return type
+
+**RolesAttachPermissions200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**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)
+
+# **rolesDestroy**
+> rolesDestroy()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let id: number; //ID da role (default to undefined)
+
+const { status, data } = await apiInstance.rolesDestroy(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | ID da role | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### 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 |  -  |
+|**400** | failed |  -  |
+|**404** | not found |  -  |
+
+[[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)
+
+# **rolesIndex**
+> RolesIndex200Response rolesIndex()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+const { status, data } = await apiInstance.rolesIndex();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**RolesIndex200Response**
+
+### 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 |  -  |
+|**500** | failed |  -  |
+
+[[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)
+
+# **rolesPermissions**
+> RolesPermissions200Response rolesPermissions()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let id: number; //ID da role (default to undefined)
+
+const { status, data } = await apiInstance.rolesPermissions(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | ID da role | defaults to undefined|
+
+
+### Return type
+
+**RolesPermissions200Response**
+
+### 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 |  -  |
+
+[[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)
+
+# **rolesShow**
+> RolesShow200Response rolesShow()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let id: number; //ID da role (default to undefined)
+
+const { status, data } = await apiInstance.rolesShow(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | ID da role | defaults to undefined|
+
+
+### Return type
+
+**RolesShow200Response**
+
+### 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 |  -  |
+
+[[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)
+
+# **rolesStore**
+> RolesStore201Response rolesStore()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration,
+    RolesStoreRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let rolesStoreRequest: RolesStoreRequest; // (optional)
+
+const { status, data } = await apiInstance.rolesStore(
+    rolesStoreRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rolesStoreRequest** | **RolesStoreRequest**|  | |
+
+
+### Return type
+
+**RolesStore201Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | created |  -  |
+|**422** | validation error |  -  |
+|**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)
+
+# **rolesUpdate**
+> RolesUpdate200Response rolesUpdate()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration,
+    RolesUpdateRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let id: number; //ID da role (default to undefined)
+let rolesUpdateRequest: RolesUpdateRequest; // (optional)
+
+const { status, data } = await apiInstance.rolesUpdate(
+    id,
+    rolesUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rolesUpdateRequest** | **RolesUpdateRequest**|  | |
+| **id** | [**number**] | ID da role | defaults to undefined|
+
+
+### Return type
+
+**RolesUpdate200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**404** | not found |  -  |
+|**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)
+

package/docs/RolesAttachPermissions200Response.md

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

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

@@ -0,0 +1,20 @@
+# RolesAttachPermissionsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions** | **Array<number>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RolesAttachPermissionsRequest } from '@handsondigital/idplugger-admin';
+
+const instance: RolesAttachPermissionsRequest = {
+    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/RolesDestroy400Response.md

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

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

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

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

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

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

@@ -0,0 +1,32 @@
+# RolesShow200ResponsePermissionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**key** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**category** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**is_active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RolesShow200ResponsePermissionsInner } from '@handsondigital/idplugger-admin';
+
+const instance: RolesShow200ResponsePermissionsInner = {
+    id,
+    key,
+    title,
+    description,
+    category,
+    action,
+    is_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/RolesShow200ResponseRole.md

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

@@ -0,0 +1,26 @@
+# RolesStore201Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**role** | [**RolesStore201ResponseRole**](RolesStore201ResponseRole.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RolesStore201Response } from '@handsondigital/idplugger-admin';
+
+const instance: RolesStore201Response = {
+    action,
+    result,
+    message,
+    role,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)