auth0 5.7.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 (16) hide show
  1. package/dist/cjs/management/api/requests/requests.d.ts +2 -2
  2. package/dist/cjs/management/api/resources/logStreams/client/Client.d.ts +465 -300
  3. package/dist/cjs/management/api/resources/logStreams/client/Client.js +465 -300
  4. package/dist/cjs/management/api/types/types.d.ts +29 -17
  5. package/dist/cjs/management/api/types/types.js +15 -10
  6. package/dist/cjs/management/version.d.ts +1 -1
  7. package/dist/cjs/management/version.js +1 -1
  8. package/dist/esm/management/api/requests/requests.d.mts +2 -2
  9. package/dist/esm/management/api/resources/logStreams/client/Client.d.mts +465 -300
  10. package/dist/esm/management/api/resources/logStreams/client/Client.mjs +465 -300
  11. package/dist/esm/management/api/types/types.d.mts +29 -17
  12. package/dist/esm/management/api/types/types.mjs +6 -1
  13. package/dist/esm/management/version.d.mts +1 -1
  14. package/dist/esm/management/version.mjs +1 -1
  15. package/package.json +1 -1
  16. package/reference.md +505 -323
package/reference.md CHANGED
@@ -5452,73 +5452,81 @@ await client.jobs.get("id");
5452
5452
  <dl>
5453
5453
  <dd>
5454
5454
 
5455
- Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
5456
-
5457
- <h5>Sample Response</h5><pre><code>[{
5458
- "id": "string",
5459
- "name": "string",
5460
- "type": "eventbridge",
5461
- "status": "active|paused|suspended",
5462
- "sink": {
5463
- "awsAccountId": "string",
5464
- "awsRegion": "string",
5465
- "awsPartnerEventSource": "string"
5466
- }
5467
- }, {
5468
- "id": "string",
5469
- "name": "string",
5470
- "type": "http",
5471
- "status": "active|paused|suspended",
5472
- "sink": {
5473
- "httpContentFormat": "JSONLINES|JSONARRAY",
5474
- "httpContentType": "string",
5475
- "httpEndpoint": "string",
5476
- "httpAuthorization": "string"
5477
- }
5478
- },
5479
- {
5480
- "id": "string",
5481
- "name": "string",
5482
- "type": "eventgrid",
5483
- "status": "active|paused|suspended",
5484
- "sink": {
5485
- "azureSubscriptionId": "string",
5486
- "azureResourceGroup": "string",
5487
- "azureRegion": "string",
5488
- "azurePartnerTopic": "string"
5489
- }
5490
- },
5491
- {
5492
- "id": "string",
5493
- "name": "string",
5494
- "type": "splunk",
5495
- "status": "active|paused|suspended",
5496
- "sink": {
5497
- "splunkDomain": "string",
5498
- "splunkToken": "string",
5499
- "splunkPort": "string",
5500
- "splunkSecure": "boolean"
5501
- }
5502
- },
5503
- {
5504
- "id": "string",
5505
- "name": "string",
5506
- "type": "sumo",
5507
- "status": "active|paused|suspended",
5508
- "sink": {
5509
- "sumoSourceAddress": "string",
5510
- }
5511
- },
5512
- {
5513
- "id": "string",
5514
- "name": "string",
5515
- "type": "datadog",
5516
- "status": "active|paused|suspended",
5517
- "sink": {
5518
- "datadogRegion": "string",
5519
- "datadogApiKey": "string"
5520
- }
5521
- }]</code></pre>
5455
+ Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
5456
+
5457
+ **Sample Response**
5458
+
5459
+ ```json
5460
+ [
5461
+ {
5462
+ "id": "string",
5463
+ "name": "string",
5464
+ "type": "eventbridge",
5465
+ "status": "active|paused|suspended",
5466
+ "sink": {
5467
+ "awsAccountId": "string",
5468
+ "awsRegion": "string",
5469
+ "awsPartnerEventSource": "string"
5470
+ }
5471
+ },
5472
+ {
5473
+ "id": "string",
5474
+ "name": "string",
5475
+ "type": "http",
5476
+ "status": "active|paused|suspended",
5477
+ "sink": {
5478
+ "httpContentFormat": "JSONLINES|JSONARRAY",
5479
+ "httpContentType": "string",
5480
+ "httpEndpoint": "string",
5481
+ "httpAuthorization": "string"
5482
+ }
5483
+ },
5484
+ {
5485
+ "id": "string",
5486
+ "name": "string",
5487
+ "type": "eventgrid",
5488
+ "status": "active|paused|suspended",
5489
+ "sink": {
5490
+ "azureSubscriptionId": "string",
5491
+ "azureResourceGroup": "string",
5492
+ "azureRegion": "string",
5493
+ "azurePartnerTopic": "string"
5494
+ }
5495
+ },
5496
+ {
5497
+ "id": "string",
5498
+ "name": "string",
5499
+ "type": "splunk",
5500
+ "status": "active|paused|suspended",
5501
+ "sink": {
5502
+ "splunkDomain": "string",
5503
+ "splunkToken": "string",
5504
+ "splunkPort": "string",
5505
+ "splunkSecure": "boolean"
5506
+ }
5507
+ },
5508
+ {
5509
+ "id": "string",
5510
+ "name": "string",
5511
+ "type": "sumo",
5512
+ "status": "active|paused|suspended",
5513
+ "sink": {
5514
+ "sumoSourceAddress": "string"
5515
+ }
5516
+ },
5517
+ {
5518
+ "id": "string",
5519
+ "name": "string",
5520
+ "type": "datadog",
5521
+ "status": "active|paused|suspended",
5522
+ "sink": {
5523
+ "datadogRegion": "string",
5524
+ "datadogApiKey": "string"
5525
+ }
5526
+ }
5527
+ ]
5528
+ ```
5529
+
5522
5530
  </dd>
5523
5531
  </dl>
5524
5532
  </dd>
@@ -5574,131 +5582,214 @@ await client.logStreams.list();
5574
5582
 
5575
5583
  Create a log stream.
5576
5584
 
5577
- <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
5578
- <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
5579
- Request: <pre><code>{
5580
- "name": "string",
5581
- "type": "http",
5582
- "sink": {
5583
- "httpEndpoint": "string",
5584
- "httpContentType": "string",
5585
- "httpContentFormat": "JSONLINES|JSONARRAY",
5586
- "httpAuthorization": "string"
5587
- }
5588
- }</code></pre>
5589
- Response: <pre><code>{
5590
- "id": "string",
5591
- "name": "string",
5592
- "type": "http",
5593
- "status": "active",
5594
- "sink": {
5595
- "httpEndpoint": "string",
5596
- "httpContentType": "string",
5597
- "httpContentFormat": "JSONLINES|JSONARRAY",
5598
- "httpAuthorization": "string"
5599
- }
5600
- }</code></pre>
5601
- <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
5602
- Request: <pre><code>{
5603
- "name": "string",
5604
- "type": "eventbridge",
5605
- "sink": {
5606
- "awsRegion": "string",
5607
- "awsAccountId": "string"
5608
- }
5609
- }</code></pre>
5610
- The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
5611
- "id": "string",
5612
- "name": "string",
5613
- "type": "eventbridge",
5614
- "status": "active",
5615
- "sink": {
5616
- "awsAccountId": "string",
5617
- "awsRegion": "string",
5618
- "awsPartnerEventSource": "string"
5619
- }
5620
- }</code></pre>
5621
- <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
5622
- Request: <pre><code>{
5623
- "name": "string",
5624
- "type": "eventgrid",
5625
- "sink": {
5626
- "azureSubscriptionId": "string",
5627
- "azureResourceGroup": "string",
5628
- "azureRegion": "string"
5629
- }
5630
- }</code></pre>
5631
- Response: <pre><code>{
5632
- "id": "string",
5633
- "name": "string",
5634
- "type": "http",
5635
- "status": "active",
5636
- "sink": {
5637
- "azureSubscriptionId": "string",
5638
- "azureResourceGroup": "string",
5639
- "azureRegion": "string",
5640
- "azurePartnerTopic": "string"
5641
- }
5642
- }</code></pre>
5643
- <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
5644
- Request: <pre><code>{
5645
- "name": "string",
5646
- "type": "datadog",
5647
- "sink": {
5648
- "datadogRegion": "string",
5649
- "datadogApiKey": "string"
5650
- }
5651
- }</code></pre>
5652
- Response: <pre><code>{
5653
- "id": "string",
5654
- "name": "string",
5655
- "type": "datadog",
5656
- "status": "active",
5657
- "sink": {
5658
- "datadogRegion": "string",
5659
- "datadogApiKey": "string"
5660
- }
5661
- }</code></pre>
5662
- <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
5663
- Request: <pre><code>{
5664
- "name": "string",
5665
- "type": "splunk",
5666
- "sink": {
5667
- "splunkDomain": "string",
5668
- "splunkToken": "string",
5669
- "splunkPort": "string",
5670
- "splunkSecure": "boolean"
5671
- }
5672
- }</code></pre>
5673
- Response: <pre><code>{
5674
- "id": "string",
5675
- "name": "string",
5676
- "type": "splunk",
5677
- "status": "active",
5678
- "sink": {
5679
- "splunkDomain": "string",
5680
- "splunkToken": "string",
5681
- "splunkPort": "string",
5682
- "splunkSecure": "boolean"
5683
- }
5684
- }</code></pre>
5685
- <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
5686
- Request: <pre><code>{
5687
- "name": "string",
5688
- "type": "sumo",
5689
- "sink": {
5690
- "sumoSourceAddress": "string",
5691
- }
5692
- }</code></pre>
5693
- Response: <pre><code>{
5694
- "id": "string",
5695
- "name": "string",
5696
- "type": "sumo",
5697
- "status": "active",
5698
- "sink": {
5699
- "sumoSourceAddress": "string",
5700
- }
5701
- }</code></pre>
5585
+ **Log Stream Types**
5586
+
5587
+ The `type` of log stream being created determines the properties required in the `sink` payload.
5588
+
5589
+ **HTTP Stream**
5590
+
5591
+ For an `http` Stream, the `sink` properties are listed in the payload below.
5592
+
5593
+ **Request:**
5594
+
5595
+ ```json
5596
+ {
5597
+ "name": "string",
5598
+ "type": "http",
5599
+ "sink": {
5600
+ "httpEndpoint": "string",
5601
+ "httpContentType": "string",
5602
+ "httpContentFormat": "JSONLINES|JSONARRAY",
5603
+ "httpAuthorization": "string"
5604
+ }
5605
+ }
5606
+ ```
5607
+
5608
+ **Response:**
5609
+
5610
+ ```json
5611
+ {
5612
+ "id": "string",
5613
+ "name": "string",
5614
+ "type": "http",
5615
+ "status": "active",
5616
+ "sink": {
5617
+ "httpEndpoint": "string",
5618
+ "httpContentType": "string",
5619
+ "httpContentFormat": "JSONLINES|JSONARRAY",
5620
+ "httpAuthorization": "string"
5621
+ }
5622
+ }
5623
+ ```
5624
+
5625
+ **Amazon EventBridge Stream**
5626
+
5627
+ For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
5628
+
5629
+ **Request:**
5630
+
5631
+ ```json
5632
+ {
5633
+ "name": "string",
5634
+ "type": "eventbridge",
5635
+ "sink": {
5636
+ "awsRegion": "string",
5637
+ "awsAccountId": "string"
5638
+ }
5639
+ }
5640
+ ```
5641
+
5642
+ The response will include an additional field `awsPartnerEventSource` in the `sink`:
5643
+
5644
+ **Response:**
5645
+
5646
+ ```json
5647
+ {
5648
+ "id": "string",
5649
+ "name": "string",
5650
+ "type": "eventbridge",
5651
+ "status": "active",
5652
+ "sink": {
5653
+ "awsAccountId": "string",
5654
+ "awsRegion": "string",
5655
+ "awsPartnerEventSource": "string"
5656
+ }
5657
+ }
5658
+ ```
5659
+
5660
+ **Azure Event Grid Stream**
5661
+
5662
+ For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
5663
+
5664
+ **Request:**
5665
+
5666
+ ```json
5667
+ {
5668
+ "name": "string",
5669
+ "type": "eventgrid",
5670
+ "sink": {
5671
+ "azureSubscriptionId": "string",
5672
+ "azureResourceGroup": "string",
5673
+ "azureRegion": "string"
5674
+ }
5675
+ }
5676
+ ```
5677
+
5678
+ **Response:**
5679
+
5680
+ ```json
5681
+ {
5682
+ "id": "string",
5683
+ "name": "string",
5684
+ "type": "http",
5685
+ "status": "active",
5686
+ "sink": {
5687
+ "azureSubscriptionId": "string",
5688
+ "azureResourceGroup": "string",
5689
+ "azureRegion": "string",
5690
+ "azurePartnerTopic": "string"
5691
+ }
5692
+ }
5693
+ ```
5694
+
5695
+ **Datadog Stream**
5696
+
5697
+ For a `Datadog` Stream, the `sink` properties are listed in the payload below.
5698
+
5699
+ **Request:**
5700
+
5701
+ ```json
5702
+ {
5703
+ "name": "string",
5704
+ "type": "datadog",
5705
+ "sink": {
5706
+ "datadogRegion": "string",
5707
+ "datadogApiKey": "string"
5708
+ }
5709
+ }
5710
+ ```
5711
+
5712
+ **Response:**
5713
+
5714
+ ```json
5715
+ {
5716
+ "id": "string",
5717
+ "name": "string",
5718
+ "type": "datadog",
5719
+ "status": "active",
5720
+ "sink": {
5721
+ "datadogRegion": "string",
5722
+ "datadogApiKey": "string"
5723
+ }
5724
+ }
5725
+ ```
5726
+
5727
+ **Splunk Stream**
5728
+
5729
+ For a `Splunk` Stream, the `sink` properties are listed in the payload below.
5730
+
5731
+ **Request:**
5732
+
5733
+ ```json
5734
+ {
5735
+ "name": "string",
5736
+ "type": "splunk",
5737
+ "sink": {
5738
+ "splunkDomain": "string",
5739
+ "splunkToken": "string",
5740
+ "splunkPort": "string",
5741
+ "splunkSecure": "boolean"
5742
+ }
5743
+ }
5744
+ ```
5745
+
5746
+ **Response:**
5747
+
5748
+ ```json
5749
+ {
5750
+ "id": "string",
5751
+ "name": "string",
5752
+ "type": "splunk",
5753
+ "status": "active",
5754
+ "sink": {
5755
+ "splunkDomain": "string",
5756
+ "splunkToken": "string",
5757
+ "splunkPort": "string",
5758
+ "splunkSecure": "boolean"
5759
+ }
5760
+ }
5761
+ ```
5762
+
5763
+ **Sumo Logic Stream**
5764
+
5765
+ For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
5766
+
5767
+ **Request:**
5768
+
5769
+ ```json
5770
+ {
5771
+ "name": "string",
5772
+ "type": "sumo",
5773
+ "sink": {
5774
+ "sumoSourceAddress": "string"
5775
+ }
5776
+ }
5777
+ ```
5778
+
5779
+ **Response:**
5780
+
5781
+ ```json
5782
+ {
5783
+ "id": "string",
5784
+ "name": "string",
5785
+ "type": "sumo",
5786
+ "status": "active",
5787
+ "sink": {
5788
+ "sumoSourceAddress": "string"
5789
+ }
5790
+ }
5791
+ ```
5792
+
5702
5793
  </dd>
5703
5794
  </dl>
5704
5795
  </dd>
@@ -5767,108 +5858,160 @@ await client.logStreams.create({
5767
5858
 
5768
5859
  Retrieve a log stream configuration and status.
5769
5860
 
5770
- <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
5771
- "id": "string",
5772
- "name": "string",
5773
- "type": "eventbridge",
5774
- "status": "active|paused|suspended",
5775
- "sink": {
5776
- "awsAccountId": "string",
5777
- "awsRegion": "string",
5778
- "awsPartnerEventSource": "string"
5779
- }
5780
- }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
5781
- "id": "string",
5782
- "name": "string",
5783
- "type": "http",
5784
- "status": "active|paused|suspended",
5785
- "sink": {
5786
- "httpContentFormat": "JSONLINES|JSONARRAY",
5787
- "httpContentType": "string",
5788
- "httpEndpoint": "string",
5789
- "httpAuthorization": "string"
5790
- }
5791
- }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
5792
- "id": "string",
5793
- "name": "string",
5794
- "type": "datadog",
5795
- "status": "active|paused|suspended",
5796
- "sink": {
5797
- "datadogRegion": "string",
5798
- "datadogApiKey": "string"
5799
- }
5800
-
5801
- }</code></pre><h5>Mixpanel</h5>
5802
- Request: <pre><code>{
5803
- "name": "string",
5804
- "type": "mixpanel",
5805
- "sink": {
5806
- "mixpanelRegion": "string", // "us" | "eu",
5807
- "mixpanelProjectId": "string",
5808
- "mixpanelServiceAccountUsername": "string",
5809
- "mixpanelServiceAccountPassword": "string"
5861
+ **Sample responses**
5862
+
5863
+ **Amazon EventBridge Log Stream**
5864
+
5865
+ ```json
5866
+ {
5867
+ "id": "string",
5868
+ "name": "string",
5869
+ "type": "eventbridge",
5870
+ "status": "active|paused|suspended",
5871
+ "sink": {
5872
+ "awsAccountId": "string",
5873
+ "awsRegion": "string",
5874
+ "awsPartnerEventSource": "string"
5875
+ }
5810
5876
  }
5811
- } </code></pre>
5812
- Response: <pre><code>{
5813
- "id": "string",
5814
- "name": "string",
5815
- "type": "mixpanel",
5816
- "status": "active",
5817
- "sink": {
5818
- "mixpanelRegion": "string", // "us" | "eu",
5819
- "mixpanelProjectId": "string",
5820
- "mixpanelServiceAccountUsername": "string",
5821
- "mixpanelServiceAccountPassword": "string" // the following is redacted on return
5877
+ ```
5878
+
5879
+ **HTTP Log Stream**
5880
+
5881
+ ```json
5882
+ {
5883
+ "id": "string",
5884
+ "name": "string",
5885
+ "type": "http",
5886
+ "status": "active|paused|suspended",
5887
+ "sink": {
5888
+ "httpContentFormat": "JSONLINES|JSONARRAY",
5889
+ "httpContentType": "string",
5890
+ "httpEndpoint": "string",
5891
+ "httpAuthorization": "string"
5892
+ }
5822
5893
  }
5823
- } </code></pre>
5894
+ ```
5824
5895
 
5825
- <h5>Segment</h5>
5896
+ **Datadog Log Stream**
5826
5897
 
5827
- Request: <pre><code> {
5828
- "name": "string",
5829
- "type": "segment",
5830
- "sink": {
5831
- "segmentWriteKey": "string"
5832
- }
5833
- }</code></pre>
5834
-
5835
- Response: <pre><code>{
5836
- "id": "string",
5837
- "name": "string",
5838
- "type": "segment",
5839
- "status": "active",
5840
- "sink": {
5841
- "segmentWriteKey": "string"
5842
- }
5843
- } </code></pre>
5898
+ ```json
5899
+ {
5900
+ "id": "string",
5901
+ "name": "string",
5902
+ "type": "datadog",
5903
+ "status": "active|paused|suspended",
5904
+ "sink": {
5905
+ "datadogRegion": "string",
5906
+ "datadogApiKey": "string"
5907
+ }
5908
+ }
5909
+ ```
5844
5910
 
5845
- <h5>Splunk Log Stream</h5><pre><code>{
5846
- "id": "string",
5847
- "name": "string",
5848
- "type": "splunk",
5849
- "status": "active|paused|suspended",
5850
- "sink": {
5851
- "splunkDomain": "string",
5852
- "splunkToken": "string",
5853
- "splunkPort": "string",
5854
- "splunkSecure": "boolean"
5855
- }
5856
- }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
5857
- "id": "string",
5858
- "name": "string",
5859
- "type": "sumo",
5860
- "status": "active|paused|suspended",
5861
- "sink": {
5862
- "sumoSourceAddress": "string",
5863
- }
5864
- }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
5865
- 1. <code>active</code> - Stream is currently enabled.
5866
- 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
5867
- 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
5868
- </dd>
5869
- </dl>
5870
- </dd>
5871
- </dl>
5911
+ **Mixpanel**
5912
+
5913
+ **Request:**
5914
+
5915
+ ```json
5916
+ {
5917
+ "name": "string",
5918
+ "type": "mixpanel",
5919
+ "sink": {
5920
+ "mixpanelRegion": "string",
5921
+ "mixpanelProjectId": "string",
5922
+ "mixpanelServiceAccountUsername": "string",
5923
+ "mixpanelServiceAccountPassword": "string"
5924
+ }
5925
+ }
5926
+ ```
5927
+
5928
+ **Response:**
5929
+
5930
+ ```json
5931
+ {
5932
+ "id": "string",
5933
+ "name": "string",
5934
+ "type": "mixpanel",
5935
+ "status": "active",
5936
+ "sink": {
5937
+ "mixpanelRegion": "string",
5938
+ "mixpanelProjectId": "string",
5939
+ "mixpanelServiceAccountUsername": "string",
5940
+ "mixpanelServiceAccountPassword": "string"
5941
+ }
5942
+ }
5943
+ ```
5944
+
5945
+ **Segment**
5946
+
5947
+ **Request:**
5948
+
5949
+ ```json
5950
+ {
5951
+ "name": "string",
5952
+ "type": "segment",
5953
+ "sink": {
5954
+ "segmentWriteKey": "string"
5955
+ }
5956
+ }
5957
+ ```
5958
+
5959
+ **Response:**
5960
+
5961
+ ```json
5962
+ {
5963
+ "id": "string",
5964
+ "name": "string",
5965
+ "type": "segment",
5966
+ "status": "active",
5967
+ "sink": {
5968
+ "segmentWriteKey": "string"
5969
+ }
5970
+ }
5971
+ ```
5972
+
5973
+ **Splunk Log Stream**
5974
+
5975
+ ```json
5976
+ {
5977
+ "id": "string",
5978
+ "name": "string",
5979
+ "type": "splunk",
5980
+ "status": "active|paused|suspended",
5981
+ "sink": {
5982
+ "splunkDomain": "string",
5983
+ "splunkToken": "string",
5984
+ "splunkPort": "string",
5985
+ "splunkSecure": "boolean"
5986
+ }
5987
+ }
5988
+ ```
5989
+
5990
+ **Sumo Logic Log Stream**
5991
+
5992
+ ```json
5993
+ {
5994
+ "id": "string",
5995
+ "name": "string",
5996
+ "type": "sumo",
5997
+ "status": "active|paused|suspended",
5998
+ "sink": {
5999
+ "sumoSourceAddress": "string"
6000
+ }
6001
+ }
6002
+ ```
6003
+
6004
+ **Status**
6005
+
6006
+ The `status` of a log stream maybe any of the following:
6007
+
6008
+ 1. `active` - Stream is currently enabled.
6009
+ 2. `paused` - Stream is currently user disabled and will not attempt log delivery.
6010
+ 3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
6011
+ </dd>
6012
+ </dl>
6013
+ </dd>
6014
+ </dl>
5872
6015
 
5873
6016
  #### 🔌 Usage
5874
6017
 
@@ -5991,40 +6134,79 @@ await client.logStreams.delete("id");
5991
6134
 
5992
6135
  Update a log stream.
5993
6136
 
5994
- <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.
5995
- <h5>Update the status of a log stream</h5><pre><code>{
5996
- "status": "active|paused"
5997
- }</code></pre>
5998
- <h5>Update the name of a log stream</h5><pre><code>{
5999
- "name": "string"
6000
- }</code></pre>
6001
- <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
6002
- "sink": {
6003
- "httpEndpoint": "string",
6004
- "httpContentType": "string",
6005
- "httpContentFormat": "JSONARRAY|JSONLINES",
6006
- "httpAuthorization": "string"
6007
- }
6008
- }</code></pre>
6009
- <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
6010
- "sink": {
6011
- "datadogRegion": "string",
6012
- "datadogApiKey": "string"
6013
- }
6014
- }</code></pre>
6015
- <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
6016
- "sink": {
6017
- "splunkDomain": "string",
6018
- "splunkToken": "string",
6019
- "splunkPort": "string",
6020
- "splunkSecure": "boolean"
6021
- }
6022
- }</code></pre>
6023
- <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
6024
- "sink": {
6025
- "sumoSourceAddress": "string"
6026
- }
6027
- }</code></pre>
6137
+ **Examples of how to use the PATCH endpoint.**
6138
+
6139
+ The following fields may be updated in a PATCH operation:
6140
+
6141
+ - name
6142
+ - status
6143
+ - sink
6144
+
6145
+ Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
6146
+
6147
+ **Update the status of a log stream**
6148
+
6149
+ ```json
6150
+ {
6151
+ "status": "active|paused"
6152
+ }
6153
+ ```
6154
+
6155
+ **Update the name of a log stream**
6156
+
6157
+ ```json
6158
+ {
6159
+ "name": "string"
6160
+ }
6161
+ ```
6162
+
6163
+ **Update the sink properties of a stream of type `http`**
6164
+
6165
+ ```json
6166
+ {
6167
+ "sink": {
6168
+ "httpEndpoint": "string",
6169
+ "httpContentType": "string",
6170
+ "httpContentFormat": "JSONARRAY|JSONLINES",
6171
+ "httpAuthorization": "string"
6172
+ }
6173
+ }
6174
+ ```
6175
+
6176
+ **Update the sink properties of a stream of type `datadog`**
6177
+
6178
+ ```json
6179
+ {
6180
+ "sink": {
6181
+ "datadogRegion": "string",
6182
+ "datadogApiKey": "string"
6183
+ }
6184
+ }
6185
+ ```
6186
+
6187
+ **Update the sink properties of a stream of type `splunk`**
6188
+
6189
+ ```json
6190
+ {
6191
+ "sink": {
6192
+ "splunkDomain": "string",
6193
+ "splunkToken": "string",
6194
+ "splunkPort": "string",
6195
+ "splunkSecure": "boolean"
6196
+ }
6197
+ }
6198
+ ```
6199
+
6200
+ **Update the sink properties of a stream of type `sumo`**
6201
+
6202
+ ```json
6203
+ {
6204
+ "sink": {
6205
+ "sumoSourceAddress": "string"
6206
+ }
6207
+ }
6208
+ ```
6209
+
6028
6210
  </dd>
6029
6211
  </dl>
6030
6212
  </dd>