auth0 5.6.0 → 5.8.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 (28) hide show
  1. package/dist/cjs/management/api/requests/requests.d.ts +41 -2
  2. package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +2 -1
  3. package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -2
  4. package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.ts +43 -0
  5. package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.js +152 -0
  6. package/dist/cjs/management/api/resources/eventStreams/client/Client.d.ts +1 -1
  7. package/dist/cjs/management/api/resources/eventStreams/client/Client.js +1 -1
  8. package/dist/cjs/management/api/resources/logStreams/client/Client.d.ts +465 -300
  9. package/dist/cjs/management/api/resources/logStreams/client/Client.js +465 -300
  10. package/dist/cjs/management/api/types/types.d.ts +200 -37
  11. package/dist/cjs/management/api/types/types.js +104 -46
  12. package/dist/cjs/management/version.d.ts +1 -1
  13. package/dist/cjs/management/version.js +1 -1
  14. package/dist/esm/management/api/requests/requests.d.mts +41 -2
  15. package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +2 -1
  16. package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -2
  17. package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.mts +43 -0
  18. package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.mjs +152 -0
  19. package/dist/esm/management/api/resources/eventStreams/client/Client.d.mts +1 -1
  20. package/dist/esm/management/api/resources/eventStreams/client/Client.mjs +1 -1
  21. package/dist/esm/management/api/resources/logStreams/client/Client.d.mts +465 -300
  22. package/dist/esm/management/api/resources/logStreams/client/Client.mjs +465 -300
  23. package/dist/esm/management/api/types/types.d.mts +200 -37
  24. package/dist/esm/management/api/types/types.mjs +94 -36
  25. package/dist/esm/management/version.d.mts +1 -1
  26. package/dist/esm/management/version.mjs +1 -1
  27. package/package.json +1 -1
  28. package/reference.md +673 -323
package/dist/esm/management/api/resources/logStreams/client/Client.d.mts CHANGED
@@ -11,72 +11,77 @@ export declare class LogStreamsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<LogStreamsClient.Options>;
12
12
  constructor(options: LogStreamsClient.Options);
13
13
  /**
14
- * Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
15
- * <h5>Sample Response</h5><pre><code>[{
16
- * "id": "string",
17
- * "name": "string",
18
- * "type": "eventbridge",
19
- * "status": "active|paused|suspended",
20
- * "sink": {
21
- * "awsAccountId": "string",
22
- * "awsRegion": "string",
23
- * "awsPartnerEventSource": "string"
24
- * }
14
+ * Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
15
+ *
16
+ * **Sample Response**
17
+ *
18
+ * ```json
19
+ * [{
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
+ * }
25
29
  * }, {
26
- * "id": "string",
27
- * "name": "string",
28
- * "type": "http",
29
- * "status": "active|paused|suspended",
30
- * "sink": {
31
- * "httpContentFormat": "JSONLINES|JSONARRAY",
32
- * "httpContentType": "string",
33
- * "httpEndpoint": "string",
34
- * "httpAuthorization": "string"
35
- * }
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
+ * }
36
40
  * },
37
41
  * {
38
- * "id": "string",
39
- * "name": "string",
40
- * "type": "eventgrid",
41
- * "status": "active|paused|suspended",
42
- * "sink": {
43
- * "azureSubscriptionId": "string",
44
- * "azureResourceGroup": "string",
45
- * "azureRegion": "string",
46
- * "azurePartnerTopic": "string"
47
- * }
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
+ * }
48
52
  * },
49
53
  * {
50
- * "id": "string",
51
- * "name": "string",
52
- * "type": "splunk",
53
- * "status": "active|paused|suspended",
54
- * "sink": {
55
- * "splunkDomain": "string",
56
- * "splunkToken": "string",
57
- * "splunkPort": "string",
58
- * "splunkSecure": "boolean"
59
- * }
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
+ * }
60
64
  * },
61
65
  * {
62
- * "id": "string",
63
- * "name": "string",
64
- * "type": "sumo",
65
- * "status": "active|paused|suspended",
66
- * "sink": {
67
- * "sumoSourceAddress": "string",
68
- * }
66
+ * "id": "string",
67
+ * "name": "string",
68
+ * "type": "sumo",
69
+ * "status": "active|paused|suspended",
70
+ * "sink": {
71
+ * "sumoSourceAddress": "string"
72
+ * }
69
73
  * },
70
74
  * {
71
- * "id": "string",
72
- * "name": "string",
73
- * "type": "datadog",
74
- * "status": "active|paused|suspended",
75
- * "sink": {
76
- * "datadogRegion": "string",
77
- * "datadogApiKey": "string"
78
- * }
79
- * }]</code></pre>
75
+ * "id": "string",
76
+ * "name": "string",
77
+ * "type": "datadog",
78
+ * "status": "active|paused|suspended",
79
+ * "sink": {
80
+ * "datadogRegion": "string",
81
+ * "datadogApiKey": "string"
82
+ * }
83
+ * }]
84
+ * ```
80
85
  *
81
86
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
82
87
  *
@@ -92,131 +97,202 @@ export declare class LogStreamsClient {
92
97
  private __list;
93
98
  /**
94
99
  * Create a log stream.
95
- * <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
96
- * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
97
- * Request: <pre><code>{
98
- * "name": "string",
99
- * "type": "http",
100
- * "sink": {
101
- * "httpEndpoint": "string",
102
- * "httpContentType": "string",
103
- * "httpContentFormat": "JSONLINES|JSONARRAY",
104
- * "httpAuthorization": "string"
105
- * }
106
- * }</code></pre>
107
- * Response: <pre><code>{
108
- * "id": "string",
109
- * "name": "string",
110
- * "type": "http",
111
- * "status": "active",
112
- * "sink": {
113
- * "httpEndpoint": "string",
114
- * "httpContentType": "string",
115
- * "httpContentFormat": "JSONLINES|JSONARRAY",
116
- * "httpAuthorization": "string"
117
- * }
118
- * }</code></pre>
119
- * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
120
- * Request: <pre><code>{
121
- * "name": "string",
122
- * "type": "eventbridge",
123
- * "sink": {
124
- * "awsRegion": "string",
125
- * "awsAccountId": "string"
126
- * }
127
- * }</code></pre>
128
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
129
- * "id": "string",
130
- * "name": "string",
131
- * "type": "eventbridge",
132
- * "status": "active",
133
- * "sink": {
134
- * "awsAccountId": "string",
135
- * "awsRegion": "string",
136
- * "awsPartnerEventSource": "string"
137
- * }
138
- * }</code></pre>
139
- * <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
140
- * Request: <pre><code>{
141
- * "name": "string",
142
- * "type": "eventgrid",
143
- * "sink": {
144
- * "azureSubscriptionId": "string",
145
- * "azureResourceGroup": "string",
146
- * "azureRegion": "string"
147
- * }
148
- * }</code></pre>
149
- * Response: <pre><code>{
150
- * "id": "string",
151
- * "name": "string",
152
- * "type": "http",
153
- * "status": "active",
154
- * "sink": {
155
- * "azureSubscriptionId": "string",
156
- * "azureResourceGroup": "string",
157
- * "azureRegion": "string",
158
- * "azurePartnerTopic": "string"
159
- * }
160
- * }</code></pre>
161
- * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
162
- * Request: <pre><code>{
163
- * "name": "string",
164
- * "type": "datadog",
165
- * "sink": {
166
- * "datadogRegion": "string",
167
- * "datadogApiKey": "string"
168
- * }
169
- * }</code></pre>
170
- * Response: <pre><code>{
171
- * "id": "string",
172
- * "name": "string",
173
- * "type": "datadog",
174
- * "status": "active",
175
- * "sink": {
176
- * "datadogRegion": "string",
177
- * "datadogApiKey": "string"
178
- * }
179
- * }</code></pre>
180
- * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
181
- * Request: <pre><code>{
182
- * "name": "string",
183
- * "type": "splunk",
184
- * "sink": {
185
- * "splunkDomain": "string",
186
- * "splunkToken": "string",
187
- * "splunkPort": "string",
188
- * "splunkSecure": "boolean"
189
- * }
190
- * }</code></pre>
191
- * Response: <pre><code>{
192
- * "id": "string",
193
- * "name": "string",
194
- * "type": "splunk",
195
- * "status": "active",
196
- * "sink": {
197
- * "splunkDomain": "string",
198
- * "splunkToken": "string",
199
- * "splunkPort": "string",
200
- * "splunkSecure": "boolean"
201
- * }
202
- * }</code></pre>
203
- * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
204
- * Request: <pre><code>{
205
- * "name": "string",
206
- * "type": "sumo",
207
- * "sink": {
208
- * "sumoSourceAddress": "string",
209
- * }
210
- * }</code></pre>
211
- * Response: <pre><code>{
212
- * "id": "string",
213
- * "name": "string",
214
- * "type": "sumo",
215
- * "status": "active",
216
- * "sink": {
217
- * "sumoSourceAddress": "string",
218
- * }
219
- * }</code></pre>
100
+ *
101
+ * **Log Stream Types**
102
+ *
103
+ * The `type` of log stream being created determines the properties required in the `sink` payload.
104
+ *
105
+ * **HTTP Stream**
106
+ *
107
+ * For an `http` Stream, the `sink` properties are listed in the payload below.
108
+ *
109
+ * **Request:**
110
+ * ```json
111
+ * {
112
+ * "name": "string",
113
+ * "type": "http",
114
+ * "sink": {
115
+ * "httpEndpoint": "string",
116
+ * "httpContentType": "string",
117
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
118
+ * "httpAuthorization": "string"
119
+ * }
120
+ * }
121
+ * ```
122
+ *
123
+ * **Response:**
124
+ * ```json
125
+ * {
126
+ * "id": "string",
127
+ * "name": "string",
128
+ * "type": "http",
129
+ * "status": "active",
130
+ * "sink": {
131
+ * "httpEndpoint": "string",
132
+ * "httpContentType": "string",
133
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
134
+ * "httpAuthorization": "string"
135
+ * }
136
+ * }
137
+ * ```
138
+ *
139
+ * **Amazon EventBridge Stream**
140
+ *
141
+ * For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
142
+ *
143
+ * **Request:**
144
+ * ```json
145
+ * {
146
+ * "name": "string",
147
+ * "type": "eventbridge",
148
+ * "sink": {
149
+ * "awsRegion": "string",
150
+ * "awsAccountId": "string"
151
+ * }
152
+ * }
153
+ * ```
154
+ *
155
+ * The response will include an additional field `awsPartnerEventSource` in the `sink`:
156
+ *
157
+ * **Response:**
158
+ * ```json
159
+ * {
160
+ * "id": "string",
161
+ * "name": "string",
162
+ * "type": "eventbridge",
163
+ * "status": "active",
164
+ * "sink": {
165
+ * "awsAccountId": "string",
166
+ * "awsRegion": "string",
167
+ * "awsPartnerEventSource": "string"
168
+ * }
169
+ * }
170
+ * ```
171
+ *
172
+ * **Azure Event Grid Stream**
173
+ *
174
+ * For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
175
+ *
176
+ * **Request:**
177
+ * ```json
178
+ * {
179
+ * "name": "string",
180
+ * "type": "eventgrid",
181
+ * "sink": {
182
+ * "azureSubscriptionId": "string",
183
+ * "azureResourceGroup": "string",
184
+ * "azureRegion": "string"
185
+ * }
186
+ * }
187
+ * ```
188
+ *
189
+ * **Response:**
190
+ * ```json
191
+ * {
192
+ * "id": "string",
193
+ * "name": "string",
194
+ * "type": "http",
195
+ * "status": "active",
196
+ * "sink": {
197
+ * "azureSubscriptionId": "string",
198
+ * "azureResourceGroup": "string",
199
+ * "azureRegion": "string",
200
+ * "azurePartnerTopic": "string"
201
+ * }
202
+ * }
203
+ * ```
204
+ *
205
+ * **Datadog Stream**
206
+ *
207
+ * For a `Datadog` Stream, the `sink` properties are listed in the payload below.
208
+ *
209
+ * **Request:**
210
+ * ```json
211
+ * {
212
+ * "name": "string",
213
+ * "type": "datadog",
214
+ * "sink": {
215
+ * "datadogRegion": "string",
216
+ * "datadogApiKey": "string"
217
+ * }
218
+ * }
219
+ * ```
220
+ *
221
+ * **Response:**
222
+ * ```json
223
+ * {
224
+ * "id": "string",
225
+ * "name": "string",
226
+ * "type": "datadog",
227
+ * "status": "active",
228
+ * "sink": {
229
+ * "datadogRegion": "string",
230
+ * "datadogApiKey": "string"
231
+ * }
232
+ * }
233
+ * ```
234
+ *
235
+ * **Splunk Stream**
236
+ *
237
+ * For a `Splunk` Stream, the `sink` properties are listed in the payload below.
238
+ *
239
+ * **Request:**
240
+ * ```json
241
+ * {
242
+ * "name": "string",
243
+ * "type": "splunk",
244
+ * "sink": {
245
+ * "splunkDomain": "string",
246
+ * "splunkToken": "string",
247
+ * "splunkPort": "string",
248
+ * "splunkSecure": "boolean"
249
+ * }
250
+ * }
251
+ * ```
252
+ *
253
+ * **Response:**
254
+ * ```json
255
+ * {
256
+ * "id": "string",
257
+ * "name": "string",
258
+ * "type": "splunk",
259
+ * "status": "active",
260
+ * "sink": {
261
+ * "splunkDomain": "string",
262
+ * "splunkToken": "string",
263
+ * "splunkPort": "string",
264
+ * "splunkSecure": "boolean"
265
+ * }
266
+ * }
267
+ * ```
268
+ *
269
+ * **Sumo Logic Stream**
270
+ *
271
+ * For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
272
+ *
273
+ * **Request:**
274
+ * ```json
275
+ * {
276
+ * "name": "string",
277
+ * "type": "sumo",
278
+ * "sink": {
279
+ * "sumoSourceAddress": "string"
280
+ * }
281
+ * }
282
+ * ```
283
+ *
284
+ * **Response:**
285
+ * ```json
286
+ * {
287
+ * "id": "string",
288
+ * "name": "string",
289
+ * "type": "sumo",
290
+ * "status": "active",
291
+ * "sink": {
292
+ * "sumoSourceAddress": "string"
293
+ * }
294
+ * }
295
+ * ```
220
296
  *
221
297
  * @param {Management.CreateLogStreamRequestContent} request
222
298
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -239,107 +315,157 @@ export declare class LogStreamsClient {
239
315
  private __create;
240
316
  /**
241
317
  * Retrieve a log stream configuration and status.
242
- * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
243
- * "id": "string",
244
- * "name": "string",
245
- * "type": "eventbridge",
246
- * "status": "active|paused|suspended",
247
- * "sink": {
248
- * "awsAccountId": "string",
249
- * "awsRegion": "string",
250
- * "awsPartnerEventSource": "string"
251
- * }
252
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
253
- * "id": "string",
254
- * "name": "string",
255
- * "type": "http",
256
- * "status": "active|paused|suspended",
257
- * "sink": {
258
- * "httpContentFormat": "JSONLINES|JSONARRAY",
259
- * "httpContentType": "string",
260
- * "httpEndpoint": "string",
261
- * "httpAuthorization": "string"
262
- * }
263
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
264
- * "id": "string",
265
- * "name": "string",
266
- * "type": "datadog",
267
- * "status": "active|paused|suspended",
268
- * "sink": {
269
- * "datadogRegion": "string",
270
- * "datadogApiKey": "string"
271
- * }
272
- *
273
- * }</code></pre><h5>Mixpanel</h5>
274
- *
275
- * Request: <pre><code>{
276
- * "name": "string",
277
- * "type": "mixpanel",
278
- * "sink": {
279
- * "mixpanelRegion": "string", // "us" | "eu",
280
- * "mixpanelProjectId": "string",
281
- * "mixpanelServiceAccountUsername": "string",
282
- * "mixpanelServiceAccountPassword": "string"
283
- * }
284
- * } </code></pre>
285
- *
286
- *
287
- * Response: <pre><code>{
288
- * "id": "string",
289
- * "name": "string",
290
- * "type": "mixpanel",
291
- * "status": "active",
292
- * "sink": {
293
- * "mixpanelRegion": "string", // "us" | "eu",
294
- * "mixpanelProjectId": "string",
295
- * "mixpanelServiceAccountUsername": "string",
296
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
297
- * }
298
- * } </code></pre>
299
- *
300
- * <h5>Segment</h5>
301
- *
302
- * Request: <pre><code> {
303
- * "name": "string",
304
- * "type": "segment",
305
- * "sink": {
306
- * "segmentWriteKey": "string"
307
- * }
308
- * }</code></pre>
309
- *
310
- * Response: <pre><code>{
311
- * "id": "string",
312
- * "name": "string",
313
- * "type": "segment",
314
- * "status": "active",
315
- * "sink": {
316
- * "segmentWriteKey": "string"
317
- * }
318
- * } </code></pre>
319
- *
320
- * <h5>Splunk Log Stream</h5><pre><code>{
321
- * "id": "string",
322
- * "name": "string",
323
- * "type": "splunk",
324
- * "status": "active|paused|suspended",
325
- * "sink": {
326
- * "splunkDomain": "string",
327
- * "splunkToken": "string",
328
- * "splunkPort": "string",
329
- * "splunkSecure": "boolean"
330
- * }
331
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
332
- * "id": "string",
333
- * "name": "string",
334
- * "type": "sumo",
335
- * "status": "active|paused|suspended",
336
- * "sink": {
337
- * "sumoSourceAddress": "string",
338
- * }
339
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
340
- * 1. <code>active</code> - Stream is currently enabled.
341
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
342
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
318
+ *
319
+ * **Sample responses**
320
+ *
321
+ * **Amazon EventBridge Log Stream**
322
+ *
323
+ * ```json
324
+ * {
325
+ * "id": "string",
326
+ * "name": "string",
327
+ * "type": "eventbridge",
328
+ * "status": "active|paused|suspended",
329
+ * "sink": {
330
+ * "awsAccountId": "string",
331
+ * "awsRegion": "string",
332
+ * "awsPartnerEventSource": "string"
333
+ * }
334
+ * }
335
+ * ```
336
+ *
337
+ * **HTTP Log Stream**
338
+ *
339
+ * ```json
340
+ * {
341
+ * "id": "string",
342
+ * "name": "string",
343
+ * "type": "http",
344
+ * "status": "active|paused|suspended",
345
+ * "sink": {
346
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
347
+ * "httpContentType": "string",
348
+ * "httpEndpoint": "string",
349
+ * "httpAuthorization": "string"
350
+ * }
351
+ * }
352
+ * ```
353
+ *
354
+ * **Datadog Log Stream**
355
+ *
356
+ * ```json
357
+ * {
358
+ * "id": "string",
359
+ * "name": "string",
360
+ * "type": "datadog",
361
+ * "status": "active|paused|suspended",
362
+ * "sink": {
363
+ * "datadogRegion": "string",
364
+ * "datadogApiKey": "string"
365
+ * }
366
+ * }
367
+ * ```
368
+ *
369
+ * **Mixpanel**
370
+ *
371
+ * **Request:**
372
+ *
373
+ * ```json
374
+ * {
375
+ * "name": "string",
376
+ * "type": "mixpanel",
377
+ * "sink": {
378
+ * "mixpanelRegion": "string",
379
+ * "mixpanelProjectId": "string",
380
+ * "mixpanelServiceAccountUsername": "string",
381
+ * "mixpanelServiceAccountPassword": "string"
382
+ * }
383
+ * }
384
+ * ```
385
+ *
386
+ * **Response:**
387
+ *
388
+ * ```json
389
+ * {
390
+ * "id": "string",
391
+ * "name": "string",
392
+ * "type": "mixpanel",
393
+ * "status": "active",
394
+ * "sink": {
395
+ * "mixpanelRegion": "string",
396
+ * "mixpanelProjectId": "string",
397
+ * "mixpanelServiceAccountUsername": "string",
398
+ * "mixpanelServiceAccountPassword": "string"
399
+ * }
400
+ * }
401
+ * ```
402
+ *
403
+ * **Segment**
404
+ *
405
+ * **Request:**
406
+ *
407
+ * ```json
408
+ * {
409
+ * "name": "string",
410
+ * "type": "segment",
411
+ * "sink": {
412
+ * "segmentWriteKey": "string"
413
+ * }
414
+ * }
415
+ * ```
416
+ *
417
+ * **Response:**
418
+ *
419
+ * ```json
420
+ * {
421
+ * "id": "string",
422
+ * "name": "string",
423
+ * "type": "segment",
424
+ * "status": "active",
425
+ * "sink": {
426
+ * "segmentWriteKey": "string"
427
+ * }
428
+ * }
429
+ * ```
430
+ *
431
+ * **Splunk Log Stream**
432
+ *
433
+ * ```json
434
+ * {
435
+ * "id": "string",
436
+ * "name": "string",
437
+ * "type": "splunk",
438
+ * "status": "active|paused|suspended",
439
+ * "sink": {
440
+ * "splunkDomain": "string",
441
+ * "splunkToken": "string",
442
+ * "splunkPort": "string",
443
+ * "splunkSecure": "boolean"
444
+ * }
445
+ * }
446
+ * ```
447
+ *
448
+ * **Sumo Logic Log Stream**
449
+ *
450
+ * ```json
451
+ * {
452
+ * "id": "string",
453
+ * "name": "string",
454
+ * "type": "sumo",
455
+ * "status": "active|paused|suspended",
456
+ * "sink": {
457
+ * "sumoSourceAddress": "string"
458
+ * }
459
+ * }
460
+ * ```
461
+ *
462
+ * **Status**
463
+ *
464
+ * The `status` of a log stream maybe any of the following:
465
+ *
466
+ * 1. `active` - Stream is currently enabled.
467
+ * 2. `paused` - Stream is currently user disabled and will not attempt log delivery.
468
+ * 3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
343
469
  *
344
470
  * @param {string} id - The id of the log stream to get
345
471
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -373,40 +499,79 @@ export declare class LogStreamsClient {
373
499
  private __delete;
374
500
  /**
375
501
  * Update a log stream.
376
- * <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.
377
- * <h5>Update the status of a log stream</h5><pre><code>{
378
- * "status": "active|paused"
379
- * }</code></pre>
380
- * <h5>Update the name of a log stream</h5><pre><code>{
381
- * "name": "string"
382
- * }</code></pre>
383
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
502
+ *
503
+ * **Examples of how to use the PATCH endpoint.**
504
+ *
505
+ * The following fields may be updated in a PATCH operation:
506
+ *
507
+ * - name
508
+ * - status
509
+ * - sink
510
+ *
511
+ * Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
512
+ *
513
+ * **Update the status of a log stream**
514
+ *
515
+ * ```json
516
+ * {
517
+ * "status": "active|paused"
518
+ * }
519
+ * ```
520
+ *
521
+ * **Update the name of a log stream**
522
+ *
523
+ * ```json
524
+ * {
525
+ * "name": "string"
526
+ * }
527
+ * ```
528
+ *
529
+ * **Update the sink properties of a stream of type `http`**
530
+ *
531
+ * ```json
532
+ * {
384
533
  * "sink": {
385
534
  * "httpEndpoint": "string",
386
535
  * "httpContentType": "string",
387
536
  * "httpContentFormat": "JSONARRAY|JSONLINES",
388
537
  * "httpAuthorization": "string"
389
538
  * }
390
- * }</code></pre>
391
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
539
+ * }
540
+ * ```
541
+ *
542
+ * **Update the sink properties of a stream of type `datadog`**
543
+ *
544
+ * ```json
545
+ * {
392
546
  * "sink": {
393
- * "datadogRegion": "string",
394
- * "datadogApiKey": "string"
547
+ * "datadogRegion": "string",
548
+ * "datadogApiKey": "string"
395
549
  * }
396
- * }</code></pre>
397
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
550
+ * }
551
+ * ```
552
+ *
553
+ * **Update the sink properties of a stream of type `splunk`**
554
+ *
555
+ * ```json
556
+ * {
398
557
  * "sink": {
399
558
  * "splunkDomain": "string",
400
559
  * "splunkToken": "string",
401
560
  * "splunkPort": "string",
402
561
  * "splunkSecure": "boolean"
403
562
  * }
404
- * }</code></pre>
405
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
563
+ * }
564
+ * ```
565
+ *
566
+ * **Update the sink properties of a stream of type `sumo`**
567
+ *
568
+ * ```json
569
+ * {
406
570
  * "sink": {
407
571
  * "sumoSourceAddress": "string"
408
572
  * }
409
- * }</code></pre>
573
+ * }
574
+ * ```
410
575
  *
411
576
  * @param {string} id - The id of the log stream to get
412
577
  * @param {Management.UpdateLogStreamRequestContent} request