auth0 4.0.0-beta.6 → 4.0.0-beta.7

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 (153) hide show
  1. package/README.md +11 -8
  2. package/dist/{types → cjs}/auth/base-auth-api.d.ts +9 -2
  3. package/dist/cjs/auth/base-auth-api.js +32 -4
  4. package/dist/cjs/auth/base-auth-api.js.map +1 -1
  5. package/dist/{types → cjs}/auth/client-authentication.d.ts +1 -1
  6. package/dist/cjs/auth/client-authentication.js +2 -3
  7. package/dist/cjs/auth/client-authentication.js.map +1 -1
  8. package/dist/{types → cjs}/auth/database.d.ts +4 -0
  9. package/dist/cjs/auth/database.js.map +1 -1
  10. package/dist/{types → cjs}/auth/oauth.d.ts +2 -8
  11. package/dist/cjs/auth/oauth.js +8 -35
  12. package/dist/cjs/auth/oauth.js.map +1 -1
  13. package/dist/{types → cjs}/auth/passwordless.d.ts +1 -1
  14. package/dist/cjs/auth/passwordless.js +16 -8
  15. package/dist/cjs/auth/passwordless.js.map +1 -1
  16. package/dist/{types → cjs}/index.d.ts +1 -0
  17. package/dist/cjs/index.js +1 -0
  18. package/dist/cjs/index.js.map +1 -1
  19. package/dist/{types → cjs}/lib/retry.d.ts +1 -1
  20. package/dist/cjs/lib/retry.js +2 -4
  21. package/dist/cjs/lib/retry.js.map +1 -1
  22. package/dist/{types → cjs}/lib/runtime.d.ts +1 -10
  23. package/dist/cjs/lib/runtime.js +3 -23
  24. package/dist/cjs/lib/runtime.js.map +1 -1
  25. package/dist/cjs/management/__generated/managers/jobs-manager.js +1 -1
  26. package/dist/cjs/management/__generated/managers/jobs-manager.js.map +1 -1
  27. package/dist/{types → cjs}/management/__generated/models/index.d.ts +1 -3
  28. package/dist/cjs/management/__generated/models/index.js.map +1 -1
  29. package/dist/cjs/version.d.ts +1 -0
  30. package/dist/cjs/version.js +1 -1
  31. package/dist/esm/auth/base-auth-api.d.ts +39 -0
  32. package/dist/esm/auth/base-auth-api.js +31 -4
  33. package/dist/esm/auth/base-auth-api.js.map +1 -1
  34. package/dist/esm/auth/client-authentication.d.ts +26 -0
  35. package/dist/esm/auth/client-authentication.js +2 -3
  36. package/dist/esm/auth/client-authentication.js.map +1 -1
  37. package/dist/esm/auth/database.d.ts +157 -0
  38. package/dist/esm/auth/database.js.map +1 -1
  39. package/dist/esm/auth/id-token-validator.d.ts +18 -0
  40. package/dist/esm/auth/index.d.ts +15 -0
  41. package/dist/esm/auth/oauth.d.ts +297 -0
  42. package/dist/esm/auth/oauth.js +10 -37
  43. package/dist/esm/auth/oauth.js.map +1 -1
  44. package/dist/esm/auth/passwordless.d.ts +165 -0
  45. package/dist/esm/auth/passwordless.js +17 -9
  46. package/dist/esm/auth/passwordless.js.map +1 -1
  47. package/dist/esm/index.d.ts +4 -0
  48. package/dist/esm/index.js +1 -0
  49. package/dist/esm/index.js.map +1 -1
  50. package/dist/esm/lib/errors.d.ts +33 -0
  51. package/dist/esm/lib/index.d.ts +3 -0
  52. package/dist/esm/lib/middleware/telemetry-middleware.d.ts +12 -0
  53. package/dist/esm/lib/models.d.ts +123 -0
  54. package/dist/esm/lib/retry.d.ts +26 -0
  55. package/dist/esm/lib/retry.js +2 -4
  56. package/dist/esm/lib/retry.js.map +1 -1
  57. package/dist/esm/lib/runtime.d.ts +61 -0
  58. package/dist/esm/lib/runtime.js +2 -21
  59. package/dist/esm/lib/runtime.js.map +1 -1
  60. package/dist/esm/management/__generated/index.d.ts +39 -0
  61. package/dist/esm/management/__generated/managers/actions-manager.d.ts +136 -0
  62. package/dist/esm/management/__generated/managers/anomaly-manager.d.ts +24 -0
  63. package/dist/esm/management/__generated/managers/attack-protection-manager.d.ts +58 -0
  64. package/dist/esm/management/__generated/managers/blacklists-manager.d.ts +28 -0
  65. package/dist/esm/management/__generated/managers/branding-manager.d.ts +103 -0
  66. package/dist/esm/management/__generated/managers/client-grants-manager.d.ts +42 -0
  67. package/dist/esm/management/__generated/managers/clients-manager.d.ts +168 -0
  68. package/dist/esm/management/__generated/managers/connections-manager.d.ts +87 -0
  69. package/dist/esm/management/__generated/managers/custom-domains-manager.d.ts +106 -0
  70. package/dist/esm/management/__generated/managers/device-credentials-manager.d.ts +42 -0
  71. package/dist/esm/management/__generated/managers/email-templates-manager.d.ts +38 -0
  72. package/dist/esm/management/__generated/managers/emails-manager.d.ts +40 -0
  73. package/dist/esm/management/__generated/managers/grants-manager.d.ts +34 -0
  74. package/dist/esm/management/__generated/managers/guardian-manager.d.ts +240 -0
  75. package/dist/esm/management/__generated/managers/hooks-manager.d.ts +90 -0
  76. package/dist/esm/management/__generated/managers/index.d.ts +31 -0
  77. package/dist/esm/management/__generated/managers/jobs-manager.d.ts +47 -0
  78. package/dist/esm/management/__generated/managers/jobs-manager.js +1 -1
  79. package/dist/esm/management/__generated/managers/jobs-manager.js.map +1 -1
  80. package/dist/esm/management/__generated/managers/keys-manager.d.ts +34 -0
  81. package/dist/esm/management/__generated/managers/log-streams-manager.d.ts +326 -0
  82. package/dist/esm/management/__generated/managers/logs-manager.d.ts +56 -0
  83. package/dist/esm/management/__generated/managers/organizations-manager.d.ts +191 -0
  84. package/dist/esm/management/__generated/managers/prompts-manager.d.ts +42 -0
  85. package/dist/esm/management/__generated/managers/resource-servers-manager.d.ts +48 -0
  86. package/dist/esm/management/__generated/managers/roles-manager.d.ts +110 -0
  87. package/dist/esm/management/__generated/managers/rules-configs-manager.d.ts +33 -0
  88. package/dist/esm/management/__generated/managers/rules-manager.d.ts +55 -0
  89. package/dist/esm/management/__generated/managers/stats-manager.d.ts +24 -0
  90. package/dist/esm/management/__generated/managers/tenants-manager.d.ts +24 -0
  91. package/dist/esm/management/__generated/managers/tickets-manager.d.ts +24 -0
  92. package/dist/esm/management/__generated/managers/user-blocks-manager.d.ts +45 -0
  93. package/dist/esm/management/__generated/managers/users-by-email-manager.d.ts +22 -0
  94. package/dist/esm/management/__generated/managers/users-manager.d.ts +329 -0
  95. package/dist/esm/management/__generated/models/index.d.ts +13201 -0
  96. package/dist/esm/management/__generated/models/index.js.map +1 -1
  97. package/dist/esm/management/index.d.ts +3 -0
  98. package/dist/esm/management/management-client-options.d.ts +17 -0
  99. package/dist/esm/management/management-client.d.ts +16 -0
  100. package/dist/esm/management/token-provider-middleware.d.ts +7 -0
  101. package/dist/esm/management/token-provider.d.ts +21 -0
  102. package/dist/esm/userinfo/index.d.ts +55 -0
  103. package/dist/esm/utils.d.ts +10 -0
  104. package/dist/esm/version.d.ts +1 -0
  105. package/dist/esm/version.js +1 -1
  106. package/package.json +16 -20
  107. package/dist/types/version.d.ts +0 -1
  108. /package/dist/{types → cjs}/auth/id-token-validator.d.ts +0 -0
  109. /package/dist/{types → cjs}/auth/index.d.ts +0 -0
  110. /package/dist/{types → cjs}/lib/errors.d.ts +0 -0
  111. /package/dist/{types → cjs}/lib/index.d.ts +0 -0
  112. /package/dist/{types → cjs}/lib/middleware/telemetry-middleware.d.ts +0 -0
  113. /package/dist/{types → cjs}/lib/models.d.ts +0 -0
  114. /package/dist/{types → cjs}/management/__generated/index.d.ts +0 -0
  115. /package/dist/{types → cjs}/management/__generated/managers/actions-manager.d.ts +0 -0
  116. /package/dist/{types → cjs}/management/__generated/managers/anomaly-manager.d.ts +0 -0
  117. /package/dist/{types → cjs}/management/__generated/managers/attack-protection-manager.d.ts +0 -0
  118. /package/dist/{types → cjs}/management/__generated/managers/blacklists-manager.d.ts +0 -0
  119. /package/dist/{types → cjs}/management/__generated/managers/branding-manager.d.ts +0 -0
  120. /package/dist/{types → cjs}/management/__generated/managers/client-grants-manager.d.ts +0 -0
  121. /package/dist/{types → cjs}/management/__generated/managers/clients-manager.d.ts +0 -0
  122. /package/dist/{types → cjs}/management/__generated/managers/connections-manager.d.ts +0 -0
  123. /package/dist/{types → cjs}/management/__generated/managers/custom-domains-manager.d.ts +0 -0
  124. /package/dist/{types → cjs}/management/__generated/managers/device-credentials-manager.d.ts +0 -0
  125. /package/dist/{types → cjs}/management/__generated/managers/email-templates-manager.d.ts +0 -0
  126. /package/dist/{types → cjs}/management/__generated/managers/emails-manager.d.ts +0 -0
  127. /package/dist/{types → cjs}/management/__generated/managers/grants-manager.d.ts +0 -0
  128. /package/dist/{types → cjs}/management/__generated/managers/guardian-manager.d.ts +0 -0
  129. /package/dist/{types → cjs}/management/__generated/managers/hooks-manager.d.ts +0 -0
  130. /package/dist/{types → cjs}/management/__generated/managers/index.d.ts +0 -0
  131. /package/dist/{types → cjs}/management/__generated/managers/jobs-manager.d.ts +0 -0
  132. /package/dist/{types → cjs}/management/__generated/managers/keys-manager.d.ts +0 -0
  133. /package/dist/{types → cjs}/management/__generated/managers/log-streams-manager.d.ts +0 -0
  134. /package/dist/{types → cjs}/management/__generated/managers/logs-manager.d.ts +0 -0
  135. /package/dist/{types → cjs}/management/__generated/managers/organizations-manager.d.ts +0 -0
  136. /package/dist/{types → cjs}/management/__generated/managers/prompts-manager.d.ts +0 -0
  137. /package/dist/{types → cjs}/management/__generated/managers/resource-servers-manager.d.ts +0 -0
  138. /package/dist/{types → cjs}/management/__generated/managers/roles-manager.d.ts +0 -0
  139. /package/dist/{types → cjs}/management/__generated/managers/rules-configs-manager.d.ts +0 -0
  140. /package/dist/{types → cjs}/management/__generated/managers/rules-manager.d.ts +0 -0
  141. /package/dist/{types → cjs}/management/__generated/managers/stats-manager.d.ts +0 -0
  142. /package/dist/{types → cjs}/management/__generated/managers/tenants-manager.d.ts +0 -0
  143. /package/dist/{types → cjs}/management/__generated/managers/tickets-manager.d.ts +0 -0
  144. /package/dist/{types → cjs}/management/__generated/managers/user-blocks-manager.d.ts +0 -0
  145. /package/dist/{types → cjs}/management/__generated/managers/users-by-email-manager.d.ts +0 -0
  146. /package/dist/{types → cjs}/management/__generated/managers/users-manager.d.ts +0 -0
  147. /package/dist/{types → cjs}/management/index.d.ts +0 -0
  148. /package/dist/{types → cjs}/management/management-client-options.d.ts +0 -0
  149. /package/dist/{types → cjs}/management/management-client.d.ts +0 -0
  150. /package/dist/{types → cjs}/management/token-provider-middleware.d.ts +0 -0
  151. /package/dist/{types → cjs}/management/token-provider.d.ts +0 -0
  152. /package/dist/{types → cjs}/userinfo/index.d.ts +0 -0
  153. /package/dist/{types → cjs}/utils.d.ts +0 -0
@@ -0,0 +1,326 @@
1
+ import * as runtime from '../../../lib/runtime.js';
2
+ import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
3
+ import type { GetLogStreams200ResponseInner, PatchLogStreamsByIdRequest, PostLogStreamsRequest, DeleteLogStreamsByIdRequest, GetLogStreamsByIdRequest, PatchLogStreamsByIdOperationRequest } from '../models/index.js';
4
+ declare const BaseAPI: typeof runtime.BaseAPI;
5
+ /**
6
+ *
7
+ */
8
+ export declare class LogStreamsManager extends BaseAPI {
9
+ /**
10
+ * Delete a log stream.
11
+ *
12
+ * Delete log stream
13
+ *
14
+ * @throws {RequiredError}
15
+ */
16
+ delete(requestParameters: DeleteLogStreamsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
17
+ /**
18
+ * Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
19
+ * <h5>Sample Response</h5><pre><code>[{
20
+ * "id": "string",
21
+ * "name": "string",
22
+ * "type": "eventbridge",
23
+ * "status": "active|paused|suspended",
24
+ * "sink": {
25
+ * "awsAccountId": "string",
26
+ * "awsRegion": "string",
27
+ * "awsPartnerEventSource": "string"
28
+ * }
29
+ * }, {
30
+ * "id": "string",
31
+ * "name": "string",
32
+ * "type": "http",
33
+ * "status": "active|paused|suspended",
34
+ * "sink": {
35
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
36
+ * "httpContentType": "string",
37
+ * "httpEndpoint": "string",
38
+ * "httpAuthorization": "string"
39
+ * }
40
+ * },
41
+ * {
42
+ * "id": "string",
43
+ * "name": "string",
44
+ * "type": "eventgrid",
45
+ * "status": "active|paused|suspended",
46
+ * "sink": {
47
+ * "azureSubscriptionId": "string",
48
+ * "azureResourceGroup": "string",
49
+ * "azureRegion": "string",
50
+ * "azurePartnerTopic": "string"
51
+ * }
52
+ * },
53
+ * {
54
+ * "id": "string",
55
+ * "name": "string",
56
+ * "type": "splunk",
57
+ * "status": "active|paused|suspended",
58
+ * "sink": {
59
+ * "splunkDomain": "string",
60
+ * "splunkToken": "string",
61
+ * "splunkPort": "string",
62
+ * "splunkSecure": "boolean"
63
+ * }
64
+ * },
65
+ * {
66
+ * "id": "string",
67
+ * "name": "string",
68
+ * "type": "sumo",
69
+ * "status": "active|paused|suspended",
70
+ * "sink": {
71
+ * "sumoSourceAddress": "string",
72
+ * }
73
+ * },
74
+ * {
75
+ * "id": "string",
76
+ * "name": "string",
77
+ * "type": "datadog",
78
+ * "status": "active|paused|suspended",
79
+ * "sink": {
80
+ * "datadogRegion": "string",
81
+ * "datadogApiKey": "string"
82
+ * }
83
+ * }]</code></pre>
84
+ *
85
+ * Get log streams
86
+ *
87
+ * @throws {RequiredError}
88
+ */
89
+ getAll(initOverrides?: InitOverride): Promise<ApiResponse<Array<GetLogStreams200ResponseInner>>>;
90
+ /**
91
+ * Retrieve a log stream configuration and status.
92
+ * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
93
+ * "id": "string",
94
+ * "name": "string",
95
+ * "type": "eventbridge",
96
+ * "status": "active|paused|suspended",
97
+ * "sink": {
98
+ * "awsAccountId": "string",
99
+ * "awsRegion": "string",
100
+ * "awsPartnerEventSource": "string"
101
+ * }
102
+ * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
103
+ * "id": "string",
104
+ * "name": "string",
105
+ * "type": "http",
106
+ * "status": "active|paused|suspended",
107
+ * "sink": {
108
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
109
+ * "httpContentType": "string",
110
+ * "httpEndpoint": "string",
111
+ * "httpAuthorization": "string"
112
+ * }
113
+ * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
114
+ * "id": "string",
115
+ * "name": "string",
116
+ * "type": "datadog",
117
+ * "status": "active|paused|suspended",
118
+ * "sink": {
119
+ * "datadogRegion": "string",
120
+ * "datadogApiKey": "string"
121
+ * }
122
+ * }</code></pre> <h5>Splunk Log Stream</h5><pre><code>{
123
+ * "id": "string",
124
+ * "name": "string",
125
+ * "type": "splunk",
126
+ * "status": "active|paused|suspended",
127
+ * "sink": {
128
+ * "splunkDomain": "string",
129
+ * "splunkToken": "string",
130
+ * "splunkPort": "string",
131
+ * "splunkSecure": "boolean"
132
+ * }
133
+ * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
134
+ * "id": "string",
135
+ * "name": "string",
136
+ * "type": "sumo",
137
+ * "status": "active|paused|suspended",
138
+ * "sink": {
139
+ * "sumoSourceAddress": "string",
140
+ * }
141
+ * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
142
+ * 1. <code>active</code> - Stream is currently enabled.
143
+ * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
144
+ * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
145
+ *
146
+ * Get log stream by ID
147
+ *
148
+ * @throws {RequiredError}
149
+ */
150
+ get(requestParameters: GetLogStreamsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetLogStreams200ResponseInner>>;
151
+ /**
152
+ * Update a log stream.
153
+ * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
154
+ * <h5>Update the status of a log stream</h5><pre><code>{
155
+ * "status": "active|paused"
156
+ * }</code></pre>
157
+ * <h5>Update the name of a log stream</h5><pre><code>{
158
+ * "name": "string"
159
+ * }</code></pre>
160
+ * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
161
+ * "sink": {
162
+ * "httpEndpoint": "string",
163
+ * "httpContentType": "string",
164
+ * "httpContentFormat": "JSONARRAY|JSONLINES",
165
+ * "httpAuthorization": "string"
166
+ * }
167
+ * }</code></pre>
168
+ * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
169
+ * "sink": {
170
+ * "datadogRegion": "string",
171
+ * "datadogApiKey": "string"
172
+ * }
173
+ * }</code></pre>
174
+ * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
175
+ * "sink": {
176
+ * "splunkDomain": "string",
177
+ * "splunkToken": "string",
178
+ * "splunkPort": "string",
179
+ * "splunkSecure": "boolean"
180
+ * }
181
+ * }</code></pre>
182
+ * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
183
+ * "sink": {
184
+ * "sumoSourceAddress": "string"
185
+ * }
186
+ * }</code></pre>
187
+ * Update a log stream
188
+ *
189
+ * @throws {RequiredError}
190
+ */
191
+ update(requestParameters: PatchLogStreamsByIdOperationRequest, bodyParameters: PatchLogStreamsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetLogStreams200ResponseInner>>;
192
+ /**
193
+ * Create a log stream.
194
+ * <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
195
+ * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
196
+ * Request: <pre><code>{
197
+ * "name": "string",
198
+ * "type": "http",
199
+ * "sink": {
200
+ * "httpEndpoint": "string",
201
+ * "httpContentType": "string",
202
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
203
+ * "httpAuthorization": "string"
204
+ * }
205
+ * }</code></pre>
206
+ * Response: <pre><code>{
207
+ * "id": "string",
208
+ * "name": "string",
209
+ * "type": "http",
210
+ * "status": "active",
211
+ * "sink": {
212
+ * "httpEndpoint": "string",
213
+ * "httpContentType": "string",
214
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
215
+ * "httpAuthorization": "string"
216
+ * }
217
+ * }</code></pre>
218
+ * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
219
+ * Request: <pre><code>{
220
+ * "name": "string",
221
+ * "type": "eventbridge",
222
+ * "sink": {
223
+ * "awsRegion": "string",
224
+ * "awsAccountId": "string"
225
+ * }
226
+ * }</code></pre>
227
+ * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
228
+ * "id": "string",
229
+ * "name": "string",
230
+ * "type": "eventbridge",
231
+ * "status": "active",
232
+ * "sink": {
233
+ * "awsAccountId": "string",
234
+ * "awsRegion": "string",
235
+ * "awsPartnerEventSource": "string"
236
+ * }
237
+ * }</code></pre>
238
+ * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
239
+ * Request: <pre><code>{
240
+ * "name": "string",
241
+ * "type": "eventgrid",
242
+ * "sink": {
243
+ * "azureSubscriptionId": "string",
244
+ * "azureResourceGroup": "string",
245
+ * "azureRegion": "string"
246
+ * }
247
+ * }</code></pre>
248
+ * Response: <pre><code>{
249
+ * "id": "string",
250
+ * "name": "string",
251
+ * "type": "http",
252
+ * "status": "active",
253
+ * "sink": {
254
+ * "azureSubscriptionId": "string",
255
+ * "azureResourceGroup": "string",
256
+ * "azureRegion": "string",
257
+ * "azurePartnerTopic": "string"
258
+ * }
259
+ * }</code></pre>
260
+ * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
261
+ * Request: <pre><code>{
262
+ * "name": "string",
263
+ * "type": "datadog",
264
+ * "sink": {
265
+ * "datadogRegion": "string",
266
+ * "datadogApiKey": "string"
267
+ * }
268
+ * }</code></pre>
269
+ * Response: <pre><code>{
270
+ * "id": "string",
271
+ * "name": "string",
272
+ * "type": "datadog",
273
+ * "status": "active",
274
+ * "sink": {
275
+ * "datadogRegion": "string",
276
+ * "datadogApiKey": "string"
277
+ * }
278
+ * }</code></pre>
279
+ * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
280
+ * Request: <pre><code>{
281
+ * "name": "string",
282
+ * "type": "splunk",
283
+ * "sink": {
284
+ * "splunkDomain": "string",
285
+ * "splunkToken": "string",
286
+ * "splunkPort": "string",
287
+ * "splunkSecure": "boolean"
288
+ * }
289
+ * }</code></pre>
290
+ * Response: <pre><code>{
291
+ * "id": "string",
292
+ * "name": "string",
293
+ * "type": "splunk",
294
+ * "status": "active",
295
+ * "sink": {
296
+ * "splunkDomain": "string",
297
+ * "splunkToken": "string",
298
+ * "splunkPort": "string",
299
+ * "splunkSecure": "boolean"
300
+ * }
301
+ * }</code></pre>
302
+ * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
303
+ * Request: <pre><code>{
304
+ * "name": "string",
305
+ * "type": "sumo",
306
+ * "sink": {
307
+ * "sumoSourceAddress": "string",
308
+ * }
309
+ * }</code></pre>
310
+ * Response: <pre><code>{
311
+ * "id": "string",
312
+ * "name": "string",
313
+ * "type": "sumo",
314
+ * "status": "active",
315
+ * "sink": {
316
+ * "sumoSourceAddress": "string",
317
+ * }
318
+ * }</code></pre>
319
+ *
320
+ * Create a log stream
321
+ *
322
+ * @throws {RequiredError}
323
+ */
324
+ create(bodyParameters: PostLogStreamsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetLogStreams200ResponseInner>>;
325
+ }
326
+ export {};
@@ -0,0 +1,56 @@
1
+ import * as runtime from '../../../lib/runtime.js';
2
+ import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
3
+ import type { Log, GetLogs200ResponseOneOf, GetLogsRequest, GetLogsByIdRequest } from '../models/index.js';
4
+ declare const BaseAPI: typeof runtime.BaseAPI;
5
+ /**
6
+ *
7
+ */
8
+ export declare class LogsManager extends BaseAPI {
9
+ /**
10
+ * Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
11
+ *
12
+ * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
13
+ *
14
+ * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
15
+ *
16
+ * <h5>To set custom search criteria, use the following parameters:</h5>
17
+ *
18
+ * <ul>
19
+ * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
20
+ * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
21
+ * <li><b>per_page:</b> Number of results per page.</li>
22
+ * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
23
+ * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
24
+ * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
25
+ * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
26
+ * </ul>
27
+ *
28
+ * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
29
+ *
30
+ * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
31
+ *
32
+ * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
33
+ * <ul>
34
+ * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
35
+ * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
36
+ * </ul>
37
+ *
38
+ * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
39
+ *
40
+ * Search log events
41
+ *
42
+ * @throws {RequiredError}
43
+ */
44
+ getAll(requestParameters: GetLogsRequest & {
45
+ include_totals: true;
46
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetLogs200ResponseOneOf>>;
47
+ getAll(requestParameters?: GetLogsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Log>>>;
48
+ /**
49
+ * Retrieve an individual log event.
50
+ * Get a log event by id
51
+ *
52
+ * @throws {RequiredError}
53
+ */
54
+ get(requestParameters: GetLogsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Log>>;
55
+ }
56
+ export {};
@@ -0,0 +1,191 @@
1
+ import * as runtime from '../../../lib/runtime.js';
2
+ import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
3
+ import type { DeleteMembersRequest, DeleteOrganizationMemberRolesRequest, GetEnabledConnections200ResponseOneOfInner, GetInvitations200ResponseOneOfInner, GetOrganizations200ResponseOneOfInner, PatchEnabledConnectionsByConnectionIdRequest, PatchOrganizationsByIdRequest, PostEnabledConnectionsRequest, PostInvitationsRequest, PostMembersRequest, PostOrganizationMemberRolesRequest, PostOrganizationsRequest, GetEnabledConnections200ResponseOneOf, GetInvitations200ResponseOneOf, GetMembers200ResponseOneOf, GetMembers200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetOrganizations200ResponseOneOf, DeleteEnabledConnectionsByConnectionIdRequest, DeleteInvitationsByInvitationIdRequest, DeleteMembersOperationRequest, DeleteOrganizationMemberRolesOperationRequest, DeleteOrganizationsByIdRequest, GetEnabledConnectionsRequest, GetEnabledConnectionsByConnectionIdRequest, GetInvitationsRequest, GetInvitationsByInvitationIdRequest, GetMembersRequest, GetNameByNameRequest, GetOrganizationMemberRolesRequest, GetOrganizationsRequest, GetOrganizationsByIdRequest, PatchEnabledConnectionsByConnectionIdOperationRequest, PatchOrganizationsByIdOperationRequest, PostEnabledConnectionsOperationRequest, PostInvitationsOperationRequest, PostMembersOperationRequest, PostOrganizationMemberRolesOperationRequest } from '../models/index.js';
4
+ declare const BaseAPI: typeof runtime.BaseAPI;
5
+ /**
6
+ *
7
+ */
8
+ export declare class OrganizationsManager extends BaseAPI {
9
+ /**
10
+ * Delete connections from an organization
11
+ *
12
+ * @throws {RequiredError}
13
+ */
14
+ deleteEnabledConnection(requestParameters: DeleteEnabledConnectionsByConnectionIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
15
+ /**
16
+ * Delete an invitation to organization
17
+ *
18
+ * @throws {RequiredError}
19
+ */
20
+ deleteInvitation(requestParameters: DeleteInvitationsByInvitationIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
21
+ /**
22
+ * Delete members from an organization
23
+ *
24
+ * @throws {RequiredError}
25
+ */
26
+ deleteMembers(requestParameters: DeleteMembersOperationRequest, bodyParameters: DeleteMembersRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
27
+ /**
28
+ * Remove one or more roles from a given user in the context of the provided organization
29
+ *
30
+ * @throws {RequiredError}
31
+ */
32
+ deleteMemberRoles(requestParameters: DeleteOrganizationMemberRolesOperationRequest, bodyParameters: DeleteOrganizationMemberRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
33
+ /**
34
+ * Delete a specific organization
35
+ *
36
+ * Delete organization
37
+ *
38
+ * @throws {RequiredError}
39
+ */
40
+ delete(requestParameters: DeleteOrganizationsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
41
+ /**
42
+ * Get connections enabled for an organization
43
+ *
44
+ * @throws {RequiredError}
45
+ */
46
+ getEnabledConnections(requestParameters: GetEnabledConnectionsRequest & {
47
+ include_totals: true;
48
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOf>>;
49
+ getEnabledConnections(requestParameters?: GetEnabledConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetEnabledConnections200ResponseOneOfInner>>>;
50
+ /**
51
+ * Get an enabled connection for an organization
52
+ *
53
+ * @throws {RequiredError}
54
+ */
55
+ getEnabledConnection(requestParameters: GetEnabledConnectionsByConnectionIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOfInner>>;
56
+ /**
57
+ * Get invitations to organization
58
+ *
59
+ * @throws {RequiredError}
60
+ */
61
+ getInvitations(requestParameters: GetInvitationsRequest & {
62
+ include_totals: true;
63
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetInvitations200ResponseOneOf>>;
64
+ getInvitations(requestParameters?: GetInvitationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetInvitations200ResponseOneOfInner>>>;
65
+ /**
66
+ * Get an invitation to organization
67
+ *
68
+ * @throws {RequiredError}
69
+ */
70
+ getInvitation(requestParameters: GetInvitationsByInvitationIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetInvitations200ResponseOneOfInner>>;
71
+ /**
72
+ * List organization members. This endpoint supports two types of pagination:
73
+ * - Offset pagination
74
+ * - Checkpoint pagination
75
+ *
76
+ * Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.
77
+ *
78
+ * <h2>Checkpoint Pagination</h2>
79
+ *
80
+ * To search by checkpoint, use the following parameters:
81
+ * - from: Optional id from which to start selection.
82
+ * - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
83
+ *
84
+ * Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter. If there are more results, a <code>next</code> value will be included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
85
+ *
86
+ * Get members who belong to an organization
87
+ *
88
+ * @throws {RequiredError}
89
+ */
90
+ getMembers(requestParameters: GetMembersRequest & {
91
+ include_totals: true;
92
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetMembers200ResponseOneOf>>;
93
+ getMembers(requestParameters?: GetMembersRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetMembers200ResponseOneOfInner>>>;
94
+ /**
95
+ * Get a specific organization by name
96
+ *
97
+ * Get organization by name
98
+ *
99
+ * @throws {RequiredError}
100
+ */
101
+ getByName(requestParameters: GetNameByNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
102
+ /**
103
+ * Get the roles assigned to an organization member
104
+ *
105
+ * @throws {RequiredError}
106
+ */
107
+ getMemberRoles(requestParameters: GetOrganizationMemberRolesRequest & {
108
+ include_totals: true;
109
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOf>>;
110
+ getMemberRoles(requestParameters?: GetOrganizationMemberRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizationMemberRoles200ResponseOneOfInner>>>;
111
+ /**
112
+ * List available organizations. This endpoint supports two types of pagination:
113
+ * - Offset pagination
114
+ * - Checkpoint pagination
115
+ *
116
+ * Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
117
+ *
118
+ * <h2>Checkpoint Pagination</h2>
119
+ *
120
+ * To search by checkpoint, use the following parameters:
121
+ * - from: Optional id from which to start selection.
122
+ * - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
123
+ *
124
+ * Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter. If there are more results, a <code>next</code> value will be included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
125
+ *
126
+ * Get organizations
127
+ *
128
+ * @throws {RequiredError}
129
+ */
130
+ getAll(requestParameters: GetOrganizationsRequest & {
131
+ include_totals: true;
132
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOf>>;
133
+ getAll(requestParameters?: GetOrganizationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizations200ResponseOneOfInner>>>;
134
+ /**
135
+ * Get a specific organization
136
+ *
137
+ * Get organization
138
+ *
139
+ * @throws {RequiredError}
140
+ */
141
+ get(requestParameters: GetOrganizationsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
142
+ /**
143
+ * Modify an enabled_connection belonging to an Organization.
144
+ *
145
+ * Modify an Organizations Connection
146
+ *
147
+ * @throws {RequiredError}
148
+ */
149
+ updateEnabledConnection(requestParameters: PatchEnabledConnectionsByConnectionIdOperationRequest, bodyParameters: PatchEnabledConnectionsByConnectionIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOfInner>>;
150
+ /**
151
+ * Modify an organization
152
+ *
153
+ * Modify an Organization
154
+ *
155
+ * @throws {RequiredError}
156
+ */
157
+ update(requestParameters: PatchOrganizationsByIdOperationRequest, bodyParameters: PatchOrganizationsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
158
+ /**
159
+ * Add connections to an organization
160
+ *
161
+ * @throws {RequiredError}
162
+ */
163
+ addEnabledConnection(requestParameters: PostEnabledConnectionsOperationRequest, bodyParameters: PostEnabledConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOfInner>>;
164
+ /**
165
+ * Create invitations to organization
166
+ *
167
+ * @throws {RequiredError}
168
+ */
169
+ createInvitation(requestParameters: PostInvitationsOperationRequest, bodyParameters: PostInvitationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetInvitations200ResponseOneOfInner>>;
170
+ /**
171
+ * Add members to an organization
172
+ *
173
+ * @throws {RequiredError}
174
+ */
175
+ addMembers(requestParameters: PostMembersOperationRequest, bodyParameters: PostMembersRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
176
+ /**
177
+ * Assign one or more roles to a given user that will be applied in the context of the provided organization
178
+ *
179
+ * @throws {RequiredError}
180
+ */
181
+ addMemberRoles(requestParameters: PostOrganizationMemberRolesOperationRequest, bodyParameters: PostOrganizationMemberRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
182
+ /**
183
+ * Create an organization
184
+ *
185
+ * Create an Organization
186
+ *
187
+ * @throws {RequiredError}
188
+ */
189
+ create(bodyParameters: PostOrganizationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
190
+ }
191
+ export {};
@@ -0,0 +1,42 @@
1
+ import * as runtime from '../../../lib/runtime.js';
2
+ import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
3
+ import type { PromptsSettings, PromptsSettingsUpdate, GetCustomTextByLanguageRequest, PutCustomTextByLanguageRequest } from '../models/index.js';
4
+ declare const BaseAPI: typeof runtime.BaseAPI;
5
+ /**
6
+ *
7
+ */
8
+ export declare class PromptsManager extends BaseAPI {
9
+ /**
10
+ * Retrieve custom text for a specific prompt and language.
11
+ * Get custom text for a prompt
12
+ *
13
+ * @throws {RequiredError}
14
+ */
15
+ getCustomTextByLanguage(requestParameters: GetCustomTextByLanguageRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
16
+ [key: string]: any;
17
+ }>>;
18
+ /**
19
+ * Retrieve prompts settings.
20
+ * Get prompts settings
21
+ *
22
+ * @throws {RequiredError}
23
+ */
24
+ get(initOverrides?: InitOverride): Promise<ApiResponse<PromptsSettings>>;
25
+ /**
26
+ * Update prompts settings.
27
+ * Update prompts settings
28
+ *
29
+ * @throws {RequiredError}
30
+ */
31
+ update(bodyParameters: PromptsSettingsUpdate, initOverrides?: InitOverride): Promise<ApiResponse<PromptsSettings>>;
32
+ /**
33
+ * Set custom text for a specific prompt. Existing texts will be overwritten.
34
+ * Set custom text for a specific prompt
35
+ *
36
+ * @throws {RequiredError}
37
+ */
38
+ updateCustomTextByLanguage(requestParameters: PutCustomTextByLanguageRequest, bodyParameters: {
39
+ [key: string]: any;
40
+ }, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
41
+ }
42
+ export {};
@@ -0,0 +1,48 @@
1
+ import * as runtime from '../../../lib/runtime.js';
2
+ import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
3
+ import type { PostResourceServersRequest, ResourceServer, ResourceServerUpdate, GetResourceServers200ResponseOneOf, DeleteResourceServersByIdRequest, GetResourceServersRequest, GetResourceServersByIdRequest, PatchResourceServersByIdRequest } from '../models/index.js';
4
+ declare const BaseAPI: typeof runtime.BaseAPI;
5
+ /**
6
+ *
7
+ */
8
+ export declare class ResourceServersManager extends BaseAPI {
9
+ /**
10
+ * Delete an existing API (also known as a resource server).
11
+ * Delete a resource server
12
+ *
13
+ * @throws {RequiredError}
14
+ */
15
+ delete(requestParameters: DeleteResourceServersByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
16
+ /**
17
+ * Retrieve <a href="https://auth0.com/docs/apis">APIs</a> (also known as resource servers) that you can consume from your authorized applications.
18
+ * Get resource servers
19
+ *
20
+ * @throws {RequiredError}
21
+ */
22
+ getAll(requestParameters: GetResourceServersRequest & {
23
+ include_totals: true;
24
+ }, initOverrides?: InitOverride): Promise<ApiResponse<GetResourceServers200ResponseOneOf>>;
25
+ getAll(requestParameters?: GetResourceServersRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<ResourceServer>>>;
26
+ /**
27
+ * Retrieve an <a href="https://auth0.com/docs/apis">API</a> (also known as resource server).
28
+ * Get a resource server
29
+ *
30
+ * @throws {RequiredError}
31
+ */
32
+ get(requestParameters: GetResourceServersByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<ResourceServer>>;
33
+ /**
34
+ * Update an existing API (also known as a resource server).
35
+ * Update a resource server
36
+ *
37
+ * @throws {RequiredError}
38
+ */
39
+ update(requestParameters: PatchResourceServersByIdRequest, bodyParameters: ResourceServerUpdate, initOverrides?: InitOverride): Promise<ApiResponse<ResourceServer>>;
40
+ /**
41
+ * Create a new API (also known as a resource server).
42
+ * Create a resource server
43
+ *
44
+ * @throws {RequiredError}
45
+ */
46
+ create(bodyParameters: PostResourceServersRequest, initOverrides?: InitOverride): Promise<ApiResponse<ResourceServer>>;
47
+ }
48
+ export {};