auth0 7.1.0 → 7.3.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 (93) hide show
  1. package/dist/cjs/management/api/requests/requests.d.ts +213 -4
  2. package/dist/cjs/management/api/resources/experimentation/client/Client.d.ts +6 -0
  3. package/dist/cjs/management/api/resources/experimentation/client/Client.js +10 -0
  4. package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.d.ts +133 -0
  5. package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.js +485 -0
  6. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.d.ts +126 -0
  7. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.js +471 -0
  8. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/exports.d.ts +3 -0
  9. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/exports.js +22 -0
  10. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/index.d.ts +2 -0
  11. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/index.js +18 -0
  12. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/index.d.ts +1 -0
  13. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/index.js +37 -0
  14. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.ts +109 -0
  15. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.js +390 -0
  16. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.js +2 -0
  17. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/exports.d.ts +2 -0
  18. package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/exports.js +2 -2
  19. package/dist/cjs/management/api/resources/experimentation/resources/index.d.ts +2 -0
  20. package/dist/cjs/management/api/resources/experimentation/resources/index.js +3 -1
  21. package/dist/cjs/management/api/resources/experimentation/resources/segments/client/Client.d.ts +104 -0
  22. package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/segments}/client/Client.js +205 -39
  23. package/dist/cjs/management/api/resources/experimentation/resources/segments/client/index.js +2 -0
  24. package/dist/cjs/management/api/resources/experimentation/resources/segments/exports.d.ts +2 -0
  25. package/dist/cjs/management/api/resources/experimentation/resources/segments/exports.js +21 -0
  26. package/dist/cjs/management/api/resources/experimentation/resources/segments/index.d.ts +1 -0
  27. package/dist/cjs/management/api/resources/experimentation/resources/segments/index.js +17 -0
  28. package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +0 -3
  29. package/dist/cjs/management/api/resources/organizations/client/Client.js +2 -7
  30. package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +0 -1
  31. package/dist/cjs/management/api/resources/organizations/resources/index.js +1 -2
  32. package/dist/cjs/management/api/resources/users/client/Client.d.ts +8 -10
  33. package/dist/cjs/management/api/resources/users/client/Client.js +8 -10
  34. package/dist/cjs/management/api/types/types.d.ts +568 -91
  35. package/dist/cjs/management/api/types/types.js +113 -50
  36. package/dist/cjs/management/version.d.ts +1 -1
  37. package/dist/cjs/management/version.js +1 -1
  38. package/dist/esm/management/api/requests/requests.d.mts +213 -4
  39. package/dist/esm/management/api/resources/experimentation/client/Client.d.mts +6 -0
  40. package/dist/esm/management/api/resources/experimentation/client/Client.mjs +10 -0
  41. package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.d.mts +133 -0
  42. package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.mjs +485 -0
  43. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.d.mts +126 -0
  44. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.mjs +434 -0
  45. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/index.d.mts +1 -0
  46. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/index.mjs +1 -0
  47. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/exports.d.mts +3 -0
  48. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/exports.mjs +4 -0
  49. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/index.d.mts +2 -0
  50. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/index.mjs +2 -0
  51. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/index.d.mts +1 -0
  52. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/index.mjs +1 -0
  53. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.mts +109 -0
  54. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.mjs +353 -0
  55. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.d.mts +1 -0
  56. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.mjs +1 -0
  57. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/exports.d.mts +2 -0
  58. package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/exports.mjs +1 -1
  59. package/dist/esm/management/api/resources/experimentation/resources/index.d.mts +2 -0
  60. package/dist/esm/management/api/resources/experimentation/resources/index.mjs +2 -0
  61. package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.d.mts +104 -0
  62. package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.mjs +361 -0
  63. package/dist/esm/management/api/resources/experimentation/resources/segments/client/index.d.mts +1 -0
  64. package/dist/esm/management/api/resources/experimentation/resources/segments/client/index.mjs +1 -0
  65. package/dist/esm/management/api/resources/experimentation/resources/segments/exports.d.mts +2 -0
  66. package/dist/esm/management/api/resources/experimentation/resources/segments/exports.mjs +3 -0
  67. package/dist/esm/management/api/resources/experimentation/resources/segments/index.d.mts +1 -0
  68. package/dist/esm/management/api/resources/experimentation/resources/segments/index.mjs +1 -0
  69. package/dist/esm/management/api/resources/organizations/client/Client.d.mts +0 -3
  70. package/dist/esm/management/api/resources/organizations/client/Client.mjs +0 -5
  71. package/dist/esm/management/api/resources/organizations/resources/index.d.mts +0 -1
  72. package/dist/esm/management/api/resources/organizations/resources/index.mjs +0 -1
  73. package/dist/esm/management/api/resources/users/client/Client.d.mts +8 -10
  74. package/dist/esm/management/api/resources/users/client/Client.mjs +8 -10
  75. package/dist/esm/management/api/types/types.d.mts +568 -91
  76. package/dist/esm/management/api/types/types.mjs +92 -29
  77. package/dist/esm/management/version.d.mts +1 -1
  78. package/dist/esm/management/version.mjs +1 -1
  79. package/package.json +34 -12
  80. package/reference.md +1635 -220
  81. package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.ts +0 -63
  82. package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/exports.d.ts +0 -2
  83. package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.mts +0 -63
  84. package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.mjs +0 -195
  85. package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/exports.d.mts +0 -2
  86. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags}/client/index.d.ts +0 -0
  87. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags}/client/index.js +0 -0
  88. /package/dist/{esm/management/api/resources/organizations/resources/organizationTemplate/client/index.d.mts → cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.d.ts} +0 -0
  89. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.d.ts +0 -0
  90. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.js +0 -0
  91. /package/dist/{esm/management/api/resources/organizations/resources/organizationTemplate/client/index.mjs → cjs/management/api/resources/experimentation/resources/segments/client/index.d.ts} +0 -0
  92. /package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.d.mts +0 -0
  93. /package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.mjs +0 -0
package/reference.md CHANGED
@@ -12206,20 +12206,22 @@ await client.userBlocks.delete("id");
12206
12206
  <dl>
12207
12207
  <dd>
12208
12208
 
12209
- Retrieve details of users. It is possible to:
12209
+ This endpoint retrieves details of users. It's best suited to interactive, best-effort search and lookups where slightly stale results are acceptable. With it, you can:
12210
12210
 
12211
- - Specify a search criteria for users
12211
+ - Specify search criteria for users
12212
12212
  - Sort the users to be returned
12213
12213
  - Select the fields to be returned
12214
12214
  - Specify the number of users to retrieve per page and the page index
12215
12215
 
12216
- The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
12216
+ This endpoint is **not suited for use in critical paths**. It is eventually consistent and runs under a short (~2 second) query time limit, so results can be stale and heavy queries can return a 503.
12217
12217
 
12218
- [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
12218
+ - Do not use this endpoint for authentication, account linking, or logic inside login-flow Actions. Instead, [look users up directly by ID or email](https://auth0.com/docs/manage-users/user-search/get-users-by-id-or-email#management-api) to get their current state.
12219
+ - Do not use this endpoint to keep an external system in sync with user data. Instead, subscribe to [Event Streams](https://auth0.com/docs/customize/events/sync-data-across-systems) to receive every change as it happens.
12220
+ - Do not use this endpoint to enumerate or export your entire user base. Instead, run a [bulk user export](https://auth0.com/docs/manage-users/user-migration/bulk-user-exports) to retrieve the full set.
12219
12221
 
12220
- Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
12222
+ Use the `q` query parameter to match users with [query string syntax](https://auth0.com/docs/manage-users/user-search/user-search-query-syntax). For full instructions and guidance, see [How to List and Search Users](https://auth0.com/docs/manage-users/user-search/list-and-search-users).
12221
12223
 
12222
- Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
12224
+ For efficient queries, prefer indexed top-level fields and exact matches. Certain kinds of queries can be slow and may time out, such as filtering on freeform or multi-value fields (like user-defined attributes in `app_metadata` or `user_metadata`) or using leading wildcards.
12223
12225
 
12224
12226
  </dd>
12225
12227
  </dl>
@@ -19380,6 +19382,357 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
19380
19382
 
19381
19383
  ## Experimentation Experiments
19382
19384
 
19385
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.ExperimentListItem, Management.ListExperimentsResponseContent&gt;</code></summary>
19386
+ <dl>
19387
+ <dd>
19388
+
19389
+ #### 📝 Description
19390
+
19391
+ <dl>
19392
+ <dd>
19393
+
19394
+ <dl>
19395
+ <dd>
19396
+
19397
+ Retrieve a paginated list of experiments for the tenant, with optional filters.
19398
+
19399
+ </dd>
19400
+ </dl>
19401
+ </dd>
19402
+ </dl>
19403
+
19404
+ #### 🔌 Usage
19405
+
19406
+ <dl>
19407
+ <dd>
19408
+
19409
+ <dl>
19410
+ <dd>
19411
+
19412
+ ```typescript
19413
+ const pageableResponse = await client.experimentation.experiments.list({
19414
+ from: "from",
19415
+ take: 1,
19416
+ status: "draft",
19417
+ authentication_flow: "authentication_flow",
19418
+ feature_flag_id: "feature_flag_id",
19419
+ });
19420
+ for await (const item of pageableResponse) {
19421
+ console.log(item);
19422
+ }
19423
+
19424
+ // Or you can manually iterate page-by-page
19425
+ let page = await client.experimentation.experiments.list({
19426
+ from: "from",
19427
+ take: 1,
19428
+ status: "draft",
19429
+ authentication_flow: "authentication_flow",
19430
+ feature_flag_id: "feature_flag_id",
19431
+ });
19432
+ while (page.hasNextPage()) {
19433
+ page = page.getNextPage();
19434
+ }
19435
+
19436
+ // You can also access the underlying response
19437
+ const response = page.response;
19438
+ ```
19439
+
19440
+ </dd>
19441
+ </dl>
19442
+ </dd>
19443
+ </dl>
19444
+
19445
+ #### ⚙️ Parameters
19446
+
19447
+ <dl>
19448
+ <dd>
19449
+
19450
+ <dl>
19451
+ <dd>
19452
+
19453
+ **request:** `Management.ListExperimentsRequestParameters`
19454
+
19455
+ </dd>
19456
+ </dl>
19457
+
19458
+ <dl>
19459
+ <dd>
19460
+
19461
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19462
+
19463
+ </dd>
19464
+ </dl>
19465
+ </dd>
19466
+ </dl>
19467
+
19468
+ </dd>
19469
+ </dl>
19470
+ </details>
19471
+
19472
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">create</a>({ ...params }) -> Management.CreateExperimentResponseContent</code></summary>
19473
+ <dl>
19474
+ <dd>
19475
+
19476
+ #### 📝 Description
19477
+
19478
+ <dl>
19479
+ <dd>
19480
+
19481
+ <dl>
19482
+ <dd>
19483
+
19484
+ Create a new experiment for A/B testing.
19485
+
19486
+ </dd>
19487
+ </dl>
19488
+ </dd>
19489
+ </dl>
19490
+
19491
+ #### 🔌 Usage
19492
+
19493
+ <dl>
19494
+ <dd>
19495
+
19496
+ <dl>
19497
+ <dd>
19498
+
19499
+ ```typescript
19500
+ await client.experimentation.experiments.create({
19501
+ name: "name",
19502
+ feature_flag_id: "feature_flag_id",
19503
+ authentication_flow: "authentication",
19504
+ });
19505
+ ```
19506
+
19507
+ </dd>
19508
+ </dl>
19509
+ </dd>
19510
+ </dl>
19511
+
19512
+ #### ⚙️ Parameters
19513
+
19514
+ <dl>
19515
+ <dd>
19516
+
19517
+ <dl>
19518
+ <dd>
19519
+
19520
+ **request:** `Management.CreateExperimentRequestContent`
19521
+
19522
+ </dd>
19523
+ </dl>
19524
+
19525
+ <dl>
19526
+ <dd>
19527
+
19528
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19529
+
19530
+ </dd>
19531
+ </dl>
19532
+ </dd>
19533
+ </dl>
19534
+
19535
+ </dd>
19536
+ </dl>
19537
+ </details>
19538
+
19539
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">get</a>(id) -> Management.GetExperimentResponseContent</code></summary>
19540
+ <dl>
19541
+ <dd>
19542
+
19543
+ #### 📝 Description
19544
+
19545
+ <dl>
19546
+ <dd>
19547
+
19548
+ <dl>
19549
+ <dd>
19550
+
19551
+ Retrieve a single experiment with its allocations by ID.
19552
+
19553
+ </dd>
19554
+ </dl>
19555
+ </dd>
19556
+ </dl>
19557
+
19558
+ #### 🔌 Usage
19559
+
19560
+ <dl>
19561
+ <dd>
19562
+
19563
+ <dl>
19564
+ <dd>
19565
+
19566
+ ```typescript
19567
+ await client.experimentation.experiments.get("id");
19568
+ ```
19569
+
19570
+ </dd>
19571
+ </dl>
19572
+ </dd>
19573
+ </dl>
19574
+
19575
+ #### ⚙️ Parameters
19576
+
19577
+ <dl>
19578
+ <dd>
19579
+
19580
+ <dl>
19581
+ <dd>
19582
+
19583
+ **id:** `string` — The ID of the experiment to retrieve.
19584
+
19585
+ </dd>
19586
+ </dl>
19587
+
19588
+ <dl>
19589
+ <dd>
19590
+
19591
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19592
+
19593
+ </dd>
19594
+ </dl>
19595
+ </dd>
19596
+ </dl>
19597
+
19598
+ </dd>
19599
+ </dl>
19600
+ </details>
19601
+
19602
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">delete</a>(id) -> void</code></summary>
19603
+ <dl>
19604
+ <dd>
19605
+
19606
+ #### 📝 Description
19607
+
19608
+ <dl>
19609
+ <dd>
19610
+
19611
+ <dl>
19612
+ <dd>
19613
+
19614
+ Permanently delete an experiment and its allocations by ID. Active experiments cannot be deleted; pause or complete first. Idempotent: returns 204 even if the experiment does not exist.
19615
+
19616
+ </dd>
19617
+ </dl>
19618
+ </dd>
19619
+ </dl>
19620
+
19621
+ #### 🔌 Usage
19622
+
19623
+ <dl>
19624
+ <dd>
19625
+
19626
+ <dl>
19627
+ <dd>
19628
+
19629
+ ```typescript
19630
+ await client.experimentation.experiments.delete("id");
19631
+ ```
19632
+
19633
+ </dd>
19634
+ </dl>
19635
+ </dd>
19636
+ </dl>
19637
+
19638
+ #### ⚙️ Parameters
19639
+
19640
+ <dl>
19641
+ <dd>
19642
+
19643
+ <dl>
19644
+ <dd>
19645
+
19646
+ **id:** `string` — The ID of the experiment to delete.
19647
+
19648
+ </dd>
19649
+ </dl>
19650
+
19651
+ <dl>
19652
+ <dd>
19653
+
19654
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19655
+
19656
+ </dd>
19657
+ </dl>
19658
+ </dd>
19659
+ </dl>
19660
+
19661
+ </dd>
19662
+ </dl>
19663
+ </details>
19664
+
19665
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateExperimentResponseContent</code></summary>
19666
+ <dl>
19667
+ <dd>
19668
+
19669
+ #### 📝 Description
19670
+
19671
+ <dl>
19672
+ <dd>
19673
+
19674
+ <dl>
19675
+ <dd>
19676
+
19677
+ Partially update an experiment by ID. Only provided fields are updated. Providing allocations replaces the entire allocations set.
19678
+
19679
+ </dd>
19680
+ </dl>
19681
+ </dd>
19682
+ </dl>
19683
+
19684
+ #### 🔌 Usage
19685
+
19686
+ <dl>
19687
+ <dd>
19688
+
19689
+ <dl>
19690
+ <dd>
19691
+
19692
+ ```typescript
19693
+ await client.experimentation.experiments.update("id");
19694
+ ```
19695
+
19696
+ </dd>
19697
+ </dl>
19698
+ </dd>
19699
+ </dl>
19700
+
19701
+ #### ⚙️ Parameters
19702
+
19703
+ <dl>
19704
+ <dd>
19705
+
19706
+ <dl>
19707
+ <dd>
19708
+
19709
+ **id:** `string` — The ID of the experiment to update.
19710
+
19711
+ </dd>
19712
+ </dl>
19713
+
19714
+ <dl>
19715
+ <dd>
19716
+
19717
+ **request:** `Management.UpdateExperimentRequestParameters`
19718
+
19719
+ </dd>
19720
+ </dl>
19721
+
19722
+ <dl>
19723
+ <dd>
19724
+
19725
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19726
+
19727
+ </dd>
19728
+ </dl>
19729
+ </dd>
19730
+ </dl>
19731
+
19732
+ </dd>
19733
+ </dl>
19734
+ </details>
19735
+
19383
19736
  <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">advanceRamp</a>(id, { ...params }) -> Management.AdvanceRampResponseContent</code></summary>
19384
19737
  <dl>
19385
19738
  <dd>
@@ -19392,7 +19745,1270 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
19392
19745
  <dl>
19393
19746
  <dd>
19394
19747
 
19395
- Increments the current ramp index to the requested target level. Up-only: the target must be the immediate next level in the schedule. Idempotent: calling with the current level returns success without writing anything.
19748
+ Increments the current ramp index to the requested target level. Up-only: the target must be the immediate next level in the schedule. Idempotent: calling with the current level returns success without writing anything.
19749
+
19750
+ </dd>
19751
+ </dl>
19752
+ </dd>
19753
+ </dl>
19754
+
19755
+ #### 🔌 Usage
19756
+
19757
+ <dl>
19758
+ <dd>
19759
+
19760
+ <dl>
19761
+ <dd>
19762
+
19763
+ ```typescript
19764
+ await client.experimentation.experiments.advanceRamp("id", {
19765
+ target_level: 1,
19766
+ });
19767
+ ```
19768
+
19769
+ </dd>
19770
+ </dl>
19771
+ </dd>
19772
+ </dl>
19773
+
19774
+ #### ⚙️ Parameters
19775
+
19776
+ <dl>
19777
+ <dd>
19778
+
19779
+ <dl>
19780
+ <dd>
19781
+
19782
+ **id:** `string` — The ID of the experiment to advance.
19783
+
19784
+ </dd>
19785
+ </dl>
19786
+
19787
+ <dl>
19788
+ <dd>
19789
+
19790
+ **request:** `Management.AdvanceRampRequestContent`
19791
+
19792
+ </dd>
19793
+ </dl>
19794
+
19795
+ <dl>
19796
+ <dd>
19797
+
19798
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19799
+
19800
+ </dd>
19801
+ </dl>
19802
+ </dd>
19803
+ </dl>
19804
+
19805
+ </dd>
19806
+ </dl>
19807
+ </details>
19808
+
19809
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">updateStatus</a>(id, { ...params }) -> Management.UpdateExperimentStatusResponseContent</code></summary>
19810
+ <dl>
19811
+ <dd>
19812
+
19813
+ #### 📝 Description
19814
+
19815
+ <dl>
19816
+ <dd>
19817
+
19818
+ <dl>
19819
+ <dd>
19820
+
19821
+ Transitions an experiment through its lifecycle: draft → active, active → paused, paused → active, active/paused → completed. Activation runs full readiness validation.
19822
+
19823
+ </dd>
19824
+ </dl>
19825
+ </dd>
19826
+ </dl>
19827
+
19828
+ #### 🔌 Usage
19829
+
19830
+ <dl>
19831
+ <dd>
19832
+
19833
+ <dl>
19834
+ <dd>
19835
+
19836
+ ```typescript
19837
+ await client.experimentation.experiments.updateStatus("id", {
19838
+ status: "active",
19839
+ });
19840
+ ```
19841
+
19842
+ </dd>
19843
+ </dl>
19844
+ </dd>
19845
+ </dl>
19846
+
19847
+ #### ⚙️ Parameters
19848
+
19849
+ <dl>
19850
+ <dd>
19851
+
19852
+ <dl>
19853
+ <dd>
19854
+
19855
+ **id:** `string` — The ID of the experiment to transition.
19856
+
19857
+ </dd>
19858
+ </dl>
19859
+
19860
+ <dl>
19861
+ <dd>
19862
+
19863
+ **request:** `Management.UpdateExperimentStatusRequestContent`
19864
+
19865
+ </dd>
19866
+ </dl>
19867
+
19868
+ <dl>
19869
+ <dd>
19870
+
19871
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19872
+
19873
+ </dd>
19874
+ </dl>
19875
+ </dd>
19876
+ </dl>
19877
+
19878
+ </dd>
19879
+ </dl>
19880
+ </details>
19881
+
19882
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">validate</a>(id) -> Management.ValidateExperimentResponseContent</code></summary>
19883
+ <dl>
19884
+ <dd>
19885
+
19886
+ #### 📝 Description
19887
+
19888
+ <dl>
19889
+ <dd>
19890
+
19891
+ <dl>
19892
+ <dd>
19893
+
19894
+ Checks whether an experiment is ready to be activated. Returns is_valid boolean and an errors array describing any blockers. Read-only; no state is modified.
19895
+
19896
+ </dd>
19897
+ </dl>
19898
+ </dd>
19899
+ </dl>
19900
+
19901
+ #### 🔌 Usage
19902
+
19903
+ <dl>
19904
+ <dd>
19905
+
19906
+ <dl>
19907
+ <dd>
19908
+
19909
+ ```typescript
19910
+ await client.experimentation.experiments.validate("id");
19911
+ ```
19912
+
19913
+ </dd>
19914
+ </dl>
19915
+ </dd>
19916
+ </dl>
19917
+
19918
+ #### ⚙️ Parameters
19919
+
19920
+ <dl>
19921
+ <dd>
19922
+
19923
+ <dl>
19924
+ <dd>
19925
+
19926
+ **id:** `string` — The ID of the experiment to validate.
19927
+
19928
+ </dd>
19929
+ </dl>
19930
+
19931
+ <dl>
19932
+ <dd>
19933
+
19934
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19935
+
19936
+ </dd>
19937
+ </dl>
19938
+ </dd>
19939
+ </dl>
19940
+
19941
+ </dd>
19942
+ </dl>
19943
+ </details>
19944
+
19945
+ ## Experimentation FeatureFlags
19946
+
19947
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.FeatureFlag, Management.ListFeatureFlagsResponseContent&gt;</code></summary>
19948
+ <dl>
19949
+ <dd>
19950
+
19951
+ #### 📝 Description
19952
+
19953
+ <dl>
19954
+ <dd>
19955
+
19956
+ <dl>
19957
+ <dd>
19958
+
19959
+ Retrieve a paginated list of feature flags for the tenant.
19960
+
19961
+ </dd>
19962
+ </dl>
19963
+ </dd>
19964
+ </dl>
19965
+
19966
+ #### 🔌 Usage
19967
+
19968
+ <dl>
19969
+ <dd>
19970
+
19971
+ <dl>
19972
+ <dd>
19973
+
19974
+ ```typescript
19975
+ const pageableResponse = await client.experimentation.featureFlags.list({
19976
+ from: "from",
19977
+ take: 1,
19978
+ type: "auth0",
19979
+ status: "draft",
19980
+ });
19981
+ for await (const item of pageableResponse) {
19982
+ console.log(item);
19983
+ }
19984
+
19985
+ // Or you can manually iterate page-by-page
19986
+ let page = await client.experimentation.featureFlags.list({
19987
+ from: "from",
19988
+ take: 1,
19989
+ type: "auth0",
19990
+ status: "draft",
19991
+ });
19992
+ while (page.hasNextPage()) {
19993
+ page = page.getNextPage();
19994
+ }
19995
+
19996
+ // You can also access the underlying response
19997
+ const response = page.response;
19998
+ ```
19999
+
20000
+ </dd>
20001
+ </dl>
20002
+ </dd>
20003
+ </dl>
20004
+
20005
+ #### ⚙️ Parameters
20006
+
20007
+ <dl>
20008
+ <dd>
20009
+
20010
+ <dl>
20011
+ <dd>
20012
+
20013
+ **request:** `Management.ListFeatureFlagsRequestParameters`
20014
+
20015
+ </dd>
20016
+ </dl>
20017
+
20018
+ <dl>
20019
+ <dd>
20020
+
20021
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20022
+
20023
+ </dd>
20024
+ </dl>
20025
+ </dd>
20026
+ </dl>
20027
+
20028
+ </dd>
20029
+ </dl>
20030
+ </details>
20031
+
20032
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">create</a>({ ...params }) -> Management.CreateFeatureFlagResponseContent</code></summary>
20033
+ <dl>
20034
+ <dd>
20035
+
20036
+ #### 📝 Description
20037
+
20038
+ <dl>
20039
+ <dd>
20040
+
20041
+ <dl>
20042
+ <dd>
20043
+
20044
+ Create a new feature flag with parameters for use in experiments.
20045
+
20046
+ </dd>
20047
+ </dl>
20048
+ </dd>
20049
+ </dl>
20050
+
20051
+ #### 🔌 Usage
20052
+
20053
+ <dl>
20054
+ <dd>
20055
+
20056
+ <dl>
20057
+ <dd>
20058
+
20059
+ ```typescript
20060
+ await client.experimentation.featureFlags.create({
20061
+ name: "name",
20062
+ parameters: {},
20063
+ });
20064
+ ```
20065
+
20066
+ </dd>
20067
+ </dl>
20068
+ </dd>
20069
+ </dl>
20070
+
20071
+ #### ⚙️ Parameters
20072
+
20073
+ <dl>
20074
+ <dd>
20075
+
20076
+ <dl>
20077
+ <dd>
20078
+
20079
+ **request:** `Management.CreateFeatureFlagRequestContent`
20080
+
20081
+ </dd>
20082
+ </dl>
20083
+
20084
+ <dl>
20085
+ <dd>
20086
+
20087
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20088
+
20089
+ </dd>
20090
+ </dl>
20091
+ </dd>
20092
+ </dl>
20093
+
20094
+ </dd>
20095
+ </dl>
20096
+ </details>
20097
+
20098
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">get</a>(id) -> Management.GetFeatureFlagResponseContent</code></summary>
20099
+ <dl>
20100
+ <dd>
20101
+
20102
+ #### 📝 Description
20103
+
20104
+ <dl>
20105
+ <dd>
20106
+
20107
+ <dl>
20108
+ <dd>
20109
+
20110
+ Retrieve a single feature flag by its ID.
20111
+
20112
+ </dd>
20113
+ </dl>
20114
+ </dd>
20115
+ </dl>
20116
+
20117
+ #### 🔌 Usage
20118
+
20119
+ <dl>
20120
+ <dd>
20121
+
20122
+ <dl>
20123
+ <dd>
20124
+
20125
+ ```typescript
20126
+ await client.experimentation.featureFlags.get("id");
20127
+ ```
20128
+
20129
+ </dd>
20130
+ </dl>
20131
+ </dd>
20132
+ </dl>
20133
+
20134
+ #### ⚙️ Parameters
20135
+
20136
+ <dl>
20137
+ <dd>
20138
+
20139
+ <dl>
20140
+ <dd>
20141
+
20142
+ **id:** `string` — The ID of the feature flag to retrieve.
20143
+
20144
+ </dd>
20145
+ </dl>
20146
+
20147
+ <dl>
20148
+ <dd>
20149
+
20150
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20151
+
20152
+ </dd>
20153
+ </dl>
20154
+ </dd>
20155
+ </dl>
20156
+
20157
+ </dd>
20158
+ </dl>
20159
+ </details>
20160
+
20161
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">delete</a>(id) -> void</code></summary>
20162
+ <dl>
20163
+ <dd>
20164
+
20165
+ #### 📝 Description
20166
+
20167
+ <dl>
20168
+ <dd>
20169
+
20170
+ <dl>
20171
+ <dd>
20172
+
20173
+ Delete a feature flag by ID. Idempotent: returns 204 even if flag does not exist.
20174
+
20175
+ </dd>
20176
+ </dl>
20177
+ </dd>
20178
+ </dl>
20179
+
20180
+ #### 🔌 Usage
20181
+
20182
+ <dl>
20183
+ <dd>
20184
+
20185
+ <dl>
20186
+ <dd>
20187
+
20188
+ ```typescript
20189
+ await client.experimentation.featureFlags.delete("id");
20190
+ ```
20191
+
20192
+ </dd>
20193
+ </dl>
20194
+ </dd>
20195
+ </dl>
20196
+
20197
+ #### ⚙️ Parameters
20198
+
20199
+ <dl>
20200
+ <dd>
20201
+
20202
+ <dl>
20203
+ <dd>
20204
+
20205
+ **id:** `string` — The ID of the feature flag to delete.
20206
+
20207
+ </dd>
20208
+ </dl>
20209
+
20210
+ <dl>
20211
+ <dd>
20212
+
20213
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20214
+
20215
+ </dd>
20216
+ </dl>
20217
+ </dd>
20218
+ </dl>
20219
+
20220
+ </dd>
20221
+ </dl>
20222
+ </details>
20223
+
20224
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateFeatureFlagResponseContent</code></summary>
20225
+ <dl>
20226
+ <dd>
20227
+
20228
+ #### 📝 Description
20229
+
20230
+ <dl>
20231
+ <dd>
20232
+
20233
+ <dl>
20234
+ <dd>
20235
+
20236
+ Partially update a feature flag by ID. Only provided fields are updated.
20237
+
20238
+ </dd>
20239
+ </dl>
20240
+ </dd>
20241
+ </dl>
20242
+
20243
+ #### 🔌 Usage
20244
+
20245
+ <dl>
20246
+ <dd>
20247
+
20248
+ <dl>
20249
+ <dd>
20250
+
20251
+ ```typescript
20252
+ await client.experimentation.featureFlags.update("id");
20253
+ ```
20254
+
20255
+ </dd>
20256
+ </dl>
20257
+ </dd>
20258
+ </dl>
20259
+
20260
+ #### ⚙️ Parameters
20261
+
20262
+ <dl>
20263
+ <dd>
20264
+
20265
+ <dl>
20266
+ <dd>
20267
+
20268
+ **id:** `string` — The ID of the feature flag to update.
20269
+
20270
+ </dd>
20271
+ </dl>
20272
+
20273
+ <dl>
20274
+ <dd>
20275
+
20276
+ **request:** `Management.UpdateFeatureFlagRequestContent`
20277
+
20278
+ </dd>
20279
+ </dl>
20280
+
20281
+ <dl>
20282
+ <dd>
20283
+
20284
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20285
+
20286
+ </dd>
20287
+ </dl>
20288
+ </dd>
20289
+ </dl>
20290
+
20291
+ </dd>
20292
+ </dl>
20293
+ </details>
20294
+
20295
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">updateStatus</a>(id, { ...params }) -> Management.UpdateFeatureFlagStatusResponseContent</code></summary>
20296
+ <dl>
20297
+ <dd>
20298
+
20299
+ #### 📝 Description
20300
+
20301
+ <dl>
20302
+ <dd>
20303
+
20304
+ <dl>
20305
+ <dd>
20306
+
20307
+ Transitions a feature flag through its lifecycle states: draft → active, draft → archived, active → archived.
20308
+
20309
+ </dd>
20310
+ </dl>
20311
+ </dd>
20312
+ </dl>
20313
+
20314
+ #### 🔌 Usage
20315
+
20316
+ <dl>
20317
+ <dd>
20318
+
20319
+ <dl>
20320
+ <dd>
20321
+
20322
+ ```typescript
20323
+ await client.experimentation.featureFlags.updateStatus("id", {
20324
+ status: "draft",
20325
+ });
20326
+ ```
20327
+
20328
+ </dd>
20329
+ </dl>
20330
+ </dd>
20331
+ </dl>
20332
+
20333
+ #### ⚙️ Parameters
20334
+
20335
+ <dl>
20336
+ <dd>
20337
+
20338
+ <dl>
20339
+ <dd>
20340
+
20341
+ **id:** `string` — The ID of the feature flag to transition.
20342
+
20343
+ </dd>
20344
+ </dl>
20345
+
20346
+ <dl>
20347
+ <dd>
20348
+
20349
+ **request:** `Management.UpdateFeatureFlagStatusRequestContent`
20350
+
20351
+ </dd>
20352
+ </dl>
20353
+
20354
+ <dl>
20355
+ <dd>
20356
+
20357
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20358
+
20359
+ </dd>
20360
+ </dl>
20361
+ </dd>
20362
+ </dl>
20363
+
20364
+ </dd>
20365
+ </dl>
20366
+ </details>
20367
+
20368
+ ## Experimentation Segments
20369
+
20370
+ <details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.Segment, Management.ListSegmentsResponseContent&gt;</code></summary>
20371
+ <dl>
20372
+ <dd>
20373
+
20374
+ #### 📝 Description
20375
+
20376
+ <dl>
20377
+ <dd>
20378
+
20379
+ <dl>
20380
+ <dd>
20381
+
20382
+ Retrieve a paginated list of segments for the tenant.
20383
+
20384
+ </dd>
20385
+ </dl>
20386
+ </dd>
20387
+ </dl>
20388
+
20389
+ #### 🔌 Usage
20390
+
20391
+ <dl>
20392
+ <dd>
20393
+
20394
+ <dl>
20395
+ <dd>
20396
+
20397
+ ```typescript
20398
+ const pageableResponse = await client.experimentation.segments.list({
20399
+ from: "from",
20400
+ take: 1,
20401
+ type: "auth0",
20402
+ });
20403
+ for await (const item of pageableResponse) {
20404
+ console.log(item);
20405
+ }
20406
+
20407
+ // Or you can manually iterate page-by-page
20408
+ let page = await client.experimentation.segments.list({
20409
+ from: "from",
20410
+ take: 1,
20411
+ type: "auth0",
20412
+ });
20413
+ while (page.hasNextPage()) {
20414
+ page = page.getNextPage();
20415
+ }
20416
+
20417
+ // You can also access the underlying response
20418
+ const response = page.response;
20419
+ ```
20420
+
20421
+ </dd>
20422
+ </dl>
20423
+ </dd>
20424
+ </dl>
20425
+
20426
+ #### ⚙️ Parameters
20427
+
20428
+ <dl>
20429
+ <dd>
20430
+
20431
+ <dl>
20432
+ <dd>
20433
+
20434
+ **request:** `Management.ListSegmentsRequestParameters`
20435
+
20436
+ </dd>
20437
+ </dl>
20438
+
20439
+ <dl>
20440
+ <dd>
20441
+
20442
+ **requestOptions:** `SegmentsClient.RequestOptions`
20443
+
20444
+ </dd>
20445
+ </dl>
20446
+ </dd>
20447
+ </dl>
20448
+
20449
+ </dd>
20450
+ </dl>
20451
+ </details>
20452
+
20453
+ <details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">create</a>({ ...params }) -> Management.CreateSegmentResponseContent</code></summary>
20454
+ <dl>
20455
+ <dd>
20456
+
20457
+ #### 📝 Description
20458
+
20459
+ <dl>
20460
+ <dd>
20461
+
20462
+ <dl>
20463
+ <dd>
20464
+
20465
+ Create a new segment with rule-based membership criteria for use in experiments.
20466
+
20467
+ </dd>
20468
+ </dl>
20469
+ </dd>
20470
+ </dl>
20471
+
20472
+ #### 🔌 Usage
20473
+
20474
+ <dl>
20475
+ <dd>
20476
+
20477
+ <dl>
20478
+ <dd>
20479
+
20480
+ ```typescript
20481
+ await client.experimentation.segments.create({
20482
+ name: "name",
20483
+ rules: [{}],
20484
+ });
20485
+ ```
20486
+
20487
+ </dd>
20488
+ </dl>
20489
+ </dd>
20490
+ </dl>
20491
+
20492
+ #### ⚙️ Parameters
20493
+
20494
+ <dl>
20495
+ <dd>
20496
+
20497
+ <dl>
20498
+ <dd>
20499
+
20500
+ **request:** `Management.CreateSegmentRequestContent`
20501
+
20502
+ </dd>
20503
+ </dl>
20504
+
20505
+ <dl>
20506
+ <dd>
20507
+
20508
+ **requestOptions:** `SegmentsClient.RequestOptions`
20509
+
20510
+ </dd>
20511
+ </dl>
20512
+ </dd>
20513
+ </dl>
20514
+
20515
+ </dd>
20516
+ </dl>
20517
+ </details>
20518
+
20519
+ <details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">get</a>(id) -> Management.GetSegmentResponseContent</code></summary>
20520
+ <dl>
20521
+ <dd>
20522
+
20523
+ #### 📝 Description
20524
+
20525
+ <dl>
20526
+ <dd>
20527
+
20528
+ <dl>
20529
+ <dd>
20530
+
20531
+ Retrieve a single segment by its ID.
20532
+
20533
+ </dd>
20534
+ </dl>
20535
+ </dd>
20536
+ </dl>
20537
+
20538
+ #### 🔌 Usage
20539
+
20540
+ <dl>
20541
+ <dd>
20542
+
20543
+ <dl>
20544
+ <dd>
20545
+
20546
+ ```typescript
20547
+ await client.experimentation.segments.get("id");
20548
+ ```
20549
+
20550
+ </dd>
20551
+ </dl>
20552
+ </dd>
20553
+ </dl>
20554
+
20555
+ #### ⚙️ Parameters
20556
+
20557
+ <dl>
20558
+ <dd>
20559
+
20560
+ <dl>
20561
+ <dd>
20562
+
20563
+ **id:** `string` — The ID of the segment to retrieve.
20564
+
20565
+ </dd>
20566
+ </dl>
20567
+
20568
+ <dl>
20569
+ <dd>
20570
+
20571
+ **requestOptions:** `SegmentsClient.RequestOptions`
20572
+
20573
+ </dd>
20574
+ </dl>
20575
+ </dd>
20576
+ </dl>
20577
+
20578
+ </dd>
20579
+ </dl>
20580
+ </details>
20581
+
20582
+ <details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">delete</a>(id) -> void</code></summary>
20583
+ <dl>
20584
+ <dd>
20585
+
20586
+ #### 📝 Description
20587
+
20588
+ <dl>
20589
+ <dd>
20590
+
20591
+ <dl>
20592
+ <dd>
20593
+
20594
+ Delete a segment by ID. Idempotent: returns 204 even if segment does not exist.
20595
+
20596
+ </dd>
20597
+ </dl>
20598
+ </dd>
20599
+ </dl>
20600
+
20601
+ #### 🔌 Usage
20602
+
20603
+ <dl>
20604
+ <dd>
20605
+
20606
+ <dl>
20607
+ <dd>
20608
+
20609
+ ```typescript
20610
+ await client.experimentation.segments.delete("id");
20611
+ ```
20612
+
20613
+ </dd>
20614
+ </dl>
20615
+ </dd>
20616
+ </dl>
20617
+
20618
+ #### ⚙️ Parameters
20619
+
20620
+ <dl>
20621
+ <dd>
20622
+
20623
+ <dl>
20624
+ <dd>
20625
+
20626
+ **id:** `string` — The ID of the segment to delete.
20627
+
20628
+ </dd>
20629
+ </dl>
20630
+
20631
+ <dl>
20632
+ <dd>
20633
+
20634
+ **requestOptions:** `SegmentsClient.RequestOptions`
20635
+
20636
+ </dd>
20637
+ </dl>
20638
+ </dd>
20639
+ </dl>
20640
+
20641
+ </dd>
20642
+ </dl>
20643
+ </details>
20644
+
20645
+ <details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateSegmentResponseContent</code></summary>
20646
+ <dl>
20647
+ <dd>
20648
+
20649
+ #### 📝 Description
20650
+
20651
+ <dl>
20652
+ <dd>
20653
+
20654
+ <dl>
20655
+ <dd>
20656
+
20657
+ Partially update a segment by ID. Only provided fields are updated. Sending rules replaces the entire rules array.
20658
+
20659
+ </dd>
20660
+ </dl>
20661
+ </dd>
20662
+ </dl>
20663
+
20664
+ #### 🔌 Usage
20665
+
20666
+ <dl>
20667
+ <dd>
20668
+
20669
+ <dl>
20670
+ <dd>
20671
+
20672
+ ```typescript
20673
+ await client.experimentation.segments.update("id");
20674
+ ```
20675
+
20676
+ </dd>
20677
+ </dl>
20678
+ </dd>
20679
+ </dl>
20680
+
20681
+ #### ⚙️ Parameters
20682
+
20683
+ <dl>
20684
+ <dd>
20685
+
20686
+ <dl>
20687
+ <dd>
20688
+
20689
+ **id:** `string` — The ID of the segment to update.
20690
+
20691
+ </dd>
20692
+ </dl>
20693
+
20694
+ <dl>
20695
+ <dd>
20696
+
20697
+ **request:** `Management.UpdateSegmentRequestContent`
20698
+
20699
+ </dd>
20700
+ </dl>
20701
+
20702
+ <dl>
20703
+ <dd>
20704
+
20705
+ **requestOptions:** `SegmentsClient.RequestOptions`
20706
+
20707
+ </dd>
20708
+ </dl>
20709
+ </dd>
20710
+ </dl>
20711
+
20712
+ </dd>
20713
+ </dl>
20714
+ </details>
20715
+
20716
+ ## Experimentation FeatureFlags Variations
20717
+
20718
+ <details><summary><code>client.experimentation.featureFlags.variations.<a href="/src/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.ts">list</a>(id) -> Management.ListVariationsResponseContent</code></summary>
20719
+ <dl>
20720
+ <dd>
20721
+
20722
+ #### 📝 Description
20723
+
20724
+ <dl>
20725
+ <dd>
20726
+
20727
+ <dl>
20728
+ <dd>
20729
+
20730
+ Retrieve all variations defined for a specific feature flag.
20731
+
20732
+ </dd>
20733
+ </dl>
20734
+ </dd>
20735
+ </dl>
20736
+
20737
+ #### 🔌 Usage
20738
+
20739
+ <dl>
20740
+ <dd>
20741
+
20742
+ <dl>
20743
+ <dd>
20744
+
20745
+ ```typescript
20746
+ await client.experimentation.featureFlags.variations.list("id");
20747
+ ```
20748
+
20749
+ </dd>
20750
+ </dl>
20751
+ </dd>
20752
+ </dl>
20753
+
20754
+ #### ⚙️ Parameters
20755
+
20756
+ <dl>
20757
+ <dd>
20758
+
20759
+ <dl>
20760
+ <dd>
20761
+
20762
+ **id:** `string` — The ID of the parent feature flag.
20763
+
20764
+ </dd>
20765
+ </dl>
20766
+
20767
+ <dl>
20768
+ <dd>
20769
+
20770
+ **requestOptions:** `VariationsClient.RequestOptions`
20771
+
20772
+ </dd>
20773
+ </dl>
20774
+ </dd>
20775
+ </dl>
20776
+
20777
+ </dd>
20778
+ </dl>
20779
+ </details>
20780
+
20781
+ <details><summary><code>client.experimentation.featureFlags.variations.<a href="/src/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateVariationResponseContent</code></summary>
20782
+ <dl>
20783
+ <dd>
20784
+
20785
+ #### 📝 Description
20786
+
20787
+ <dl>
20788
+ <dd>
20789
+
20790
+ <dl>
20791
+ <dd>
20792
+
20793
+ Create a new variation with parameter overrides for a specific feature flag.
20794
+
20795
+ </dd>
20796
+ </dl>
20797
+ </dd>
20798
+ </dl>
20799
+
20800
+ #### 🔌 Usage
20801
+
20802
+ <dl>
20803
+ <dd>
20804
+
20805
+ <dl>
20806
+ <dd>
20807
+
20808
+ ```typescript
20809
+ await client.experimentation.featureFlags.variations.create("id", {
20810
+ name: "name",
20811
+ overrides: {
20812
+ key: "value",
20813
+ },
20814
+ });
20815
+ ```
20816
+
20817
+ </dd>
20818
+ </dl>
20819
+ </dd>
20820
+ </dl>
20821
+
20822
+ #### ⚙️ Parameters
20823
+
20824
+ <dl>
20825
+ <dd>
20826
+
20827
+ <dl>
20828
+ <dd>
20829
+
20830
+ **id:** `string` — The ID of the parent feature flag.
20831
+
20832
+ </dd>
20833
+ </dl>
20834
+
20835
+ <dl>
20836
+ <dd>
20837
+
20838
+ **request:** `Management.CreateVariationRequestContent`
20839
+
20840
+ </dd>
20841
+ </dl>
20842
+
20843
+ <dl>
20844
+ <dd>
20845
+
20846
+ **requestOptions:** `VariationsClient.RequestOptions`
20847
+
20848
+ </dd>
20849
+ </dl>
20850
+ </dd>
20851
+ </dl>
20852
+
20853
+ </dd>
20854
+ </dl>
20855
+ </details>
20856
+
20857
+ <details><summary><code>client.experimentation.featureFlags.variations.<a href="/src/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.ts">get</a>(id, vid) -> Management.GetVariationResponseContent</code></summary>
20858
+ <dl>
20859
+ <dd>
20860
+
20861
+ #### 📝 Description
20862
+
20863
+ <dl>
20864
+ <dd>
20865
+
20866
+ <dl>
20867
+ <dd>
20868
+
20869
+ Retrieve a single variation by its ID.
20870
+
20871
+ </dd>
20872
+ </dl>
20873
+ </dd>
20874
+ </dl>
20875
+
20876
+ #### 🔌 Usage
20877
+
20878
+ <dl>
20879
+ <dd>
20880
+
20881
+ <dl>
20882
+ <dd>
20883
+
20884
+ ```typescript
20885
+ await client.experimentation.featureFlags.variations.get("id", "vid");
20886
+ ```
20887
+
20888
+ </dd>
20889
+ </dl>
20890
+ </dd>
20891
+ </dl>
20892
+
20893
+ #### ⚙️ Parameters
20894
+
20895
+ <dl>
20896
+ <dd>
20897
+
20898
+ <dl>
20899
+ <dd>
20900
+
20901
+ **id:** `string` — The ID of the parent feature flag.
20902
+
20903
+ </dd>
20904
+ </dl>
20905
+
20906
+ <dl>
20907
+ <dd>
20908
+
20909
+ **vid:** `string` — The ID of the variation to retrieve.
20910
+
20911
+ </dd>
20912
+ </dl>
20913
+
20914
+ <dl>
20915
+ <dd>
20916
+
20917
+ **requestOptions:** `VariationsClient.RequestOptions`
20918
+
20919
+ </dd>
20920
+ </dl>
20921
+ </dd>
20922
+ </dl>
20923
+
20924
+ </dd>
20925
+ </dl>
20926
+ </details>
20927
+
20928
+ <details><summary><code>client.experimentation.featureFlags.variations.<a href="/src/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.ts">delete</a>(id, vid) -> void</code></summary>
20929
+ <dl>
20930
+ <dd>
20931
+
20932
+ #### 📝 Description
20933
+
20934
+ <dl>
20935
+ <dd>
20936
+
20937
+ <dl>
20938
+ <dd>
20939
+
20940
+ Delete a variation by ID. Returns 204 if the variation does not exist. Returns 404 if the parent feature flag does not exist.
20941
+
20942
+ </dd>
20943
+ </dl>
20944
+ </dd>
20945
+ </dl>
20946
+
20947
+ #### 🔌 Usage
20948
+
20949
+ <dl>
20950
+ <dd>
20951
+
20952
+ <dl>
20953
+ <dd>
20954
+
20955
+ ```typescript
20956
+ await client.experimentation.featureFlags.variations.delete("id", "vid");
20957
+ ```
20958
+
20959
+ </dd>
20960
+ </dl>
20961
+ </dd>
20962
+ </dl>
20963
+
20964
+ #### ⚙️ Parameters
20965
+
20966
+ <dl>
20967
+ <dd>
20968
+
20969
+ <dl>
20970
+ <dd>
20971
+
20972
+ **id:** `string` — The ID of the parent feature flag.
20973
+
20974
+ </dd>
20975
+ </dl>
20976
+
20977
+ <dl>
20978
+ <dd>
20979
+
20980
+ **vid:** `string` — The ID of the variation to delete.
20981
+
20982
+ </dd>
20983
+ </dl>
20984
+
20985
+ <dl>
20986
+ <dd>
20987
+
20988
+ **requestOptions:** `VariationsClient.RequestOptions`
20989
+
20990
+ </dd>
20991
+ </dl>
20992
+ </dd>
20993
+ </dl>
20994
+
20995
+ </dd>
20996
+ </dl>
20997
+ </details>
20998
+
20999
+ <details><summary><code>client.experimentation.featureFlags.variations.<a href="/src/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.ts">update</a>(id, vid, { ...params }) -> Management.UpdateVariationResponseContent</code></summary>
21000
+ <dl>
21001
+ <dd>
21002
+
21003
+ #### 📝 Description
21004
+
21005
+ <dl>
21006
+ <dd>
21007
+
21008
+ <dl>
21009
+ <dd>
21010
+
21011
+ Partially update a variation by ID. Only provided fields are updated.
19396
21012
 
19397
21013
  </dd>
19398
21014
  </dl>
@@ -19408,9 +21024,7 @@ Increments the current ramp index to the requested target level. Up-only: the ta
19408
21024
  <dd>
19409
21025
 
19410
21026
  ```typescript
19411
- await client.experimentation.experiments.advanceRamp("id", {
19412
- target_level: 1,
19413
- });
21027
+ await client.experimentation.featureFlags.variations.update("id", "vid");
19414
21028
  ```
19415
21029
 
19416
21030
  </dd>
@@ -19426,7 +21040,7 @@ await client.experimentation.experiments.advanceRamp("id", {
19426
21040
  <dl>
19427
21041
  <dd>
19428
21042
 
19429
- **id:** `string` — The ID of the experiment to advance.
21043
+ **id:** `string` — The ID of the parent feature flag.
19430
21044
 
19431
21045
  </dd>
19432
21046
  </dl>
@@ -19434,7 +21048,7 @@ await client.experimentation.experiments.advanceRamp("id", {
19434
21048
  <dl>
19435
21049
  <dd>
19436
21050
 
19437
- **request:** `Management.AdvanceRampRequestContent`
21051
+ **vid:** `string` — The ID of the variation to update.
19438
21052
 
19439
21053
  </dd>
19440
21054
  </dl>
@@ -19442,7 +21056,15 @@ await client.experimentation.experiments.advanceRamp("id", {
19442
21056
  <dl>
19443
21057
  <dd>
19444
21058
 
19445
- **requestOptions:** `ExperimentsClient.RequestOptions`
21059
+ **request:** `Management.UpdateVariationRequestContent`
21060
+
21061
+ </dd>
21062
+ </dl>
21063
+
21064
+ <dl>
21065
+ <dd>
21066
+
21067
+ **requestOptions:** `VariationsClient.RequestOptions`
19446
21068
 
19447
21069
  </dd>
19448
21070
  </dl>
@@ -26697,213 +28319,6 @@ await client.organizations.members.delete("id", {
26697
28319
  </dl>
26698
28320
  </details>
26699
28321
 
26700
- ## Organizations OrganizationTemplate
26701
-
26702
- <details><summary><code>client.organizations.organizationTemplate.<a href="/src/management/api/resources/organizations/resources/organizationTemplate/client/Client.ts">get</a>(id) -> Management.OrganizationTemplate</code></summary>
26703
- <dl>
26704
- <dd>
26705
-
26706
- #### 📝 Description
26707
-
26708
- <dl>
26709
- <dd>
26710
-
26711
- <dl>
26712
- <dd>
26713
-
26714
- Retrieve the organization template assigned to a specific organization. Returns the template object if one is explicitly assigned, or a 404 if no template is assigned.
26715
-
26716
- </dd>
26717
- </dl>
26718
- </dd>
26719
- </dl>
26720
-
26721
- #### 🔌 Usage
26722
-
26723
- <dl>
26724
- <dd>
26725
-
26726
- <dl>
26727
- <dd>
26728
-
26729
- ```typescript
26730
- await client.organizations.organizationTemplate.get("id");
26731
- ```
26732
-
26733
- </dd>
26734
- </dl>
26735
- </dd>
26736
- </dl>
26737
-
26738
- #### ⚙️ Parameters
26739
-
26740
- <dl>
26741
- <dd>
26742
-
26743
- <dl>
26744
- <dd>
26745
-
26746
- **id:** `string` — ID of the organization.
26747
-
26748
- </dd>
26749
- </dl>
26750
-
26751
- <dl>
26752
- <dd>
26753
-
26754
- **requestOptions:** `OrganizationTemplateClient.RequestOptions`
26755
-
26756
- </dd>
26757
- </dl>
26758
- </dd>
26759
- </dl>
26760
-
26761
- </dd>
26762
- </dl>
26763
- </details>
26764
-
26765
- <details><summary><code>client.organizations.organizationTemplate.<a href="/src/management/api/resources/organizations/resources/organizationTemplate/client/Client.ts">assignOrganizationTemplate</a>(id, template_id) -> void</code></summary>
26766
- <dl>
26767
- <dd>
26768
-
26769
- #### 📝 Description
26770
-
26771
- <dl>
26772
- <dd>
26773
-
26774
- <dl>
26775
- <dd>
26776
-
26777
- Assign an Organization Template to an organization.
26778
-
26779
- </dd>
26780
- </dl>
26781
- </dd>
26782
- </dl>
26783
-
26784
- #### 🔌 Usage
26785
-
26786
- <dl>
26787
- <dd>
26788
-
26789
- <dl>
26790
- <dd>
26791
-
26792
- ```typescript
26793
- await client.organizations.organizationTemplate.assignOrganizationTemplate("id", "template_id");
26794
- ```
26795
-
26796
- </dd>
26797
- </dl>
26798
- </dd>
26799
- </dl>
26800
-
26801
- #### ⚙️ Parameters
26802
-
26803
- <dl>
26804
- <dd>
26805
-
26806
- <dl>
26807
- <dd>
26808
-
26809
- **id:** `string` — The ID of the organization.
26810
-
26811
- </dd>
26812
- </dl>
26813
-
26814
- <dl>
26815
- <dd>
26816
-
26817
- **template_id:** `string` — The ID of the organization template to assign.
26818
-
26819
- </dd>
26820
- </dl>
26821
-
26822
- <dl>
26823
- <dd>
26824
-
26825
- **requestOptions:** `OrganizationTemplateClient.RequestOptions`
26826
-
26827
- </dd>
26828
- </dl>
26829
- </dd>
26830
- </dl>
26831
-
26832
- </dd>
26833
- </dl>
26834
- </details>
26835
-
26836
- <details><summary><code>client.organizations.organizationTemplate.<a href="/src/management/api/resources/organizations/resources/organizationTemplate/client/Client.ts">unassignOrganizationTemplate</a>(id, template_id) -> void</code></summary>
26837
- <dl>
26838
- <dd>
26839
-
26840
- #### 📝 Description
26841
-
26842
- <dl>
26843
- <dd>
26844
-
26845
- <dl>
26846
- <dd>
26847
-
26848
- Remove an Organization Template assignment from an organization.
26849
-
26850
- </dd>
26851
- </dl>
26852
- </dd>
26853
- </dl>
26854
-
26855
- #### 🔌 Usage
26856
-
26857
- <dl>
26858
- <dd>
26859
-
26860
- <dl>
26861
- <dd>
26862
-
26863
- ```typescript
26864
- await client.organizations.organizationTemplate.unassignOrganizationTemplate("id", "template_id");
26865
- ```
26866
-
26867
- </dd>
26868
- </dl>
26869
- </dd>
26870
- </dl>
26871
-
26872
- #### ⚙️ Parameters
26873
-
26874
- <dl>
26875
- <dd>
26876
-
26877
- <dl>
26878
- <dd>
26879
-
26880
- **id:** `string` — The ID of the organization.
26881
-
26882
- </dd>
26883
- </dl>
26884
-
26885
- <dl>
26886
- <dd>
26887
-
26888
- **template_id:** `string` — The ID of the organization template to unassign.
26889
-
26890
- </dd>
26891
- </dl>
26892
-
26893
- <dl>
26894
- <dd>
26895
-
26896
- **requestOptions:** `OrganizationTemplateClient.RequestOptions`
26897
-
26898
- </dd>
26899
- </dl>
26900
- </dd>
26901
- </dl>
26902
-
26903
- </dd>
26904
- </dl>
26905
- </details>
26906
-
26907
28322
  ## Organizations Groups
26908
28323
 
26909
28324
  <details><summary><code>client.organizations.groups.<a href="/src/management/api/resources/organizations/resources/groups/client/Client.ts">list</a>(organization_id, { ...params }) -> core.Page&lt;Management.Group, Management.ListOrganizationGroupsResponseContent&gt;</code></summary>