@handsondigital/idplugger-admin 1.0.0

package/docs/UserApi.md

@@ -0,0 +1,226 @@
+# UserApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**userGrantPermissions**](#usergrantpermissions) | **POST** /v3/admin/user/grantpermissions | Dar permissões a um usuário na API|
+|[**userRegister**](#userregister) | **POST** /v3/admin/user/register | Registrar usuário na API|
+|[**userShow**](#usershow) | **GET** /v3/admin/user/{uuid} | Visualizar dados do usuário na API|
+|[**userUpdate**](#userupdate) | **PATCH** /v3/admin/user/{uuid} | Atualizar nome do usuário na API|
+
+# **userGrantPermissions**
+> UserGrantPermissions200Response userGrantPermissions()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    UserGrantPermissionsRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userGrantPermissionsRequest: UserGrantPermissionsRequest; // (optional)
+
+const { status, data } = await apiInstance.userGrantPermissions(
+    userGrantPermissionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userGrantPermissionsRequest** | **UserGrantPermissionsRequest**|  | |
+
+
+### Return type
+
+**UserGrantPermissions200Response**
+
+### 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 |  -  |
+|**401** | failed |  -  |
+|**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)
+
+# **userRegister**
+> UserRegister200Response userRegister()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    UserRegisterRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userRegisterRequest: UserRegisterRequest; // (optional)
+
+const { status, data } = await apiInstance.userRegister(
+    userRegisterRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userRegisterRequest** | **UserRegisterRequest**|  | |
+
+
+### Return type
+
+**UserRegister200Response**
+
+### 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 |  -  |
+|**401** | failed |  -  |
+|**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)
+
+# **userShow**
+> UserShow200Response userShow()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let uuid: string; //UUID do usuário a ser visualizado (default to undefined)
+
+const { status, data } = await apiInstance.userShow(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] | UUID do usuário a ser visualizado | defaults to undefined|
+
+
+### Return type
+
+**UserShow200Response**
+
+### 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** | failed |  -  |
+|**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)
+
+# **userUpdate**
+> UserUpdate200Response userUpdate()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    UserUpdateRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let uuid: string; //UUID do usuário a ser atualizado (default to undefined)
+let userUpdateRequest: UserUpdateRequest; // (optional)
+
+const { status, data } = await apiInstance.userUpdate(
+    uuid,
+    userUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userUpdateRequest** | **UserUpdateRequest**|  | |
+| **uuid** | [**string**] | UUID do usuário a ser atualizado | defaults to undefined|
+
+
+### Return type
+
+**UserUpdate200Response**
+
+### 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** | failed |  -  |
+|**422** | validation error |  -  |
+|**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)
+

package/docs/UserGrantPermissions200Response.md

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

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

@@ -0,0 +1,24 @@
+# UserGrantPermissions500Response
+
+
+## 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 { UserGrantPermissions500Response } from '@handsondigital/idplugger-admin';
+
+const instance: UserGrantPermissions500Response = {
+    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/UserGrantPermissionsRequest.md

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

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

@@ -0,0 +1,28 @@
+# UserRegister200ResponseUserInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**uuid** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserRegister200ResponseUserInner } from '@handsondigital/idplugger-admin';
+
+const instance: UserRegister200ResponseUserInner = {
+    password,
+    username,
+    name,
+    email,
+    uuid,
+};
+```
+
+[[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/UserRegister500Response.md

@@ -0,0 +1,24 @@
+# UserRegister500Response
+
+
+## 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 { UserRegister500Response } from '@handsondigital/idplugger-admin';
+
+const instance: UserRegister500Response = {
+    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/UserRegisterRequest.md

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

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

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

@@ -0,0 +1,24 @@
+# UserShow404Response
+
+
+## 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 { UserShow404Response } from '@handsondigital/idplugger-admin';
+
+const instance: UserShow404Response = {
+    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/UserShow500Response.md

@@ -0,0 +1,24 @@
+# UserShow500Response
+
+
+## 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 { UserShow500Response } from '@handsondigital/idplugger-admin';
+
+const instance: UserShow500Response = {
+    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/UserUpdate200Response.md

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

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

@@ -0,0 +1,24 @@
+# UserUpdate404Response
+
+
+## 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 { UserUpdate404Response } from '@handsondigital/idplugger-admin';
+
+const instance: UserUpdate404Response = {
+    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/UserUpdate422Response.md

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

@@ -0,0 +1,24 @@
+# UserUpdate500Response
+
+
+## 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 { UserUpdate500Response } from '@handsondigital/idplugger-admin';
+
+const instance: UserUpdate500Response = {
+    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/UserUpdateRequest.md

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