@handsondigital/idplugger-admin
v2.1.2
Published
OpenAPI client for @handsondigital/idplugger-admin
Maintainers
Readme
@handsondigital/[email protected]
This generator creates TypeScript/JavaScript client that utilizes 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)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
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/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://api.idplugger.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApiLogsApi | adminLogsGet | GET /admin/logs | List API logs ApiLogsApi | adminLogsIdGet | GET /admin/logs/{id} | Get specific API log AuthApi | adminAuthRequestToken | POST /admin/auth/request-token | Solicita envio de token de login por email AuthApi | authLogin | POST /v3/login | Login na API AuthApi | authLoginByToken | POST /admin/auth/login | Login na API via e-mail e token AuthApi | authMe | GET /v3/me | Dados na API AuthApi | authRefreshToken | POST /admin/auth/refresh | Renova o do token de autenticação ErrorReportsApi | adminErrorsGet | GET /admin/errors | List error reports ErrorReportsApi | adminErrorsIdDelete | DELETE /admin/errors/{id} | Delete error report ErrorReportsApi | adminErrorsIdGet | GET /admin/errors/{id} | Get specific error report MetricsApi | metrics | GET /v3/metrics | Devolve as métricas da promoção PromotionApi | adminPromotionCacheClear | POST /v3/admin/promotion/{promotion_id}/cache/clear | Renova o cache de uma promoção na API PromotionApi | promotionPullConfiguration | POST /v3/admin/pullconfiguration | Adicionar/Atualizar configurações de uma promoção ao orquestrador PromotionApi | promotionStart | POST /v3/admin/promotion/start | Iniciar uma promoção na API RolesApi | rolesAttachPermissions | POST /v3/admin/roles/{id}/permissions | Atualizar permissões de uma role RolesApi | rolesDestroy | DELETE /v3/admin/roles/{id} | Remover role RolesApi | rolesIndex | GET /v3/admin/roles | Listar roles RolesApi | rolesPermissions | GET /v3/admin/roles/{id}/permissions | Listar permissões de uma role RolesApi | rolesShow | GET /v3/admin/roles/{id} | Exibir detalhes da role RolesApi | rolesStore | POST /v3/admin/roles | Criar role RolesApi | rolesUpdate | PATCH /v3/admin/roles/{id} | Atualizar role StepsApi | stepsAllow | POST /v3/steps/allow | Inclui uma Step em um determinado endpoint StepsApi | stepsIndex | GET /v3/steps | Retorna todas as steps existentes StepsApi | stepsUnallow | POST /v3/steps/disallow | Remove uma Step de um determinado endpoint UserApi | userGrantPermissions | POST /v3/admin/user/grantpermissions | Dar permissões a um usuário na API UserApi | userRegister | POST /v3/admin/user/register | Registrar usuário na API UserApi | userShow | GET /v3/admin/user/{uuid} | Visualizar dados do usuário na API UserApi | userUpdate | PATCH /v3/admin/user/{uuid} | Atualizar nome do usuário na API
Documentation For Models
- AdminAuthRequestToken200Response
- AdminAuthRequestTokenRequest
- AdminPromotionCacheClear200Response
- AdminPromotionCacheClear200ResponseContent
- AdminPromotionCacheClear500Response
- ApiLog
- ApiLogPaginated
- AuthLogin200Response
- AuthLogin401Response
- AuthLoginByToken200Response
- AuthLoginByTokenRequest
- AuthLoginRequest
- AuthMe200Response
- AuthMe200ResponsePromotionsInner
- AuthRefreshTokenRequest
- ErrorReport
- ErrorReportPaginated
- ErrorResponse
- Metrics200Response
- Metrics200ResponseUsersInner
- Metrics400Response
- Pagination
- PaginationLinksInner
- PromotionPullConfiguration200Response
- PromotionPullConfiguration500Response
- PromotionPullConfigurationRequest
- PromotionPullConfigurationRequestDb
- PromotionStart200Response
- PromotionStart200ResponseUser
- PromotionStartRequest
- PromotionStartRequestUser
- RolesAttachPermissions200Response
- RolesAttachPermissions422Response
- RolesAttachPermissionsRequest
- RolesDestroy400Response
- RolesIndex200Response
- RolesIndex200ResponseRolesInner
- RolesIndex500Response
- RolesPermissions200Response
- RolesShow200Response
- RolesShow200ResponsePermissionsInner
- RolesShow200ResponseRole
- RolesStore201Response
- RolesStore201ResponseRole
- RolesStore422Response
- RolesStoreRequest
- RolesUpdate200Response
- RolesUpdateRequest
- StepsAllow201Response
- StepsAllow409Response
- StepsAllowRequest
- StepsIndex200Response
- StepsIndex200ResponseStepsValueValue
- StepsUnallow201Response
- StepsUnallow409Response
- SuccessResponse
- UserGrantPermissions200Response
- UserGrantPermissions200ResponseUserInner
- UserGrantPermissions500Response
- UserGrantPermissionsRequest
- UserRegister200Response
- UserRegister200ResponseUserInner
- UserRegister500Response
- UserRegisterRequest
- UserShow200Response
- UserShow200ResponseUser
- UserShow404Response
- UserShow500Response
- UserUpdate200Response
- UserUpdate200ResponseUser
- UserUpdate404Response
- UserUpdate422Response
- UserUpdate500Response
- UserUpdateRequest
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication (JWT)
