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.mjs CHANGED
@@ -20,72 +20,77 @@ export class LogStreamsClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
- * Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
24
- * <h5>Sample Response</h5><pre><code>[{
25
- * "id": "string",
26
- * "name": "string",
27
- * "type": "eventbridge",
28
- * "status": "active|paused|suspended",
29
- * "sink": {
30
- * "awsAccountId": "string",
31
- * "awsRegion": "string",
32
- * "awsPartnerEventSource": "string"
33
- * }
23
+ * Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
24
+ *
25
+ * **Sample Response**
26
+ *
27
+ * ```json
28
+ * [{
29
+ * "id": "string",
30
+ * "name": "string",
31
+ * "type": "eventbridge",
32
+ * "status": "active|paused|suspended",
33
+ * "sink": {
34
+ * "awsAccountId": "string",
35
+ * "awsRegion": "string",
36
+ * "awsPartnerEventSource": "string"
37
+ * }
34
38
  * }, {
35
- * "id": "string",
36
- * "name": "string",
37
- * "type": "http",
38
- * "status": "active|paused|suspended",
39
- * "sink": {
40
- * "httpContentFormat": "JSONLINES|JSONARRAY",
41
- * "httpContentType": "string",
42
- * "httpEndpoint": "string",
43
- * "httpAuthorization": "string"
44
- * }
39
+ * "id": "string",
40
+ * "name": "string",
41
+ * "type": "http",
42
+ * "status": "active|paused|suspended",
43
+ * "sink": {
44
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
45
+ * "httpContentType": "string",
46
+ * "httpEndpoint": "string",
47
+ * "httpAuthorization": "string"
48
+ * }
45
49
  * },
46
50
  * {
47
- * "id": "string",
48
- * "name": "string",
49
- * "type": "eventgrid",
50
- * "status": "active|paused|suspended",
51
- * "sink": {
52
- * "azureSubscriptionId": "string",
53
- * "azureResourceGroup": "string",
54
- * "azureRegion": "string",
55
- * "azurePartnerTopic": "string"
56
- * }
51
+ * "id": "string",
52
+ * "name": "string",
53
+ * "type": "eventgrid",
54
+ * "status": "active|paused|suspended",
55
+ * "sink": {
56
+ * "azureSubscriptionId": "string",
57
+ * "azureResourceGroup": "string",
58
+ * "azureRegion": "string",
59
+ * "azurePartnerTopic": "string"
60
+ * }
57
61
  * },
58
62
  * {
59
- * "id": "string",
60
- * "name": "string",
61
- * "type": "splunk",
62
- * "status": "active|paused|suspended",
63
- * "sink": {
64
- * "splunkDomain": "string",
65
- * "splunkToken": "string",
66
- * "splunkPort": "string",
67
- * "splunkSecure": "boolean"
68
- * }
63
+ * "id": "string",
64
+ * "name": "string",
65
+ * "type": "splunk",
66
+ * "status": "active|paused|suspended",
67
+ * "sink": {
68
+ * "splunkDomain": "string",
69
+ * "splunkToken": "string",
70
+ * "splunkPort": "string",
71
+ * "splunkSecure": "boolean"
72
+ * }
69
73
  * },
70
74
  * {
71
- * "id": "string",
72
- * "name": "string",
73
- * "type": "sumo",
74
- * "status": "active|paused|suspended",
75
- * "sink": {
76
- * "sumoSourceAddress": "string",
77
- * }
75
+ * "id": "string",
76
+ * "name": "string",
77
+ * "type": "sumo",
78
+ * "status": "active|paused|suspended",
79
+ * "sink": {
80
+ * "sumoSourceAddress": "string"
81
+ * }
78
82
  * },
79
83
  * {
80
- * "id": "string",
81
- * "name": "string",
82
- * "type": "datadog",
83
- * "status": "active|paused|suspended",
84
- * "sink": {
85
- * "datadogRegion": "string",
86
- * "datadogApiKey": "string"
87
- * }
88
- * }]</code></pre>
84
+ * "id": "string",
85
+ * "name": "string",
86
+ * "type": "datadog",
87
+ * "status": "active|paused|suspended",
88
+ * "sink": {
89
+ * "datadogRegion": "string",
90
+ * "datadogApiKey": "string"
91
+ * }
92
+ * }]
93
+ * ```
89
94
  *
90
95
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
91
96
  *
@@ -142,131 +147,202 @@ export class LogStreamsClient {
142
147
  }
143
148
  /**
144
149
  * Create a log stream.
145
- * <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
146
- * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
147
- * Request: <pre><code>{
148
- * "name": "string",
149
- * "type": "http",
150
- * "sink": {
151
- * "httpEndpoint": "string",
152
- * "httpContentType": "string",
153
- * "httpContentFormat": "JSONLINES|JSONARRAY",
154
- * "httpAuthorization": "string"
155
- * }
156
- * }</code></pre>
157
- * Response: <pre><code>{
158
- * "id": "string",
159
- * "name": "string",
160
- * "type": "http",
161
- * "status": "active",
162
- * "sink": {
163
- * "httpEndpoint": "string",
164
- * "httpContentType": "string",
165
- * "httpContentFormat": "JSONLINES|JSONARRAY",
166
- * "httpAuthorization": "string"
167
- * }
168
- * }</code></pre>
169
- * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
170
- * Request: <pre><code>{
171
- * "name": "string",
172
- * "type": "eventbridge",
173
- * "sink": {
174
- * "awsRegion": "string",
175
- * "awsAccountId": "string"
176
- * }
177
- * }</code></pre>
178
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
179
- * "id": "string",
180
- * "name": "string",
181
- * "type": "eventbridge",
182
- * "status": "active",
183
- * "sink": {
184
- * "awsAccountId": "string",
185
- * "awsRegion": "string",
186
- * "awsPartnerEventSource": "string"
187
- * }
188
- * }</code></pre>
189
- * <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
190
- * Request: <pre><code>{
191
- * "name": "string",
192
- * "type": "eventgrid",
193
- * "sink": {
194
- * "azureSubscriptionId": "string",
195
- * "azureResourceGroup": "string",
196
- * "azureRegion": "string"
197
- * }
198
- * }</code></pre>
199
- * Response: <pre><code>{
200
- * "id": "string",
201
- * "name": "string",
202
- * "type": "http",
203
- * "status": "active",
204
- * "sink": {
205
- * "azureSubscriptionId": "string",
206
- * "azureResourceGroup": "string",
207
- * "azureRegion": "string",
208
- * "azurePartnerTopic": "string"
209
- * }
210
- * }</code></pre>
211
- * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
212
- * Request: <pre><code>{
213
- * "name": "string",
214
- * "type": "datadog",
215
- * "sink": {
216
- * "datadogRegion": "string",
217
- * "datadogApiKey": "string"
218
- * }
219
- * }</code></pre>
220
- * Response: <pre><code>{
221
- * "id": "string",
222
- * "name": "string",
223
- * "type": "datadog",
224
- * "status": "active",
225
- * "sink": {
226
- * "datadogRegion": "string",
227
- * "datadogApiKey": "string"
228
- * }
229
- * }</code></pre>
230
- * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
231
- * Request: <pre><code>{
232
- * "name": "string",
233
- * "type": "splunk",
234
- * "sink": {
235
- * "splunkDomain": "string",
236
- * "splunkToken": "string",
237
- * "splunkPort": "string",
238
- * "splunkSecure": "boolean"
239
- * }
240
- * }</code></pre>
241
- * Response: <pre><code>{
242
- * "id": "string",
243
- * "name": "string",
244
- * "type": "splunk",
245
- * "status": "active",
246
- * "sink": {
247
- * "splunkDomain": "string",
248
- * "splunkToken": "string",
249
- * "splunkPort": "string",
250
- * "splunkSecure": "boolean"
251
- * }
252
- * }</code></pre>
253
- * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
254
- * Request: <pre><code>{
255
- * "name": "string",
256
- * "type": "sumo",
257
- * "sink": {
258
- * "sumoSourceAddress": "string",
259
- * }
260
- * }</code></pre>
261
- * Response: <pre><code>{
262
- * "id": "string",
263
- * "name": "string",
264
- * "type": "sumo",
265
- * "status": "active",
266
- * "sink": {
267
- * "sumoSourceAddress": "string",
268
- * }
269
- * }</code></pre>
150
+ *
151
+ * **Log Stream Types**
152
+ *
153
+ * The `type` of log stream being created determines the properties required in the `sink` payload.
154
+ *
155
+ * **HTTP Stream**
156
+ *
157
+ * For an `http` Stream, the `sink` properties are listed in the payload below.
158
+ *
159
+ * **Request:**
160
+ * ```json
161
+ * {
162
+ * "name": "string",
163
+ * "type": "http",
164
+ * "sink": {
165
+ * "httpEndpoint": "string",
166
+ * "httpContentType": "string",
167
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
168
+ * "httpAuthorization": "string"
169
+ * }
170
+ * }
171
+ * ```
172
+ *
173
+ * **Response:**
174
+ * ```json
175
+ * {
176
+ * "id": "string",
177
+ * "name": "string",
178
+ * "type": "http",
179
+ * "status": "active",
180
+ * "sink": {
181
+ * "httpEndpoint": "string",
182
+ * "httpContentType": "string",
183
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
184
+ * "httpAuthorization": "string"
185
+ * }
186
+ * }
187
+ * ```
188
+ *
189
+ * **Amazon EventBridge Stream**
190
+ *
191
+ * For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
192
+ *
193
+ * **Request:**
194
+ * ```json
195
+ * {
196
+ * "name": "string",
197
+ * "type": "eventbridge",
198
+ * "sink": {
199
+ * "awsRegion": "string",
200
+ * "awsAccountId": "string"
201
+ * }
202
+ * }
203
+ * ```
204
+ *
205
+ * The response will include an additional field `awsPartnerEventSource` in the `sink`:
206
+ *
207
+ * **Response:**
208
+ * ```json
209
+ * {
210
+ * "id": "string",
211
+ * "name": "string",
212
+ * "type": "eventbridge",
213
+ * "status": "active",
214
+ * "sink": {
215
+ * "awsAccountId": "string",
216
+ * "awsRegion": "string",
217
+ * "awsPartnerEventSource": "string"
218
+ * }
219
+ * }
220
+ * ```
221
+ *
222
+ * **Azure Event Grid Stream**
223
+ *
224
+ * For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
225
+ *
226
+ * **Request:**
227
+ * ```json
228
+ * {
229
+ * "name": "string",
230
+ * "type": "eventgrid",
231
+ * "sink": {
232
+ * "azureSubscriptionId": "string",
233
+ * "azureResourceGroup": "string",
234
+ * "azureRegion": "string"
235
+ * }
236
+ * }
237
+ * ```
238
+ *
239
+ * **Response:**
240
+ * ```json
241
+ * {
242
+ * "id": "string",
243
+ * "name": "string",
244
+ * "type": "http",
245
+ * "status": "active",
246
+ * "sink": {
247
+ * "azureSubscriptionId": "string",
248
+ * "azureResourceGroup": "string",
249
+ * "azureRegion": "string",
250
+ * "azurePartnerTopic": "string"
251
+ * }
252
+ * }
253
+ * ```
254
+ *
255
+ * **Datadog Stream**
256
+ *
257
+ * For a `Datadog` Stream, the `sink` properties are listed in the payload below.
258
+ *
259
+ * **Request:**
260
+ * ```json
261
+ * {
262
+ * "name": "string",
263
+ * "type": "datadog",
264
+ * "sink": {
265
+ * "datadogRegion": "string",
266
+ * "datadogApiKey": "string"
267
+ * }
268
+ * }
269
+ * ```
270
+ *
271
+ * **Response:**
272
+ * ```json
273
+ * {
274
+ * "id": "string",
275
+ * "name": "string",
276
+ * "type": "datadog",
277
+ * "status": "active",
278
+ * "sink": {
279
+ * "datadogRegion": "string",
280
+ * "datadogApiKey": "string"
281
+ * }
282
+ * }
283
+ * ```
284
+ *
285
+ * **Splunk Stream**
286
+ *
287
+ * For a `Splunk` Stream, the `sink` properties are listed in the payload below.
288
+ *
289
+ * **Request:**
290
+ * ```json
291
+ * {
292
+ * "name": "string",
293
+ * "type": "splunk",
294
+ * "sink": {
295
+ * "splunkDomain": "string",
296
+ * "splunkToken": "string",
297
+ * "splunkPort": "string",
298
+ * "splunkSecure": "boolean"
299
+ * }
300
+ * }
301
+ * ```
302
+ *
303
+ * **Response:**
304
+ * ```json
305
+ * {
306
+ * "id": "string",
307
+ * "name": "string",
308
+ * "type": "splunk",
309
+ * "status": "active",
310
+ * "sink": {
311
+ * "splunkDomain": "string",
312
+ * "splunkToken": "string",
313
+ * "splunkPort": "string",
314
+ * "splunkSecure": "boolean"
315
+ * }
316
+ * }
317
+ * ```
318
+ *
319
+ * **Sumo Logic Stream**
320
+ *
321
+ * For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
322
+ *
323
+ * **Request:**
324
+ * ```json
325
+ * {
326
+ * "name": "string",
327
+ * "type": "sumo",
328
+ * "sink": {
329
+ * "sumoSourceAddress": "string"
330
+ * }
331
+ * }
332
+ * ```
333
+ *
334
+ * **Response:**
335
+ * ```json
336
+ * {
337
+ * "id": "string",
338
+ * "name": "string",
339
+ * "type": "sumo",
340
+ * "status": "active",
341
+ * "sink": {
342
+ * "sumoSourceAddress": "string"
343
+ * }
344
+ * }
345
+ * ```
270
346
  *
271
347
  * @param {Management.CreateLogStreamRequestContent} request
272
348
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -338,107 +414,157 @@ export class LogStreamsClient {
338
414
  }
339
415
  /**
340
416
  * Retrieve a log stream configuration and status.
341
- * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
342
- * "id": "string",
343
- * "name": "string",
344
- * "type": "eventbridge",
345
- * "status": "active|paused|suspended",
346
- * "sink": {
347
- * "awsAccountId": "string",
348
- * "awsRegion": "string",
349
- * "awsPartnerEventSource": "string"
350
- * }
351
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
352
- * "id": "string",
353
- * "name": "string",
354
- * "type": "http",
355
- * "status": "active|paused|suspended",
356
- * "sink": {
357
- * "httpContentFormat": "JSONLINES|JSONARRAY",
358
- * "httpContentType": "string",
359
- * "httpEndpoint": "string",
360
- * "httpAuthorization": "string"
361
- * }
362
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
363
- * "id": "string",
364
- * "name": "string",
365
- * "type": "datadog",
366
- * "status": "active|paused|suspended",
367
- * "sink": {
368
- * "datadogRegion": "string",
369
- * "datadogApiKey": "string"
370
- * }
371
- *
372
- * }</code></pre><h5>Mixpanel</h5>
373
- *
374
- * Request: <pre><code>{
375
- * "name": "string",
376
- * "type": "mixpanel",
377
- * "sink": {
378
- * "mixpanelRegion": "string", // "us" | "eu",
379
- * "mixpanelProjectId": "string",
380
- * "mixpanelServiceAccountUsername": "string",
381
- * "mixpanelServiceAccountPassword": "string"
382
- * }
383
- * } </code></pre>
384
- *
385
- *
386
- * Response: <pre><code>{
387
- * "id": "string",
388
- * "name": "string",
389
- * "type": "mixpanel",
390
- * "status": "active",
391
- * "sink": {
392
- * "mixpanelRegion": "string", // "us" | "eu",
393
- * "mixpanelProjectId": "string",
394
- * "mixpanelServiceAccountUsername": "string",
395
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
396
- * }
397
- * } </code></pre>
398
- *
399
- * <h5>Segment</h5>
400
- *
401
- * Request: <pre><code> {
402
- * "name": "string",
403
- * "type": "segment",
404
- * "sink": {
405
- * "segmentWriteKey": "string"
406
- * }
407
- * }</code></pre>
408
- *
409
- * Response: <pre><code>{
410
- * "id": "string",
411
- * "name": "string",
412
- * "type": "segment",
413
- * "status": "active",
414
- * "sink": {
415
- * "segmentWriteKey": "string"
416
- * }
417
- * } </code></pre>
418
- *
419
- * <h5>Splunk Log Stream</h5><pre><code>{
420
- * "id": "string",
421
- * "name": "string",
422
- * "type": "splunk",
423
- * "status": "active|paused|suspended",
424
- * "sink": {
425
- * "splunkDomain": "string",
426
- * "splunkToken": "string",
427
- * "splunkPort": "string",
428
- * "splunkSecure": "boolean"
429
- * }
430
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
431
- * "id": "string",
432
- * "name": "string",
433
- * "type": "sumo",
434
- * "status": "active|paused|suspended",
435
- * "sink": {
436
- * "sumoSourceAddress": "string",
437
- * }
438
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
439
- * 1. <code>active</code> - Stream is currently enabled.
440
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
441
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
417
+ *
418
+ * **Sample responses**
419
+ *
420
+ * **Amazon EventBridge Log Stream**
421
+ *
422
+ * ```json
423
+ * {
424
+ * "id": "string",
425
+ * "name": "string",
426
+ * "type": "eventbridge",
427
+ * "status": "active|paused|suspended",
428
+ * "sink": {
429
+ * "awsAccountId": "string",
430
+ * "awsRegion": "string",
431
+ * "awsPartnerEventSource": "string"
432
+ * }
433
+ * }
434
+ * ```
435
+ *
436
+ * **HTTP Log Stream**
437
+ *
438
+ * ```json
439
+ * {
440
+ * "id": "string",
441
+ * "name": "string",
442
+ * "type": "http",
443
+ * "status": "active|paused|suspended",
444
+ * "sink": {
445
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
446
+ * "httpContentType": "string",
447
+ * "httpEndpoint": "string",
448
+ * "httpAuthorization": "string"
449
+ * }
450
+ * }
451
+ * ```
452
+ *
453
+ * **Datadog Log Stream**
454
+ *
455
+ * ```json
456
+ * {
457
+ * "id": "string",
458
+ * "name": "string",
459
+ * "type": "datadog",
460
+ * "status": "active|paused|suspended",
461
+ * "sink": {
462
+ * "datadogRegion": "string",
463
+ * "datadogApiKey": "string"
464
+ * }
465
+ * }
466
+ * ```
467
+ *
468
+ * **Mixpanel**
469
+ *
470
+ * **Request:**
471
+ *
472
+ * ```json
473
+ * {
474
+ * "name": "string",
475
+ * "type": "mixpanel",
476
+ * "sink": {
477
+ * "mixpanelRegion": "string",
478
+ * "mixpanelProjectId": "string",
479
+ * "mixpanelServiceAccountUsername": "string",
480
+ * "mixpanelServiceAccountPassword": "string"
481
+ * }
482
+ * }
483
+ * ```
484
+ *
485
+ * **Response:**
486
+ *
487
+ * ```json
488
+ * {
489
+ * "id": "string",
490
+ * "name": "string",
491
+ * "type": "mixpanel",
492
+ * "status": "active",
493
+ * "sink": {
494
+ * "mixpanelRegion": "string",
495
+ * "mixpanelProjectId": "string",
496
+ * "mixpanelServiceAccountUsername": "string",
497
+ * "mixpanelServiceAccountPassword": "string"
498
+ * }
499
+ * }
500
+ * ```
501
+ *
502
+ * **Segment**
503
+ *
504
+ * **Request:**
505
+ *
506
+ * ```json
507
+ * {
508
+ * "name": "string",
509
+ * "type": "segment",
510
+ * "sink": {
511
+ * "segmentWriteKey": "string"
512
+ * }
513
+ * }
514
+ * ```
515
+ *
516
+ * **Response:**
517
+ *
518
+ * ```json
519
+ * {
520
+ * "id": "string",
521
+ * "name": "string",
522
+ * "type": "segment",
523
+ * "status": "active",
524
+ * "sink": {
525
+ * "segmentWriteKey": "string"
526
+ * }
527
+ * }
528
+ * ```
529
+ *
530
+ * **Splunk Log Stream**
531
+ *
532
+ * ```json
533
+ * {
534
+ * "id": "string",
535
+ * "name": "string",
536
+ * "type": "splunk",
537
+ * "status": "active|paused|suspended",
538
+ * "sink": {
539
+ * "splunkDomain": "string",
540
+ * "splunkToken": "string",
541
+ * "splunkPort": "string",
542
+ * "splunkSecure": "boolean"
543
+ * }
544
+ * }
545
+ * ```
546
+ *
547
+ * **Sumo Logic Log Stream**
548
+ *
549
+ * ```json
550
+ * {
551
+ * "id": "string",
552
+ * "name": "string",
553
+ * "type": "sumo",
554
+ * "status": "active|paused|suspended",
555
+ * "sink": {
556
+ * "sumoSourceAddress": "string"
557
+ * }
558
+ * }
559
+ * ```
560
+ *
561
+ * **Status**
562
+ *
563
+ * The `status` of a log stream maybe any of the following:
564
+ *
565
+ * 1. `active` - Stream is currently enabled.
566
+ * 2. `paused` - Stream is currently user disabled and will not attempt log delivery.
567
+ * 3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
442
568
  *
443
569
  * @param {string} id - The id of the log stream to get
444
570
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -559,40 +685,79 @@ export class LogStreamsClient {
559
685
  }
560
686
  /**
561
687
  * Update a log stream.
562
- * <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.
563
- * <h5>Update the status of a log stream</h5><pre><code>{
564
- * "status": "active|paused"
565
- * }</code></pre>
566
- * <h5>Update the name of a log stream</h5><pre><code>{
567
- * "name": "string"
568
- * }</code></pre>
569
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
688
+ *
689
+ * **Examples of how to use the PATCH endpoint.**
690
+ *
691
+ * The following fields may be updated in a PATCH operation:
692
+ *
693
+ * - name
694
+ * - status
695
+ * - sink
696
+ *
697
+ * Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
698
+ *
699
+ * **Update the status of a log stream**
700
+ *
701
+ * ```json
702
+ * {
703
+ * "status": "active|paused"
704
+ * }
705
+ * ```
706
+ *
707
+ * **Update the name of a log stream**
708
+ *
709
+ * ```json
710
+ * {
711
+ * "name": "string"
712
+ * }
713
+ * ```
714
+ *
715
+ * **Update the sink properties of a stream of type `http`**
716
+ *
717
+ * ```json
718
+ * {
570
719
  * "sink": {
571
720
  * "httpEndpoint": "string",
572
721
  * "httpContentType": "string",
573
722
  * "httpContentFormat": "JSONARRAY|JSONLINES",
574
723
  * "httpAuthorization": "string"
575
724
  * }
576
- * }</code></pre>
577
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
725
+ * }
726
+ * ```
727
+ *
728
+ * **Update the sink properties of a stream of type `datadog`**
729
+ *
730
+ * ```json
731
+ * {
578
732
  * "sink": {
579
- * "datadogRegion": "string",
580
- * "datadogApiKey": "string"
733
+ * "datadogRegion": "string",
734
+ * "datadogApiKey": "string"
581
735
  * }
582
- * }</code></pre>
583
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
736
+ * }
737
+ * ```
738
+ *
739
+ * **Update the sink properties of a stream of type `splunk`**
740
+ *
741
+ * ```json
742
+ * {
584
743
  * "sink": {
585
744
  * "splunkDomain": "string",
586
745
  * "splunkToken": "string",
587
746
  * "splunkPort": "string",
588
747
  * "splunkSecure": "boolean"
589
748
  * }
590
- * }</code></pre>
591
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
749
+ * }
750
+ * ```
751
+ *
752
+ * **Update the sink properties of a stream of type `sumo`**
753
+ *
754
+ * ```json
755
+ * {
592
756
  * "sink": {
593
757
  * "sumoSourceAddress": "string"
594
758
  * }
595
- * }</code></pre>
759
+ * }
760
+ * ```
596
761
  *
597
762
  * @param {string} id - The id of the log stream to get
598
763
  * @param {Management.UpdateLogStreamRequestContent} request