npm package: @handsondigital/idplugger-admin
Description: OpenAPI client for @handsondigital/idplugger-admin
Author: OpenAPI-Generator Contributors
Latest version: 2.7.4

## @handsondigital/idplugger-admin@2.7.4

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @handsondigital/idplugger-admin@2.7.4 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *https://api.idplugger.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiLogsApi* | [**adminLogsGet**](docs/ApiLogsApi.md#adminlogsget) | **GET** /admin/logs | List API logs
*ApiLogsApi* | [**adminLogsIdGet**](docs/ApiLogsApi.md#adminlogsidget) | **GET** /admin/logs/{id} | Get specific API log
*AuthApi* | [**adminAuthRequestToken**](docs/AuthApi.md#adminauthrequesttoken) | **POST** /admin/auth/request-token | Solicita envio de token de login por email
*AuthApi* | [**authLogin**](docs/AuthApi.md#authlogin) | **POST** /v3/login | Login na API
*AuthApi* | [**authLoginByToken**](docs/AuthApi.md#authloginbytoken) | **POST** /admin/auth/login | Login na API via e-mail e token
*AuthApi* | [**authMe**](docs/AuthApi.md#authme) | **GET** /v3/me | Dados na API
*AuthApi* | [**authRefreshToken**](docs/AuthApi.md#authrefreshtoken) | **POST** /admin/auth/refresh | Renova o do token de autenticação
*ConfigsApi* | [**adminPromotionConfigsIndex**](docs/ConfigsApi.md#adminpromotionconfigsindex) | **GET** /v3/admin/promotion/{promotion_id}/configs | Listar configurações de uma promoção
*ConfigsApi* | [**adminPromotionConfigsShow**](docs/ConfigsApi.md#adminpromotionconfigsshow) | **GET** /v3/admin/promotion/{promotion_id}/configs/{key} | Buscar configuração por chave
*ConfigsApi* | [**adminPromotionConfigsStore**](docs/ConfigsApi.md#adminpromotionconfigsstore) | **POST** /v3/admin/promotion/{promotion_id}/configs | Criar nova configuração
*ConfigsApi* | [**adminPromotionConfigsUpdate**](docs/ConfigsApi.md#adminpromotionconfigsupdate) | **PUT** /v3/admin/promotion/{promotion_id}/configs/{key} | Atualizar configuração por chave
*ConfigsApi* | [**adminPromotionConfigsUpsert**](docs/ConfigsApi.md#adminpromotionconfigsupsert) | **POST** /v3/admin/promotion/{promotion_id}/configs/upsert | Criar ou atualizar configuração por chave (upsert)
*ConfigsApi* | [**adminPromotionConfigsValidKeys**](docs/ConfigsApi.md#adminpromotionconfigsvalidkeys) | **GET** /v3/admin/promotion/{promotion_id}/configs/valid-keys | Listar chaves válidas do ConfigKeyEnum
*CustomerServiceApi* | [**adminServiceCustomerApplications**](docs/CustomerServiceApi.md#adminservicecustomerapplications) | **GET** /admin/service/customer/applications/{client_id} | Listar aplicações de um cliente no serviço de atendimento ao cliente
*CustomerServiceApi* | [**adminServiceCustomerBrands**](docs/CustomerServiceApi.md#adminservicecustomerbrands) | **GET** /admin/service/customer/brands/{client_id} | Listar marcas de um cliente do serviço de atendimento ao cliente
*CustomerServiceApi* | [**adminServiceCustomerCampaigns**](docs/CustomerServiceApi.md#adminservicecustomercampaigns) | **GET** /admin/service/customer/campaigns/{client_id} | Listar campanhas de um cliente no serviço de atendimento ao cliente
*CustomerServiceApi* | [**adminServiceCustomerClients**](docs/CustomerServiceApi.md#adminservicecustomerclients) | **GET** /admin/service/customer/clients | Listar clientes do serviço de atendimento ao cliente
*ErrorReportsApi* | [**adminErrorsGet**](docs/ErrorReportsApi.md#adminerrorsget) | **GET** /admin/errors | List error reports
*ErrorReportsApi* | [**adminErrorsIdDelete**](docs/ErrorReportsApi.md#adminerrorsiddelete) | **DELETE** /admin/errors/{id} | Delete error report
*ErrorReportsApi* | [**adminErrorsIdGet**](docs/ErrorReportsApi.md#adminerrorsidget) | **GET** /admin/errors/{id} | Get specific error report
*ErrorsApi* | [**adminErrorsDestroy**](docs/ErrorsApi.md#adminerrorsdestroy) | **DELETE** /v3/admin/errors/{id} | Deletar relatório de erro
*ErrorsApi* | [**adminErrorsIndex**](docs/ErrorsApi.md#adminerrorsindex) | **GET** /v3/admin/errors/ | Listar relatórios de erro
*ErrorsApi* | [**adminErrorsShow**](docs/ErrorsApi.md#adminerrorsshow) | **GET** /v3/admin/errors/{id} | Visualizar erro específico
*LogsApi* | [**adminLogsIndex**](docs/LogsApi.md#adminlogsindex) | **GET** /v3/admin/logs/ | Listar logs de requisições da API
*LogsApi* | [**adminLogsShow**](docs/LogsApi.md#adminlogsshow) | **GET** /v3/admin/logs/{id} | Visualizar log específico
*MetricsApi* | [**metrics**](docs/MetricsApi.md#metrics) | **GET** /v3/metrics | Devolve as métricas da promoção
*PermissionsApi* | [**adminPermissionsByAction**](docs/PermissionsApi.md#adminpermissionsbyaction) | **GET** /v3/admin/permissions/action | Buscar permissões por ação
*PermissionsApi* | [**adminPermissionsByCategory**](docs/PermissionsApi.md#adminpermissionsbycategory) | **GET** /v3/admin/permissions/category | Buscar permissões por categoria
*PermissionsApi* | [**adminPermissionsCategories**](docs/PermissionsApi.md#adminpermissionscategories) | **GET** /v3/admin/permissions/categories | Listar todas as categorias de permissões
*PermissionsApi* | [**adminPermissionsGrouped**](docs/PermissionsApi.md#adminpermissionsgrouped) | **GET** /v3/admin/permissions/grouped | Listar permissões agrupadas por categoria
*PermissionsApi* | [**adminPermissionsIndex**](docs/PermissionsApi.md#adminpermissionsindex) | **GET** /v3/admin/permissions/ | Listar todas as permissões
*PermissionsApi* | [**adminPermissionsShow**](docs/PermissionsApi.md#adminpermissionsshow) | **GET** /v3/admin/permissions/{key} | Buscar permissão específica por chave
*PromotionApi* | [**adminPromotionCacheClear**](docs/PromotionApi.md#adminpromotioncacheclear) | **POST** /v3/admin/promotion/{promotion_id}/cache/clear | Renova o cache de uma promoção na API
*PromotionApi* | [**adminPromotionLuckyNumbersReset**](docs/PromotionApi.md#adminpromotionluckynumbersreset) | **POST** /v3/admin/promotion/{promotion_id}/lucky-numbers/reset | Resetar números da sorte de uma promoção
*PromotionApi* | [**promotionPullConfiguration**](docs/PromotionApi.md#promotionpullconfiguration) | **POST** /v3/admin/pullconfiguration | Adicionar/Atualizar configurações de uma promoção ao orquestrador
*PromotionApi* | [**promotionStart**](docs/PromotionApi.md#promotionstart) | **POST** /v3/admin/promotion/start | Iniciar uma promoção na API
*RolesApi* | [**rolesAttachPermissions**](docs/RolesApi.md#rolesattachpermissions) | **POST** /v3/admin/roles/{id}/permissions | Atualizar permissões de uma role
*RolesApi* | [**rolesDestroy**](docs/RolesApi.md#rolesdestroy) | **DELETE** /v3/admin/roles/{id} | Remover role
*RolesApi* | [**rolesIndex**](docs/RolesApi.md#rolesindex) | **GET** /v3/admin/roles | Listar roles
*RolesApi* | [**rolesPermissions**](docs/RolesApi.md#rolespermissions) | **GET** /v3/admin/roles/{id}/permissions | Listar permissões de uma role
*RolesApi* | [**rolesShow**](docs/RolesApi.md#rolesshow) | **GET** /v3/admin/roles/{id} | Exibir detalhes da role
*RolesApi* | [**rolesStore**](docs/RolesApi.md#rolesstore) | **POST** /v3/admin/roles | Criar role
*RolesApi* | [**rolesUpdate**](docs/RolesApi.md#rolesupdate) | **PATCH** /v3/admin/roles/{id} | Atualizar role
*StepsApi* | [**stepsAllow**](docs/StepsApi.md#stepsallow) | **POST** /v3/steps/allow | Inclui uma Step em um determinado endpoint
*StepsApi* | [**stepsIndex**](docs/StepsApi.md#stepsindex) | **GET** /v3/steps | Retorna todas as steps existentes
*StepsApi* | [**stepsUnallow**](docs/StepsApi.md#stepsunallow) | **POST** /v3/steps/disallow | Remove uma Step de um determinado endpoint
*UserApi* | [**adminUsersList**](docs/UserApi.md#adminuserslist) | **GET** /v3/admin/user | Listar usuários da API
*UserApi* | [**userGrantPermissions**](docs/UserApi.md#usergrantpermissions) | **POST** /v3/admin/user/grantpermissions | Dar permissões a um usuário na API
*UserApi* | [**userRegister**](docs/UserApi.md#userregister) | **POST** /v3/admin/user/register | Registrar usuário na API
*UserApi* | [**userResetPassword**](docs/UserApi.md#userresetpassword) | **POST** /v3/admin/user/resetpassword | Resetar senha do usuário na API
*UserApi* | [**userShow**](docs/UserApi.md#usershow) | **GET** /v3/admin/user/{uuid} | Visualizar dados do usuário na API
*UserApi* | [**userUpdate**](docs/UserApi.md#userupdate) | **PATCH** /v3/admin/user/{uuid} | Atualizar nome do usuário na API


### Documentation For Models

 - [AdminAuthRequestToken200Response](docs/AdminAuthRequestToken200Response.md)
 - [AdminAuthRequestTokenRequest](docs/AdminAuthRequestTokenRequest.md)
 - [AdminErrorsDestroy200Response](docs/AdminErrorsDestroy200Response.md)
 - [AdminErrorsIndex200Response](docs/AdminErrorsIndex200Response.md)
 - [AdminErrorsIndex200ResponseContentInner](docs/AdminErrorsIndex200ResponseContentInner.md)
 - [AdminErrorsShow200Response](docs/AdminErrorsShow200Response.md)
 - [AdminErrorsShow200ResponseContent](docs/AdminErrorsShow200ResponseContent.md)
 - [AdminLogsIndex200Response](docs/AdminLogsIndex200Response.md)
 - [AdminLogsIndex200ResponseContentInner](docs/AdminLogsIndex200ResponseContentInner.md)
 - [AdminLogsShow200Response](docs/AdminLogsShow200Response.md)
 - [AdminLogsShow200ResponseContent](docs/AdminLogsShow200ResponseContent.md)
 - [AdminPermissionsByAction200Response](docs/AdminPermissionsByAction200Response.md)
 - [AdminPermissionsByCategory200Response](docs/AdminPermissionsByCategory200Response.md)
 - [AdminPermissionsByCategory200ResponseContentInner](docs/AdminPermissionsByCategory200ResponseContentInner.md)
 - [AdminPermissionsCategories200Response](docs/AdminPermissionsCategories200Response.md)
 - [AdminPermissionsGrouped200Response](docs/AdminPermissionsGrouped200Response.md)
 - [AdminPermissionsGrouped200ResponseContentValueInner](docs/AdminPermissionsGrouped200ResponseContentValueInner.md)
 - [AdminPermissionsIndex200Response](docs/AdminPermissionsIndex200Response.md)
 - [AdminPermissionsIndex200ResponseContentInner](docs/AdminPermissionsIndex200ResponseContentInner.md)
 - [AdminPermissionsIndex200ResponseContentInnerRolesInner](docs/AdminPermissionsIndex200ResponseContentInnerRolesInner.md)
 - [AdminPermissionsShow200Response](docs/AdminPermissionsShow200Response.md)
 - [AdminPermissionsShow200ResponseContent](docs/AdminPermissionsShow200ResponseContent.md)
 - [AdminPromotionCacheClear200Response](docs/AdminPromotionCacheClear200Response.md)
 - [AdminPromotionCacheClear200ResponseContent](docs/AdminPromotionCacheClear200ResponseContent.md)
 - [AdminPromotionCacheClear500Response](docs/AdminPromotionCacheClear500Response.md)
 - [AdminPromotionConfigsIndex200Response](docs/AdminPromotionConfigsIndex200Response.md)
 - [AdminPromotionConfigsIndex200ResponseCategoriesInnerValue](docs/AdminPromotionConfigsIndex200ResponseCategoriesInnerValue.md)
 - [AdminPromotionConfigsIndex200ResponseConfigsValue](docs/AdminPromotionConfigsIndex200ResponseConfigsValue.md)
 - [AdminPromotionConfigsIndex200ResponseConfigsValueMetadata](docs/AdminPromotionConfigsIndex200ResponseConfigsValueMetadata.md)
 - [AdminPromotionConfigsIndex500Response](docs/AdminPromotionConfigsIndex500Response.md)
 - [AdminPromotionConfigsShow200Response](docs/AdminPromotionConfigsShow200Response.md)
 - [AdminPromotionConfigsShow200ResponseConfig](docs/AdminPromotionConfigsShow200ResponseConfig.md)
 - [AdminPromotionConfigsShow404Response](docs/AdminPromotionConfigsShow404Response.md)
 - [AdminPromotionConfigsStore201Response](docs/AdminPromotionConfigsStore201Response.md)
 - [AdminPromotionConfigsStoreRequest](docs/AdminPromotionConfigsStoreRequest.md)
 - [AdminPromotionConfigsUpdate200Response](docs/AdminPromotionConfigsUpdate200Response.md)
 - [AdminPromotionConfigsUpdateRequest](docs/AdminPromotionConfigsUpdateRequest.md)
 - [AdminPromotionConfigsUpsert200Response](docs/AdminPromotionConfigsUpsert200Response.md)
 - [AdminPromotionConfigsValidKeys200Response](docs/AdminPromotionConfigsValidKeys200Response.md)
 - [AdminPromotionConfigsValidKeys200ResponseValidKeysInner](docs/AdminPromotionConfigsValidKeys200ResponseValidKeysInner.md)
 - [AdminPromotionLuckyNumbersReset200Response](docs/AdminPromotionLuckyNumbersReset200Response.md)
 - [AdminPromotionLuckyNumbersReset500Response](docs/AdminPromotionLuckyNumbersReset500Response.md)
 - [AdminServiceCustomerApplications200Response](docs/AdminServiceCustomerApplications200Response.md)
 - [AdminServiceCustomerApplications200ResponseContentInner](docs/AdminServiceCustomerApplications200ResponseContentInner.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerClient](docs/AdminServiceCustomerApplications200ResponseContentInnerClient.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerProduct](docs/AdminServiceCustomerApplications200ResponseContentInnerProduct.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerProductOneOf](docs/AdminServiceCustomerApplications200ResponseContentInnerProductOneOf.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerProgrammingInner](docs/AdminServiceCustomerApplications200ResponseContentInnerProgrammingInner.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerPromotionsInner](docs/AdminServiceCustomerApplications200ResponseContentInnerPromotionsInner.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerWorkflowSchedulesInner](docs/AdminServiceCustomerApplications200ResponseContentInnerWorkflowSchedulesInner.md)
 - [AdminServiceCustomerApplications200ResponseContentInnerWorkflowSchedulesInnerWorkflow](docs/AdminServiceCustomerApplications200ResponseContentInnerWorkflowSchedulesInnerWorkflow.md)
 - [AdminServiceCustomerBrands200Response](docs/AdminServiceCustomerBrands200Response.md)
 - [AdminServiceCustomerBrands200ResponseContentInner](docs/AdminServiceCustomerBrands200ResponseContentInner.md)
 - [AdminServiceCustomerCampaigns200Response](docs/AdminServiceCustomerCampaigns200Response.md)
 - [AdminServiceCustomerCampaigns200ResponseContentInner](docs/AdminServiceCustomerCampaigns200ResponseContentInner.md)
 - [AdminServiceCustomerClients200Response](docs/AdminServiceCustomerClients200Response.md)
 - [AdminServiceCustomerClients200ResponseContentInner](docs/AdminServiceCustomerClients200ResponseContentInner.md)
 - [AdminServiceCustomerClients200ResponsePaging](docs/AdminServiceCustomerClients200ResponsePaging.md)
 - [AdminUsersList200Response](docs/AdminUsersList200Response.md)
 - [AdminUsersList200ResponsePagination](docs/AdminUsersList200ResponsePagination.md)
 - [AdminUsersList200ResponseUsersInner](docs/AdminUsersList200ResponseUsersInner.md)
 - [AdminUsersList500Response](docs/AdminUsersList500Response.md)
 - [ApiLog](docs/ApiLog.md)
 - [ApiLogPaginated](docs/ApiLogPaginated.md)
 - [AuthLogin200Response](docs/AuthLogin200Response.md)
 - [AuthLogin401Response](docs/AuthLogin401Response.md)
 - [AuthLoginByToken200Response](docs/AuthLoginByToken200Response.md)
 - [AuthLoginByTokenRequest](docs/AuthLoginByTokenRequest.md)
 - [AuthLoginRequest](docs/AuthLoginRequest.md)
 - [AuthMe200Response](docs/AuthMe200Response.md)
 - [AuthMe200ResponsePromotionsInner](docs/AuthMe200ResponsePromotionsInner.md)
 - [AuthRefreshTokenRequest](docs/AuthRefreshTokenRequest.md)
 - [ErrorReport](docs/ErrorReport.md)
 - [ErrorReportPaginated](docs/ErrorReportPaginated.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [Metrics200Response](docs/Metrics200Response.md)
 - [Metrics200ResponseUsersInner](docs/Metrics200ResponseUsersInner.md)
 - [Metrics400Response](docs/Metrics400Response.md)
 - [Pagination](docs/Pagination.md)
 - [PaginationLinksInner](docs/PaginationLinksInner.md)
 - [PromotionPullConfiguration200Response](docs/PromotionPullConfiguration200Response.md)
 - [PromotionPullConfiguration500Response](docs/PromotionPullConfiguration500Response.md)
 - [PromotionPullConfigurationRequest](docs/PromotionPullConfigurationRequest.md)
 - [PromotionPullConfigurationRequestDb](docs/PromotionPullConfigurationRequestDb.md)
 - [PromotionStart200Response](docs/PromotionStart200Response.md)
 - [PromotionStart200ResponseUser](docs/PromotionStart200ResponseUser.md)
 - [PromotionStartRequest](docs/PromotionStartRequest.md)
 - [PromotionStartRequestUser](docs/PromotionStartRequestUser.md)
 - [RolesAttachPermissions200Response](docs/RolesAttachPermissions200Response.md)
 - [RolesAttachPermissions422Response](docs/RolesAttachPermissions422Response.md)
 - [RolesAttachPermissionsRequest](docs/RolesAttachPermissionsRequest.md)
 - [RolesDestroy400Response](docs/RolesDestroy400Response.md)
 - [RolesIndex200Response](docs/RolesIndex200Response.md)
 - [RolesIndex200ResponseRolesInner](docs/RolesIndex200ResponseRolesInner.md)
 - [RolesIndex500Response](docs/RolesIndex500Response.md)
 - [RolesPermissions200Response](docs/RolesPermissions200Response.md)
 - [RolesShow200Response](docs/RolesShow200Response.md)
 - [RolesShow200ResponsePermissionsInner](docs/RolesShow200ResponsePermissionsInner.md)
 - [RolesShow200ResponseRole](docs/RolesShow200ResponseRole.md)
 - [RolesStore201Response](docs/RolesStore201Response.md)
 - [RolesStore201ResponseRole](docs/RolesStore201ResponseRole.md)
 - [RolesStore422Response](docs/RolesStore422Response.md)
 - [RolesStoreRequest](docs/RolesStoreRequest.md)
 - [RolesUpdate200Response](docs/RolesUpdate200Response.md)
 - [RolesUpdateRequest](docs/RolesUpdateRequest.md)
 - [StepsAllow201Response](docs/StepsAllow201Response.md)
 - [StepsAllow409Response](docs/StepsAllow409Response.md)
 - [StepsAllowRequest](docs/StepsAllowRequest.md)
 - [StepsIndex200Response](docs/StepsIndex200Response.md)
 - [StepsIndex200ResponseStepsValueValue](docs/StepsIndex200ResponseStepsValueValue.md)
 - [StepsUnallow201Response](docs/StepsUnallow201Response.md)
 - [StepsUnallow409Response](docs/StepsUnallow409Response.md)
 - [SuccessResponse](docs/SuccessResponse.md)
 - [UserGrantPermissions200Response](docs/UserGrantPermissions200Response.md)
 - [UserGrantPermissions200ResponseUserInner](docs/UserGrantPermissions200ResponseUserInner.md)
 - [UserGrantPermissions500Response](docs/UserGrantPermissions500Response.md)
 - [UserGrantPermissionsRequest](docs/UserGrantPermissionsRequest.md)
 - [UserRegister200Response](docs/UserRegister200Response.md)
 - [UserRegister200ResponseUser](docs/UserRegister200ResponseUser.md)
 - [UserRegister500Response](docs/UserRegister500Response.md)
 - [UserRegisterRequest](docs/UserRegisterRequest.md)
 - [UserResetPassword200Response](docs/UserResetPassword200Response.md)
 - [UserResetPassword200ResponseUser](docs/UserResetPassword200ResponseUser.md)
 - [UserResetPassword500Response](docs/UserResetPassword500Response.md)
 - [UserResetPasswordRequest](docs/UserResetPasswordRequest.md)
 - [UserShow200Response](docs/UserShow200Response.md)
 - [UserShow200ResponseUser](docs/UserShow200ResponseUser.md)
 - [UserShow404Response](docs/UserShow404Response.md)
 - [UserShow500Response](docs/UserShow500Response.md)
 - [UserUpdate200Response](docs/UserUpdate200Response.md)
 - [UserUpdate200ResponseUser](docs/UserUpdate200ResponseUser.md)
 - [UserUpdate404Response](docs/UserUpdate404Response.md)
 - [UserUpdate422Response](docs/UserUpdate422Response.md)
 - [UserUpdate500Response](docs/UserUpdate500Response.md)
 - [UserUpdateRequest](docs/UserUpdateRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)