@handsondigital/idplugger-admin 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/.openapi-generator/FILES +81 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +154 -0
  5. package/api.ts +3648 -0
  6. package/base.ts +86 -0
  7. package/common.ts +150 -0
  8. package/configuration.ts +115 -0
  9. package/dist/api.d.ts +2664 -0
  10. package/dist/api.js +2463 -0
  11. package/dist/base.d.ts +66 -0
  12. package/dist/base.js +86 -0
  13. package/dist/common.d.ts +65 -0
  14. package/dist/common.js +253 -0
  15. package/dist/configuration.d.ts +91 -0
  16. package/dist/configuration.js +57 -0
  17. package/dist/index.d.ts +13 -0
  18. package/dist/index.js +31 -0
  19. package/docs/AdminAuthRequestToken200Response.md +24 -0
  20. package/docs/AdminAuthRequestTokenRequest.md +20 -0
  21. package/docs/AuthApi.md +264 -0
  22. package/docs/AuthLogin200Response.md +24 -0
  23. package/docs/AuthLogin401Response.md +20 -0
  24. package/docs/AuthLoginByToken200Response.md +26 -0
  25. package/docs/AuthLoginByTokenRequest.md +22 -0
  26. package/docs/AuthLoginRequest.md +22 -0
  27. package/docs/AuthMe200Response.md +28 -0
  28. package/docs/AuthMe200ResponsePromotionsInner.md +22 -0
  29. package/docs/AuthRefreshTokenRequest.md +20 -0
  30. package/docs/Metrics200Response.md +24 -0
  31. package/docs/Metrics200ResponseUsersInner.md +22 -0
  32. package/docs/Metrics400Response.md +20 -0
  33. package/docs/MetricsApi.md +75 -0
  34. package/docs/PromotionApi.md +115 -0
  35. package/docs/PromotionPullConfiguration200Response.md +24 -0
  36. package/docs/PromotionPullConfiguration500Response.md +24 -0
  37. package/docs/PromotionPullConfigurationRequest.md +20 -0
  38. package/docs/PromotionPullConfigurationRequestDb.md +28 -0
  39. package/docs/PromotionStart200Response.md +28 -0
  40. package/docs/PromotionStart200ResponseUser.md +30 -0
  41. package/docs/PromotionStartRequest.md +24 -0
  42. package/docs/PromotionStartRequestUser.md +24 -0
  43. package/docs/RolesApi.md +376 -0
  44. package/docs/RolesAttachPermissions200Response.md +28 -0
  45. package/docs/RolesAttachPermissions422Response.md +20 -0
  46. package/docs/RolesAttachPermissionsRequest.md +20 -0
  47. package/docs/RolesDestroy400Response.md +20 -0
  48. package/docs/RolesIndex200Response.md +26 -0
  49. package/docs/RolesIndex200ResponseRolesInner.md +26 -0
  50. package/docs/RolesIndex500Response.md +20 -0
  51. package/docs/RolesPermissions200Response.md +28 -0
  52. package/docs/RolesShow200Response.md +28 -0
  53. package/docs/RolesShow200ResponsePermissionsInner.md +32 -0
  54. package/docs/RolesShow200ResponseRole.md +26 -0
  55. package/docs/RolesStore201Response.md +26 -0
  56. package/docs/RolesStore201ResponseRole.md +26 -0
  57. package/docs/RolesStore422Response.md +20 -0
  58. package/docs/RolesStoreRequest.md +24 -0
  59. package/docs/RolesUpdate200Response.md +26 -0
  60. package/docs/RolesUpdateRequest.md +24 -0
  61. package/docs/StepsAllow201Response.md +26 -0
  62. package/docs/StepsAllow409Response.md +26 -0
  63. package/docs/StepsAllowRequest.md +24 -0
  64. package/docs/StepsApi.md +167 -0
  65. package/docs/StepsIndex200Response.md +22 -0
  66. package/docs/StepsIndex200ResponseStepsValueValue.md +30 -0
  67. package/docs/StepsUnallow201Response.md +26 -0
  68. package/docs/StepsUnallow409Response.md +26 -0
  69. package/docs/UserApi.md +226 -0
  70. package/docs/UserGrantPermissions200Response.md +26 -0
  71. package/docs/UserGrantPermissions200ResponseUserInner.md +24 -0
  72. package/docs/UserGrantPermissions500Response.md +24 -0
  73. package/docs/UserGrantPermissionsRequest.md +24 -0
  74. package/docs/UserRegister200Response.md +26 -0
  75. package/docs/UserRegister200ResponseUserInner.md +28 -0
  76. package/docs/UserRegister500Response.md +24 -0
  77. package/docs/UserRegisterRequest.md +24 -0
  78. package/docs/UserShow200Response.md +26 -0
  79. package/docs/UserShow200ResponseUser.md +26 -0
  80. package/docs/UserShow404Response.md +24 -0
  81. package/docs/UserShow500Response.md +24 -0
  82. package/docs/UserUpdate200Response.md +26 -0
  83. package/docs/UserUpdate200ResponseUser.md +26 -0
  84. package/docs/UserUpdate404Response.md +24 -0
  85. package/docs/UserUpdate422Response.md +20 -0
  86. package/docs/UserUpdate500Response.md +24 -0
  87. package/docs/UserUpdateRequest.md +20 -0
  88. package/git_push.sh +57 -0
  89. package/index.ts +18 -0
  90. package/package.json +31 -0
  91. package/tsconfig.json +21 -0
@@ -0,0 +1,81 @@
1
+ .gitignore
2
+ .npmignore
3
+ .openapi-generator-ignore
4
+ README.md
5
+ api.ts
6
+ base.ts
7
+ common.ts
8
+ configuration.ts
9
+ docs/AdminAuthRequestToken200Response.md
10
+ docs/AdminAuthRequestTokenRequest.md
11
+ docs/AuthApi.md
12
+ docs/AuthLogin200Response.md
13
+ docs/AuthLogin401Response.md
14
+ docs/AuthLoginByToken200Response.md
15
+ docs/AuthLoginByTokenRequest.md
16
+ docs/AuthLoginRequest.md
17
+ docs/AuthMe200Response.md
18
+ docs/AuthMe200ResponsePromotionsInner.md
19
+ docs/AuthRefreshTokenRequest.md
20
+ docs/Metrics200Response.md
21
+ docs/Metrics200ResponseUsersInner.md
22
+ docs/Metrics400Response.md
23
+ docs/MetricsApi.md
24
+ docs/PromotionApi.md
25
+ docs/PromotionPullConfiguration200Response.md
26
+ docs/PromotionPullConfiguration500Response.md
27
+ docs/PromotionPullConfigurationRequest.md
28
+ docs/PromotionPullConfigurationRequestDb.md
29
+ docs/PromotionStart200Response.md
30
+ docs/PromotionStart200ResponseUser.md
31
+ docs/PromotionStartRequest.md
32
+ docs/PromotionStartRequestUser.md
33
+ docs/RolesApi.md
34
+ docs/RolesAttachPermissions200Response.md
35
+ docs/RolesAttachPermissions422Response.md
36
+ docs/RolesAttachPermissionsRequest.md
37
+ docs/RolesDestroy400Response.md
38
+ docs/RolesIndex200Response.md
39
+ docs/RolesIndex200ResponseRolesInner.md
40
+ docs/RolesIndex500Response.md
41
+ docs/RolesPermissions200Response.md
42
+ docs/RolesShow200Response.md
43
+ docs/RolesShow200ResponsePermissionsInner.md
44
+ docs/RolesShow200ResponseRole.md
45
+ docs/RolesStore201Response.md
46
+ docs/RolesStore201ResponseRole.md
47
+ docs/RolesStore422Response.md
48
+ docs/RolesStoreRequest.md
49
+ docs/RolesUpdate200Response.md
50
+ docs/RolesUpdateRequest.md
51
+ docs/StepsAllow201Response.md
52
+ docs/StepsAllow409Response.md
53
+ docs/StepsAllowRequest.md
54
+ docs/StepsApi.md
55
+ docs/StepsIndex200Response.md
56
+ docs/StepsIndex200ResponseStepsValueValue.md
57
+ docs/StepsUnallow201Response.md
58
+ docs/StepsUnallow409Response.md
59
+ docs/UserApi.md
60
+ docs/UserGrantPermissions200Response.md
61
+ docs/UserGrantPermissions200ResponseUserInner.md
62
+ docs/UserGrantPermissions500Response.md
63
+ docs/UserGrantPermissionsRequest.md
64
+ docs/UserRegister200Response.md
65
+ docs/UserRegister200ResponseUserInner.md
66
+ docs/UserRegister500Response.md
67
+ docs/UserRegisterRequest.md
68
+ docs/UserShow200Response.md
69
+ docs/UserShow200ResponseUser.md
70
+ docs/UserShow404Response.md
71
+ docs/UserShow500Response.md
72
+ docs/UserUpdate200Response.md
73
+ docs/UserUpdate200ResponseUser.md
74
+ docs/UserUpdate404Response.md
75
+ docs/UserUpdate422Response.md
76
+ docs/UserUpdate500Response.md
77
+ docs/UserUpdateRequest.md
78
+ git_push.sh
79
+ index.ts
80
+ package.json
81
+ tsconfig.json
@@ -0,0 +1 @@
1
+ 7.13.0
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
package/README.md ADDED
@@ -0,0 +1,154 @@
1
+ ## @handsondigital/idplugger-admin@1.0.0
2
+
3
+ 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:
4
+
5
+ Environment
6
+ * Node.js
7
+ * Webpack
8
+ * Browserify
9
+
10
+ Language level
11
+ * ES5 - you must have a Promises/A+ library installed
12
+ * ES6
13
+
14
+ Module system
15
+ * CommonJS
16
+ * ES6 module system
17
+
18
+ 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))
19
+
20
+ ### Building
21
+
22
+ To build and compile the typescript sources to javascript use:
23
+ ```
24
+ npm install
25
+ npm run build
26
+ ```
27
+
28
+ ### Publishing
29
+
30
+ First build the package then run `npm publish`
31
+
32
+ ### Consuming
33
+
34
+ navigate to the folder of your consuming project and run one of the following commands.
35
+
36
+ _published:_
37
+
38
+ ```
39
+ npm install @handsondigital/idplugger-admin@1.0.0 --save
40
+ ```
41
+
42
+ _unPublished (not recommended):_
43
+
44
+ ```
45
+ npm install PATH_TO_GENERATED_PACKAGE --save
46
+ ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *https://api.idplugger.com*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *AuthApi* | [**adminAuthRequestToken**](docs/AuthApi.md#adminauthrequesttoken) | **POST** /admin/auth/request-token | Solicita envio de token de login por email
55
+ *AuthApi* | [**authLogin**](docs/AuthApi.md#authlogin) | **POST** /v3/login | Login na API
56
+ *AuthApi* | [**authLoginByToken**](docs/AuthApi.md#authloginbytoken) | **POST** /admin/auth/login | Login na API via e-mail e token
57
+ *AuthApi* | [**authMe**](docs/AuthApi.md#authme) | **GET** /v3/me | Dados na API
58
+ *AuthApi* | [**authRefreshToken**](docs/AuthApi.md#authrefreshtoken) | **POST** /admin/auth/refresh | Renova o do token de autenticação
59
+ *MetricsApi* | [**metrics**](docs/MetricsApi.md#metrics) | **GET** /v3/metrics | Devolve as métricas da promoção
60
+ *PromotionApi* | [**promotionPullConfiguration**](docs/PromotionApi.md#promotionpullconfiguration) | **POST** /v3/admin/pullconfiguration | Adicionar/Atualizar configurações de uma promoção ao orquestrador
61
+ *PromotionApi* | [**promotionStart**](docs/PromotionApi.md#promotionstart) | **POST** /v3/admin/promotion/start | Iniciar uma promoção na API
62
+ *RolesApi* | [**rolesAttachPermissions**](docs/RolesApi.md#rolesattachpermissions) | **POST** /v3/admin/roles/{id}/permissions | Atualizar permissões de uma role
63
+ *RolesApi* | [**rolesDestroy**](docs/RolesApi.md#rolesdestroy) | **DELETE** /v3/admin/roles/{id} | Remover role
64
+ *RolesApi* | [**rolesIndex**](docs/RolesApi.md#rolesindex) | **GET** /v3/admin/roles | Listar roles
65
+ *RolesApi* | [**rolesPermissions**](docs/RolesApi.md#rolespermissions) | **GET** /v3/admin/roles/{id}/permissions | Listar permissões de uma role
66
+ *RolesApi* | [**rolesShow**](docs/RolesApi.md#rolesshow) | **GET** /v3/admin/roles/{id} | Exibir detalhes da role
67
+ *RolesApi* | [**rolesStore**](docs/RolesApi.md#rolesstore) | **POST** /v3/admin/roles | Criar role
68
+ *RolesApi* | [**rolesUpdate**](docs/RolesApi.md#rolesupdate) | **PATCH** /v3/admin/roles/{id} | Atualizar role
69
+ *StepsApi* | [**stepsAllow**](docs/StepsApi.md#stepsallow) | **POST** /v3/steps/allow | Inclui uma Step em um determinado endpoint
70
+ *StepsApi* | [**stepsIndex**](docs/StepsApi.md#stepsindex) | **GET** /v3/steps | Retorna todas as steps existentes
71
+ *StepsApi* | [**stepsUnallow**](docs/StepsApi.md#stepsunallow) | **POST** /v3/steps/disallow | Remove uma Step de um determinado endpoint
72
+ *UserApi* | [**userGrantPermissions**](docs/UserApi.md#usergrantpermissions) | **POST** /v3/admin/user/grantpermissions | Dar permissões a um usuário na API
73
+ *UserApi* | [**userRegister**](docs/UserApi.md#userregister) | **POST** /v3/admin/user/register | Registrar usuário na API
74
+ *UserApi* | [**userShow**](docs/UserApi.md#usershow) | **GET** /v3/admin/user/{uuid} | Visualizar dados do usuário na API
75
+ *UserApi* | [**userUpdate**](docs/UserApi.md#userupdate) | **PATCH** /v3/admin/user/{uuid} | Atualizar nome do usuário na API
76
+
77
+
78
+ ### Documentation For Models
79
+
80
+ - [AdminAuthRequestToken200Response](docs/AdminAuthRequestToken200Response.md)
81
+ - [AdminAuthRequestTokenRequest](docs/AdminAuthRequestTokenRequest.md)
82
+ - [AuthLogin200Response](docs/AuthLogin200Response.md)
83
+ - [AuthLogin401Response](docs/AuthLogin401Response.md)
84
+ - [AuthLoginByToken200Response](docs/AuthLoginByToken200Response.md)
85
+ - [AuthLoginByTokenRequest](docs/AuthLoginByTokenRequest.md)
86
+ - [AuthLoginRequest](docs/AuthLoginRequest.md)
87
+ - [AuthMe200Response](docs/AuthMe200Response.md)
88
+ - [AuthMe200ResponsePromotionsInner](docs/AuthMe200ResponsePromotionsInner.md)
89
+ - [AuthRefreshTokenRequest](docs/AuthRefreshTokenRequest.md)
90
+ - [Metrics200Response](docs/Metrics200Response.md)
91
+ - [Metrics200ResponseUsersInner](docs/Metrics200ResponseUsersInner.md)
92
+ - [Metrics400Response](docs/Metrics400Response.md)
93
+ - [PromotionPullConfiguration200Response](docs/PromotionPullConfiguration200Response.md)
94
+ - [PromotionPullConfiguration500Response](docs/PromotionPullConfiguration500Response.md)
95
+ - [PromotionPullConfigurationRequest](docs/PromotionPullConfigurationRequest.md)
96
+ - [PromotionPullConfigurationRequestDb](docs/PromotionPullConfigurationRequestDb.md)
97
+ - [PromotionStart200Response](docs/PromotionStart200Response.md)
98
+ - [PromotionStart200ResponseUser](docs/PromotionStart200ResponseUser.md)
99
+ - [PromotionStartRequest](docs/PromotionStartRequest.md)
100
+ - [PromotionStartRequestUser](docs/PromotionStartRequestUser.md)
101
+ - [RolesAttachPermissions200Response](docs/RolesAttachPermissions200Response.md)
102
+ - [RolesAttachPermissions422Response](docs/RolesAttachPermissions422Response.md)
103
+ - [RolesAttachPermissionsRequest](docs/RolesAttachPermissionsRequest.md)
104
+ - [RolesDestroy400Response](docs/RolesDestroy400Response.md)
105
+ - [RolesIndex200Response](docs/RolesIndex200Response.md)
106
+ - [RolesIndex200ResponseRolesInner](docs/RolesIndex200ResponseRolesInner.md)
107
+ - [RolesIndex500Response](docs/RolesIndex500Response.md)
108
+ - [RolesPermissions200Response](docs/RolesPermissions200Response.md)
109
+ - [RolesShow200Response](docs/RolesShow200Response.md)
110
+ - [RolesShow200ResponsePermissionsInner](docs/RolesShow200ResponsePermissionsInner.md)
111
+ - [RolesShow200ResponseRole](docs/RolesShow200ResponseRole.md)
112
+ - [RolesStore201Response](docs/RolesStore201Response.md)
113
+ - [RolesStore201ResponseRole](docs/RolesStore201ResponseRole.md)
114
+ - [RolesStore422Response](docs/RolesStore422Response.md)
115
+ - [RolesStoreRequest](docs/RolesStoreRequest.md)
116
+ - [RolesUpdate200Response](docs/RolesUpdate200Response.md)
117
+ - [RolesUpdateRequest](docs/RolesUpdateRequest.md)
118
+ - [StepsAllow201Response](docs/StepsAllow201Response.md)
119
+ - [StepsAllow409Response](docs/StepsAllow409Response.md)
120
+ - [StepsAllowRequest](docs/StepsAllowRequest.md)
121
+ - [StepsIndex200Response](docs/StepsIndex200Response.md)
122
+ - [StepsIndex200ResponseStepsValueValue](docs/StepsIndex200ResponseStepsValueValue.md)
123
+ - [StepsUnallow201Response](docs/StepsUnallow201Response.md)
124
+ - [StepsUnallow409Response](docs/StepsUnallow409Response.md)
125
+ - [UserGrantPermissions200Response](docs/UserGrantPermissions200Response.md)
126
+ - [UserGrantPermissions200ResponseUserInner](docs/UserGrantPermissions200ResponseUserInner.md)
127
+ - [UserGrantPermissions500Response](docs/UserGrantPermissions500Response.md)
128
+ - [UserGrantPermissionsRequest](docs/UserGrantPermissionsRequest.md)
129
+ - [UserRegister200Response](docs/UserRegister200Response.md)
130
+ - [UserRegister200ResponseUserInner](docs/UserRegister200ResponseUserInner.md)
131
+ - [UserRegister500Response](docs/UserRegister500Response.md)
132
+ - [UserRegisterRequest](docs/UserRegisterRequest.md)
133
+ - [UserShow200Response](docs/UserShow200Response.md)
134
+ - [UserShow200ResponseUser](docs/UserShow200ResponseUser.md)
135
+ - [UserShow404Response](docs/UserShow404Response.md)
136
+ - [UserShow500Response](docs/UserShow500Response.md)
137
+ - [UserUpdate200Response](docs/UserUpdate200Response.md)
138
+ - [UserUpdate200ResponseUser](docs/UserUpdate200ResponseUser.md)
139
+ - [UserUpdate404Response](docs/UserUpdate404Response.md)
140
+ - [UserUpdate422Response](docs/UserUpdate422Response.md)
141
+ - [UserUpdate500Response](docs/UserUpdate500Response.md)
142
+ - [UserUpdateRequest](docs/UserUpdateRequest.md)
143
+
144
+
145
+ <a id="documentation-for-authorization"></a>
146
+ ## Documentation For Authorization
147
+
148
+
149
+ Authentication schemes defined for the API:
150
+ <a id="bearerAuth"></a>
151
+ ### bearerAuth
152
+
153
+ - **Type**: Bearer authentication (JWT)
154
+