auth0 7.2.0 → 7.4.0-beta.1

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 (98) hide show
  1. package/README.md +5 -0
  2. package/dist/cjs/management/api/requests/requests.d.ts +238 -4
  3. package/dist/cjs/management/api/resources/clients/client/Client.d.ts +37 -0
  4. package/dist/cjs/management/api/resources/clients/client/Client.js +111 -0
  5. package/dist/cjs/management/api/resources/experimentation/client/Client.d.ts +6 -0
  6. package/dist/cjs/management/api/resources/experimentation/client/Client.js +10 -0
  7. package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.d.ts +133 -0
  8. package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.js +485 -0
  9. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.d.ts +126 -0
  10. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.js +471 -0
  11. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/exports.d.ts +3 -0
  12. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/exports.js +22 -0
  13. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/index.d.ts +2 -0
  14. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/index.js +18 -0
  15. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/index.d.ts +1 -0
  16. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/index.js +37 -0
  17. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.ts +109 -0
  18. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.js +390 -0
  19. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.js +2 -0
  20. package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/exports.d.ts +2 -0
  21. package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/exports.js +2 -2
  22. package/dist/cjs/management/api/resources/experimentation/resources/index.d.ts +2 -0
  23. package/dist/cjs/management/api/resources/experimentation/resources/index.js +3 -1
  24. package/dist/cjs/management/api/resources/experimentation/resources/segments/client/Client.d.ts +104 -0
  25. package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/segments}/client/Client.js +205 -39
  26. package/dist/cjs/management/api/resources/experimentation/resources/segments/client/index.js +2 -0
  27. package/dist/cjs/management/api/resources/experimentation/resources/segments/exports.d.ts +2 -0
  28. package/dist/cjs/management/api/resources/experimentation/resources/segments/exports.js +21 -0
  29. package/dist/cjs/management/api/resources/experimentation/resources/segments/index.d.ts +1 -0
  30. package/dist/cjs/management/api/resources/experimentation/resources/segments/index.js +17 -0
  31. package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +0 -3
  32. package/dist/cjs/management/api/resources/organizations/client/Client.js +2 -7
  33. package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +0 -1
  34. package/dist/cjs/management/api/resources/organizations/resources/index.js +1 -2
  35. package/dist/cjs/management/api/resources/users/client/Client.d.ts +8 -10
  36. package/dist/cjs/management/api/resources/users/client/Client.js +8 -10
  37. package/dist/cjs/management/api/types/types.d.ts +642 -91
  38. package/dist/cjs/management/api/types/types.js +109 -50
  39. package/dist/cjs/management/version.d.ts +1 -1
  40. package/dist/cjs/management/version.js +1 -1
  41. package/dist/esm/management/api/requests/requests.d.mts +238 -4
  42. package/dist/esm/management/api/resources/clients/client/Client.d.mts +37 -0
  43. package/dist/esm/management/api/resources/clients/client/Client.mjs +111 -0
  44. package/dist/esm/management/api/resources/experimentation/client/Client.d.mts +6 -0
  45. package/dist/esm/management/api/resources/experimentation/client/Client.mjs +10 -0
  46. package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.d.mts +133 -0
  47. package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.mjs +485 -0
  48. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.d.mts +126 -0
  49. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.mjs +434 -0
  50. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/index.d.mts +1 -0
  51. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/index.mjs +1 -0
  52. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/exports.d.mts +3 -0
  53. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/exports.mjs +4 -0
  54. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/index.d.mts +2 -0
  55. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/index.mjs +2 -0
  56. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/index.d.mts +1 -0
  57. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/index.mjs +1 -0
  58. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.mts +109 -0
  59. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.mjs +353 -0
  60. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.d.mts +1 -0
  61. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.mjs +1 -0
  62. package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/exports.d.mts +2 -0
  63. package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/exports.mjs +1 -1
  64. package/dist/esm/management/api/resources/experimentation/resources/index.d.mts +2 -0
  65. package/dist/esm/management/api/resources/experimentation/resources/index.mjs +2 -0
  66. package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.d.mts +104 -0
  67. package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.mjs +361 -0
  68. package/dist/esm/management/api/resources/experimentation/resources/segments/client/index.d.mts +1 -0
  69. package/dist/esm/management/api/resources/experimentation/resources/segments/client/index.mjs +1 -0
  70. package/dist/esm/management/api/resources/experimentation/resources/segments/exports.d.mts +2 -0
  71. package/dist/esm/management/api/resources/experimentation/resources/segments/exports.mjs +3 -0
  72. package/dist/esm/management/api/resources/experimentation/resources/segments/index.d.mts +1 -0
  73. package/dist/esm/management/api/resources/experimentation/resources/segments/index.mjs +1 -0
  74. package/dist/esm/management/api/resources/organizations/client/Client.d.mts +0 -3
  75. package/dist/esm/management/api/resources/organizations/client/Client.mjs +0 -5
  76. package/dist/esm/management/api/resources/organizations/resources/index.d.mts +0 -1
  77. package/dist/esm/management/api/resources/organizations/resources/index.mjs +0 -1
  78. package/dist/esm/management/api/resources/users/client/Client.d.mts +8 -10
  79. package/dist/esm/management/api/resources/users/client/Client.mjs +8 -10
  80. package/dist/esm/management/api/types/types.d.mts +642 -91
  81. package/dist/esm/management/api/types/types.mjs +88 -29
  82. package/dist/esm/management/version.d.mts +1 -1
  83. package/dist/esm/management/version.mjs +1 -1
  84. package/package.json +34 -12
  85. package/reference.md +1829 -313
  86. package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.ts +0 -63
  87. package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/exports.d.ts +0 -2
  88. package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.mts +0 -63
  89. package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.mjs +0 -195
  90. package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/exports.d.mts +0 -2
  91. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags}/client/index.d.ts +0 -0
  92. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags}/client/index.js +0 -0
  93. /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
  94. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.d.ts +0 -0
  95. /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.js +0 -0
  96. /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
  97. /package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.d.mts +0 -0
  98. /package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.mjs +0 -0
package/reference.md CHANGED
@@ -1672,6 +1672,107 @@ await client.clients.registerCimdClient({
1672
1672
  </dl>
1673
1673
  </details>
1674
1674
 
1675
+ <details><summary><code>client.clients.<a href="/src/management/api/resources/clients/client/Client.ts">search</a>({ ...params }) -> core.Page&lt;Management.ClientSearchResponse, Management.SearchClientsResponseContent&gt;</code></summary>
1676
+ <dl>
1677
+ <dd>
1678
+
1679
+ #### 📝 Description
1680
+
1681
+ <dl>
1682
+ <dd>
1683
+
1684
+ <dl>
1685
+ <dd>
1686
+
1687
+ Search clients using SCIM or Lucene filter syntax with low-latency, eventually consistent results.
1688
+ Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene").
1689
+ This endpoint provides an alternative to the standard GET /clients endpoint with better performance
1690
+ for complex queries. Results may not reflect recent updates immediately.
1691
+
1692
+ - This endpoint only supports `read:clients` and `read:client_summary` scopes. The `read:client_keys` and `read:client_credentials` scopes are not supported.
1693
+ - The following fields are never returned by this endpoint:
1694
+ - `client_secret`
1695
+ - `encryption_key`
1696
+ - `signing_keys`
1697
+ - `owners`
1698
+ - `addons`
1699
+ </dd>
1700
+ </dl>
1701
+ </dd>
1702
+ </dl>
1703
+
1704
+ #### 🔌 Usage
1705
+
1706
+ <dl>
1707
+ <dd>
1708
+
1709
+ <dl>
1710
+ <dd>
1711
+
1712
+ ```typescript
1713
+ const pageableResponse = await client.clients.search({
1714
+ q: "q",
1715
+ parser: "scim",
1716
+ fields: "fields",
1717
+ include_fields: true,
1718
+ take: 1,
1719
+ from: "from",
1720
+ sort: "name",
1721
+ });
1722
+ for await (const item of pageableResponse) {
1723
+ console.log(item);
1724
+ }
1725
+
1726
+ // Or you can manually iterate page-by-page
1727
+ let page = await client.clients.search({
1728
+ q: "q",
1729
+ parser: "scim",
1730
+ fields: "fields",
1731
+ include_fields: true,
1732
+ take: 1,
1733
+ from: "from",
1734
+ sort: "name",
1735
+ });
1736
+ while (page.hasNextPage()) {
1737
+ page = page.getNextPage();
1738
+ }
1739
+
1740
+ // You can also access the underlying response
1741
+ const response = page.response;
1742
+ ```
1743
+
1744
+ </dd>
1745
+ </dl>
1746
+ </dd>
1747
+ </dl>
1748
+
1749
+ #### ⚙️ Parameters
1750
+
1751
+ <dl>
1752
+ <dd>
1753
+
1754
+ <dl>
1755
+ <dd>
1756
+
1757
+ **request:** `Management.SearchClientsRequestParameters`
1758
+
1759
+ </dd>
1760
+ </dl>
1761
+
1762
+ <dl>
1763
+ <dd>
1764
+
1765
+ **requestOptions:** `ClientsClient.RequestOptions`
1766
+
1767
+ </dd>
1768
+ </dl>
1769
+ </dd>
1770
+ </dl>
1771
+
1772
+ </dd>
1773
+ </dl>
1774
+ </details>
1775
+
1675
1776
  <details><summary><code>client.clients.<a href="/src/management/api/resources/clients/client/Client.ts">get</a>(id, { ...params }) -> Management.GetClientResponseContent</code></summary>
1676
1777
  <dl>
1677
1778
  <dd>
@@ -12206,20 +12307,22 @@ await client.userBlocks.delete("id");
12206
12307
  <dl>
12207
12308
  <dd>
12208
12309
 
12209
- Retrieve details of users. It is possible to:
12310
+ 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
12311
 
12211
- - Specify a search criteria for users
12312
+ - Specify search criteria for users
12212
12313
  - Sort the users to be returned
12213
12314
  - Select the fields to be returned
12214
12315
  - Specify the number of users to retrieve per page and the page index
12215
12316
 
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)
12317
+ 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
12318
 
12218
- [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
12319
+ - 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.
12320
+ - 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.
12321
+ - 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
12322
 
12220
- Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
12323
+ 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
12324
 
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.
12325
+ 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
12326
 
12224
12327
  </dd>
12225
12328
  </dl>
@@ -19380,7 +19483,7 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
19380
19483
 
19381
19484
  ## Experimentation Experiments
19382
19485
 
19383
- <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>
19486
+ <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>
19384
19487
  <dl>
19385
19488
  <dd>
19386
19489
 
@@ -19392,7 +19495,7 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
19392
19495
  <dl>
19393
19496
  <dd>
19394
19497
 
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.
19498
+ Retrieve a paginated list of experiments for the tenant, with optional filters.
19396
19499
 
19397
19500
  </dd>
19398
19501
  </dl>
@@ -19408,9 +19511,31 @@ Increments the current ramp index to the requested target level. Up-only: the ta
19408
19511
  <dd>
19409
19512
 
19410
19513
  ```typescript
19411
- await client.experimentation.experiments.advanceRamp("id", {
19412
- target_level: 1,
19514
+ const pageableResponse = await client.experimentation.experiments.list({
19515
+ from: "from",
19516
+ take: 1,
19517
+ status: "draft",
19518
+ authentication_flow: "authentication_flow",
19519
+ feature_flag_id: "feature_flag_id",
19520
+ });
19521
+ for await (const item of pageableResponse) {
19522
+ console.log(item);
19523
+ }
19524
+
19525
+ // Or you can manually iterate page-by-page
19526
+ let page = await client.experimentation.experiments.list({
19527
+ from: "from",
19528
+ take: 1,
19529
+ status: "draft",
19530
+ authentication_flow: "authentication_flow",
19531
+ feature_flag_id: "feature_flag_id",
19413
19532
  });
19533
+ while (page.hasNextPage()) {
19534
+ page = page.getNextPage();
19535
+ }
19536
+
19537
+ // You can also access the underlying response
19538
+ const response = page.response;
19414
19539
  ```
19415
19540
 
19416
19541
  </dd>
@@ -19426,15 +19551,7 @@ await client.experimentation.experiments.advanceRamp("id", {
19426
19551
  <dl>
19427
19552
  <dd>
19428
19553
 
19429
- **id:** `string` — The ID of the experiment to advance.
19430
-
19431
- </dd>
19432
- </dl>
19433
-
19434
- <dl>
19435
- <dd>
19436
-
19437
- **request:** `Management.AdvanceRampRequestContent`
19554
+ **request:** `Management.ListExperimentsRequestParameters`
19438
19555
 
19439
19556
  </dd>
19440
19557
  </dl>
@@ -19453,13 +19570,11 @@ await client.experimentation.experiments.advanceRamp("id", {
19453
19570
  </dl>
19454
19571
  </details>
19455
19572
 
19456
- ## Flows Executions
19457
-
19458
- <details><summary><code>client.flows.executions.<a href="/src/management/api/resources/flows/resources/executions/client/Client.ts">list</a>(flow_id, { ...params }) -> core.Page&lt;Management.FlowExecutionSummary, Management.ListFlowExecutionsPaginatedResponseContent&gt;</code></summary>
19573
+ <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>
19459
19574
  <dl>
19460
19575
  <dd>
19461
19576
 
19462
- #### 🔌 Usage
19577
+ #### 📝 Description
19463
19578
 
19464
19579
  <dl>
19465
19580
  <dd>
@@ -19467,36 +19582,14 @@ await client.experimentation.experiments.advanceRamp("id", {
19467
19582
  <dl>
19468
19583
  <dd>
19469
19584
 
19470
- ```typescript
19471
- const pageableResponse = await client.flows.executions.list("flow_id", {
19472
- include_totals: true,
19473
- from: "from",
19474
- take: 1,
19475
- });
19476
- for await (const item of pageableResponse) {
19477
- console.log(item);
19478
- }
19479
-
19480
- // Or you can manually iterate page-by-page
19481
- let page = await client.flows.executions.list("flow_id", {
19482
- include_totals: true,
19483
- from: "from",
19484
- take: 1,
19485
- });
19486
- while (page.hasNextPage()) {
19487
- page = page.getNextPage();
19488
- }
19489
-
19490
- // You can also access the underlying response
19491
- const response = page.response;
19492
- ```
19585
+ Create a new experiment for A/B testing.
19493
19586
 
19494
19587
  </dd>
19495
19588
  </dl>
19496
19589
  </dd>
19497
19590
  </dl>
19498
19591
 
19499
- #### ⚙️ Parameters
19592
+ #### 🔌 Usage
19500
19593
 
19501
19594
  <dl>
19502
19595
  <dd>
@@ -19504,15 +19597,28 @@ const response = page.response;
19504
19597
  <dl>
19505
19598
  <dd>
19506
19599
 
19507
- **flow_id:** `string` — Flow id
19600
+ ```typescript
19601
+ await client.experimentation.experiments.create({
19602
+ name: "name",
19603
+ feature_flag_id: "feature_flag_id",
19604
+ authentication_flow: "authentication",
19605
+ });
19606
+ ```
19508
19607
 
19608
+ </dd>
19609
+ </dl>
19509
19610
  </dd>
19510
19611
  </dl>
19511
19612
 
19613
+ #### ⚙️ Parameters
19614
+
19512
19615
  <dl>
19513
19616
  <dd>
19514
19617
 
19515
- **request:** `Management.ListFlowExecutionsRequestParameters`
19618
+ <dl>
19619
+ <dd>
19620
+
19621
+ **request:** `Management.CreateExperimentRequestContent`
19516
19622
 
19517
19623
  </dd>
19518
19624
  </dl>
@@ -19520,7 +19626,7 @@ const response = page.response;
19520
19626
  <dl>
19521
19627
  <dd>
19522
19628
 
19523
- **requestOptions:** `ExecutionsClient.RequestOptions`
19629
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19524
19630
 
19525
19631
  </dd>
19526
19632
  </dl>
@@ -19531,11 +19637,11 @@ const response = page.response;
19531
19637
  </dl>
19532
19638
  </details>
19533
19639
 
19534
- <details><summary><code>client.flows.executions.<a href="/src/management/api/resources/flows/resources/executions/client/Client.ts">get</a>(flow_id, execution_id, { ...params }) -> Management.GetFlowExecutionResponseContent</code></summary>
19640
+ <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>
19535
19641
  <dl>
19536
19642
  <dd>
19537
19643
 
19538
- #### 🔌 Usage
19644
+ #### 📝 Description
19539
19645
 
19540
19646
  <dl>
19541
19647
  <dd>
@@ -19543,18 +19649,14 @@ const response = page.response;
19543
19649
  <dl>
19544
19650
  <dd>
19545
19651
 
19546
- ```typescript
19547
- await client.flows.executions.get("flow_id", "execution_id", {
19548
- hydrate: ["debug"],
19549
- });
19550
- ```
19652
+ Retrieve a single experiment with its allocations by ID.
19551
19653
 
19552
19654
  </dd>
19553
19655
  </dl>
19554
19656
  </dd>
19555
19657
  </dl>
19556
19658
 
19557
- #### ⚙️ Parameters
19659
+ #### 🔌 Usage
19558
19660
 
19559
19661
  <dl>
19560
19662
  <dd>
@@ -19562,23 +19664,24 @@ await client.flows.executions.get("flow_id", "execution_id", {
19562
19664
  <dl>
19563
19665
  <dd>
19564
19666
 
19565
- **flow_id:** `string` — Flow id
19667
+ ```typescript
19668
+ await client.experimentation.experiments.get("id");
19669
+ ```
19566
19670
 
19567
19671
  </dd>
19568
19672
  </dl>
19673
+ </dd>
19674
+ </dl>
19675
+
19676
+ #### ⚙️ Parameters
19569
19677
 
19570
19678
  <dl>
19571
19679
  <dd>
19572
19680
 
19573
- **execution_id:** `string` — Flow execution id
19574
-
19575
- </dd>
19576
- </dl>
19577
-
19578
19681
  <dl>
19579
19682
  <dd>
19580
19683
 
19581
- **request:** `Management.GetFlowExecutionRequestParameters`
19684
+ **id:** `string` — The ID of the experiment to retrieve.
19582
19685
 
19583
19686
  </dd>
19584
19687
  </dl>
@@ -19586,7 +19689,7 @@ await client.flows.executions.get("flow_id", "execution_id", {
19586
19689
  <dl>
19587
19690
  <dd>
19588
19691
 
19589
- **requestOptions:** `ExecutionsClient.RequestOptions`
19692
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19590
19693
 
19591
19694
  </dd>
19592
19695
  </dl>
@@ -19597,11 +19700,11 @@ await client.flows.executions.get("flow_id", "execution_id", {
19597
19700
  </dl>
19598
19701
  </details>
19599
19702
 
19600
- <details><summary><code>client.flows.executions.<a href="/src/management/api/resources/flows/resources/executions/client/Client.ts">delete</a>(flow_id, execution_id) -> void</code></summary>
19703
+ <details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">delete</a>(id) -> void</code></summary>
19601
19704
  <dl>
19602
19705
  <dd>
19603
19706
 
19604
- #### 🔌 Usage
19707
+ #### 📝 Description
19605
19708
 
19606
19709
  <dl>
19607
19710
  <dd>
@@ -19609,16 +19712,14 @@ await client.flows.executions.get("flow_id", "execution_id", {
19609
19712
  <dl>
19610
19713
  <dd>
19611
19714
 
19612
- ```typescript
19613
- await client.flows.executions.delete("flow_id", "execution_id");
19614
- ```
19715
+ 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
19716
 
19616
19717
  </dd>
19617
19718
  </dl>
19618
19719
  </dd>
19619
19720
  </dl>
19620
19721
 
19621
- #### ⚙️ Parameters
19722
+ #### 🔌 Usage
19622
19723
 
19623
19724
  <dl>
19624
19725
  <dd>
@@ -19626,15 +19727,24 @@ await client.flows.executions.delete("flow_id", "execution_id");
19626
19727
  <dl>
19627
19728
  <dd>
19628
19729
 
19629
- **flow_id:** `string` — Flows id
19730
+ ```typescript
19731
+ await client.experimentation.experiments.delete("id");
19732
+ ```
19630
19733
 
19631
19734
  </dd>
19632
19735
  </dl>
19736
+ </dd>
19737
+ </dl>
19738
+
19739
+ #### ⚙️ Parameters
19633
19740
 
19634
19741
  <dl>
19635
19742
  <dd>
19636
19743
 
19637
- **execution_id:** `string` — Flow execution identifier
19744
+ <dl>
19745
+ <dd>
19746
+
19747
+ **id:** `string` — The ID of the experiment to delete.
19638
19748
 
19639
19749
  </dd>
19640
19750
  </dl>
@@ -19642,7 +19752,7 @@ await client.flows.executions.delete("flow_id", "execution_id");
19642
19752
  <dl>
19643
19753
  <dd>
19644
19754
 
19645
- **requestOptions:** `ExecutionsClient.RequestOptions`
19755
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19646
19756
 
19647
19757
  </dd>
19648
19758
  </dl>
@@ -19653,12 +19763,25 @@ await client.flows.executions.delete("flow_id", "execution_id");
19653
19763
  </dl>
19654
19764
  </details>
19655
19765
 
19656
- ## Flows Vault Connections
19766
+ <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>
19767
+ <dl>
19768
+ <dd>
19769
+
19770
+ #### 📝 Description
19657
19771
 
19658
- <details><summary><code>client.flows.vault.connections.<a href="/src/management/api/resources/flows/resources/vault/resources/connections/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.FlowsVaultConnectionSummary, Management.ListFlowsVaultConnectionsOffsetPaginatedResponseContent&gt;</code></summary>
19659
19772
  <dl>
19660
19773
  <dd>
19661
19774
 
19775
+ <dl>
19776
+ <dd>
19777
+
19778
+ Partially update an experiment by ID. Only provided fields are updated. Providing allocations replaces the entire allocations set.
19779
+
19780
+ </dd>
19781
+ </dl>
19782
+ </dd>
19783
+ </dl>
19784
+
19662
19785
  #### 🔌 Usage
19663
19786
 
19664
19787
  <dl>
@@ -19668,27 +19791,7 @@ await client.flows.executions.delete("flow_id", "execution_id");
19668
19791
  <dd>
19669
19792
 
19670
19793
  ```typescript
19671
- const pageableResponse = await client.flows.vault.connections.list({
19672
- page: 1,
19673
- per_page: 1,
19674
- include_totals: true,
19675
- });
19676
- for await (const item of pageableResponse) {
19677
- console.log(item);
19678
- }
19679
-
19680
- // Or you can manually iterate page-by-page
19681
- let page = await client.flows.vault.connections.list({
19682
- page: 1,
19683
- per_page: 1,
19684
- include_totals: true,
19685
- });
19686
- while (page.hasNextPage()) {
19687
- page = page.getNextPage();
19688
- }
19689
-
19690
- // You can also access the underlying response
19691
- const response = page.response;
19794
+ await client.experimentation.experiments.update("id");
19692
19795
  ```
19693
19796
 
19694
19797
  </dd>
@@ -19704,7 +19807,7 @@ const response = page.response;
19704
19807
  <dl>
19705
19808
  <dd>
19706
19809
 
19707
- **request:** `Management.ListFlowsVaultConnectionsRequestParameters`
19810
+ **id:** `string` — The ID of the experiment to update.
19708
19811
 
19709
19812
  </dd>
19710
19813
  </dl>
@@ -19712,7 +19815,15 @@ const response = page.response;
19712
19815
  <dl>
19713
19816
  <dd>
19714
19817
 
19715
- **requestOptions:** `ConnectionsClient.RequestOptions`
19818
+ **request:** `Management.UpdateExperimentRequestParameters`
19819
+
19820
+ </dd>
19821
+ </dl>
19822
+
19823
+ <dl>
19824
+ <dd>
19825
+
19826
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19716
19827
 
19717
19828
  </dd>
19718
19829
  </dl>
@@ -19723,11 +19834,11 @@ const response = page.response;
19723
19834
  </dl>
19724
19835
  </details>
19725
19836
 
19726
- <details><summary><code>client.flows.vault.connections.<a href="/src/management/api/resources/flows/resources/vault/resources/connections/client/Client.ts">create</a>({ ...params }) -> Management.CreateFlowsVaultConnectionResponseContent</code></summary>
19837
+ <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>
19727
19838
  <dl>
19728
19839
  <dd>
19729
19840
 
19730
- #### 🔌 Usage
19841
+ #### 📝 Description
19731
19842
 
19732
19843
  <dl>
19733
19844
  <dd>
@@ -19735,10 +19846,1622 @@ const response = page.response;
19735
19846
  <dl>
19736
19847
  <dd>
19737
19848
 
19738
- ```typescript
19739
- await client.flows.vault.connections.create({
19740
- name: "name",
19741
- app_id: "ACTIVECAMPAIGN",
19849
+ 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.
19850
+
19851
+ </dd>
19852
+ </dl>
19853
+ </dd>
19854
+ </dl>
19855
+
19856
+ #### 🔌 Usage
19857
+
19858
+ <dl>
19859
+ <dd>
19860
+
19861
+ <dl>
19862
+ <dd>
19863
+
19864
+ ```typescript
19865
+ await client.experimentation.experiments.advanceRamp("id", {
19866
+ target_level: 1,
19867
+ });
19868
+ ```
19869
+
19870
+ </dd>
19871
+ </dl>
19872
+ </dd>
19873
+ </dl>
19874
+
19875
+ #### ⚙️ Parameters
19876
+
19877
+ <dl>
19878
+ <dd>
19879
+
19880
+ <dl>
19881
+ <dd>
19882
+
19883
+ **id:** `string` — The ID of the experiment to advance.
19884
+
19885
+ </dd>
19886
+ </dl>
19887
+
19888
+ <dl>
19889
+ <dd>
19890
+
19891
+ **request:** `Management.AdvanceRampRequestContent`
19892
+
19893
+ </dd>
19894
+ </dl>
19895
+
19896
+ <dl>
19897
+ <dd>
19898
+
19899
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19900
+
19901
+ </dd>
19902
+ </dl>
19903
+ </dd>
19904
+ </dl>
19905
+
19906
+ </dd>
19907
+ </dl>
19908
+ </details>
19909
+
19910
+ <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>
19911
+ <dl>
19912
+ <dd>
19913
+
19914
+ #### 📝 Description
19915
+
19916
+ <dl>
19917
+ <dd>
19918
+
19919
+ <dl>
19920
+ <dd>
19921
+
19922
+ Transitions an experiment through its lifecycle: draft → active, active → paused, paused → active, active/paused → completed. Activation runs full readiness validation.
19923
+
19924
+ </dd>
19925
+ </dl>
19926
+ </dd>
19927
+ </dl>
19928
+
19929
+ #### 🔌 Usage
19930
+
19931
+ <dl>
19932
+ <dd>
19933
+
19934
+ <dl>
19935
+ <dd>
19936
+
19937
+ ```typescript
19938
+ await client.experimentation.experiments.updateStatus("id", {
19939
+ status: "active",
19940
+ });
19941
+ ```
19942
+
19943
+ </dd>
19944
+ </dl>
19945
+ </dd>
19946
+ </dl>
19947
+
19948
+ #### ⚙️ Parameters
19949
+
19950
+ <dl>
19951
+ <dd>
19952
+
19953
+ <dl>
19954
+ <dd>
19955
+
19956
+ **id:** `string` — The ID of the experiment to transition.
19957
+
19958
+ </dd>
19959
+ </dl>
19960
+
19961
+ <dl>
19962
+ <dd>
19963
+
19964
+ **request:** `Management.UpdateExperimentStatusRequestContent`
19965
+
19966
+ </dd>
19967
+ </dl>
19968
+
19969
+ <dl>
19970
+ <dd>
19971
+
19972
+ **requestOptions:** `ExperimentsClient.RequestOptions`
19973
+
19974
+ </dd>
19975
+ </dl>
19976
+ </dd>
19977
+ </dl>
19978
+
19979
+ </dd>
19980
+ </dl>
19981
+ </details>
19982
+
19983
+ <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>
19984
+ <dl>
19985
+ <dd>
19986
+
19987
+ #### 📝 Description
19988
+
19989
+ <dl>
19990
+ <dd>
19991
+
19992
+ <dl>
19993
+ <dd>
19994
+
19995
+ 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.
19996
+
19997
+ </dd>
19998
+ </dl>
19999
+ </dd>
20000
+ </dl>
20001
+
20002
+ #### 🔌 Usage
20003
+
20004
+ <dl>
20005
+ <dd>
20006
+
20007
+ <dl>
20008
+ <dd>
20009
+
20010
+ ```typescript
20011
+ await client.experimentation.experiments.validate("id");
20012
+ ```
20013
+
20014
+ </dd>
20015
+ </dl>
20016
+ </dd>
20017
+ </dl>
20018
+
20019
+ #### ⚙️ Parameters
20020
+
20021
+ <dl>
20022
+ <dd>
20023
+
20024
+ <dl>
20025
+ <dd>
20026
+
20027
+ **id:** `string` — The ID of the experiment to validate.
20028
+
20029
+ </dd>
20030
+ </dl>
20031
+
20032
+ <dl>
20033
+ <dd>
20034
+
20035
+ **requestOptions:** `ExperimentsClient.RequestOptions`
20036
+
20037
+ </dd>
20038
+ </dl>
20039
+ </dd>
20040
+ </dl>
20041
+
20042
+ </dd>
20043
+ </dl>
20044
+ </details>
20045
+
20046
+ ## Experimentation FeatureFlags
20047
+
20048
+ <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>
20049
+ <dl>
20050
+ <dd>
20051
+
20052
+ #### 📝 Description
20053
+
20054
+ <dl>
20055
+ <dd>
20056
+
20057
+ <dl>
20058
+ <dd>
20059
+
20060
+ Retrieve a paginated list of feature flags for the tenant.
20061
+
20062
+ </dd>
20063
+ </dl>
20064
+ </dd>
20065
+ </dl>
20066
+
20067
+ #### 🔌 Usage
20068
+
20069
+ <dl>
20070
+ <dd>
20071
+
20072
+ <dl>
20073
+ <dd>
20074
+
20075
+ ```typescript
20076
+ const pageableResponse = await client.experimentation.featureFlags.list({
20077
+ from: "from",
20078
+ take: 1,
20079
+ type: "auth0",
20080
+ status: "draft",
20081
+ });
20082
+ for await (const item of pageableResponse) {
20083
+ console.log(item);
20084
+ }
20085
+
20086
+ // Or you can manually iterate page-by-page
20087
+ let page = await client.experimentation.featureFlags.list({
20088
+ from: "from",
20089
+ take: 1,
20090
+ type: "auth0",
20091
+ status: "draft",
20092
+ });
20093
+ while (page.hasNextPage()) {
20094
+ page = page.getNextPage();
20095
+ }
20096
+
20097
+ // You can also access the underlying response
20098
+ const response = page.response;
20099
+ ```
20100
+
20101
+ </dd>
20102
+ </dl>
20103
+ </dd>
20104
+ </dl>
20105
+
20106
+ #### ⚙️ Parameters
20107
+
20108
+ <dl>
20109
+ <dd>
20110
+
20111
+ <dl>
20112
+ <dd>
20113
+
20114
+ **request:** `Management.ListFeatureFlagsRequestParameters`
20115
+
20116
+ </dd>
20117
+ </dl>
20118
+
20119
+ <dl>
20120
+ <dd>
20121
+
20122
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20123
+
20124
+ </dd>
20125
+ </dl>
20126
+ </dd>
20127
+ </dl>
20128
+
20129
+ </dd>
20130
+ </dl>
20131
+ </details>
20132
+
20133
+ <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>
20134
+ <dl>
20135
+ <dd>
20136
+
20137
+ #### 📝 Description
20138
+
20139
+ <dl>
20140
+ <dd>
20141
+
20142
+ <dl>
20143
+ <dd>
20144
+
20145
+ Create a new feature flag with parameters for use in experiments.
20146
+
20147
+ </dd>
20148
+ </dl>
20149
+ </dd>
20150
+ </dl>
20151
+
20152
+ #### 🔌 Usage
20153
+
20154
+ <dl>
20155
+ <dd>
20156
+
20157
+ <dl>
20158
+ <dd>
20159
+
20160
+ ```typescript
20161
+ await client.experimentation.featureFlags.create({
20162
+ name: "name",
20163
+ parameters: {},
20164
+ });
20165
+ ```
20166
+
20167
+ </dd>
20168
+ </dl>
20169
+ </dd>
20170
+ </dl>
20171
+
20172
+ #### ⚙️ Parameters
20173
+
20174
+ <dl>
20175
+ <dd>
20176
+
20177
+ <dl>
20178
+ <dd>
20179
+
20180
+ **request:** `Management.CreateFeatureFlagRequestContent`
20181
+
20182
+ </dd>
20183
+ </dl>
20184
+
20185
+ <dl>
20186
+ <dd>
20187
+
20188
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20189
+
20190
+ </dd>
20191
+ </dl>
20192
+ </dd>
20193
+ </dl>
20194
+
20195
+ </dd>
20196
+ </dl>
20197
+ </details>
20198
+
20199
+ <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>
20200
+ <dl>
20201
+ <dd>
20202
+
20203
+ #### 📝 Description
20204
+
20205
+ <dl>
20206
+ <dd>
20207
+
20208
+ <dl>
20209
+ <dd>
20210
+
20211
+ Retrieve a single feature flag by its ID.
20212
+
20213
+ </dd>
20214
+ </dl>
20215
+ </dd>
20216
+ </dl>
20217
+
20218
+ #### 🔌 Usage
20219
+
20220
+ <dl>
20221
+ <dd>
20222
+
20223
+ <dl>
20224
+ <dd>
20225
+
20226
+ ```typescript
20227
+ await client.experimentation.featureFlags.get("id");
20228
+ ```
20229
+
20230
+ </dd>
20231
+ </dl>
20232
+ </dd>
20233
+ </dl>
20234
+
20235
+ #### ⚙️ Parameters
20236
+
20237
+ <dl>
20238
+ <dd>
20239
+
20240
+ <dl>
20241
+ <dd>
20242
+
20243
+ **id:** `string` — The ID of the feature flag to retrieve.
20244
+
20245
+ </dd>
20246
+ </dl>
20247
+
20248
+ <dl>
20249
+ <dd>
20250
+
20251
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20252
+
20253
+ </dd>
20254
+ </dl>
20255
+ </dd>
20256
+ </dl>
20257
+
20258
+ </dd>
20259
+ </dl>
20260
+ </details>
20261
+
20262
+ <details><summary><code>client.experimentation.featureFlags.<a href="/src/management/api/resources/experimentation/resources/featureFlags/client/Client.ts">delete</a>(id) -> void</code></summary>
20263
+ <dl>
20264
+ <dd>
20265
+
20266
+ #### 📝 Description
20267
+
20268
+ <dl>
20269
+ <dd>
20270
+
20271
+ <dl>
20272
+ <dd>
20273
+
20274
+ Delete a feature flag by ID. Idempotent: returns 204 even if flag does not exist.
20275
+
20276
+ </dd>
20277
+ </dl>
20278
+ </dd>
20279
+ </dl>
20280
+
20281
+ #### 🔌 Usage
20282
+
20283
+ <dl>
20284
+ <dd>
20285
+
20286
+ <dl>
20287
+ <dd>
20288
+
20289
+ ```typescript
20290
+ await client.experimentation.featureFlags.delete("id");
20291
+ ```
20292
+
20293
+ </dd>
20294
+ </dl>
20295
+ </dd>
20296
+ </dl>
20297
+
20298
+ #### ⚙️ Parameters
20299
+
20300
+ <dl>
20301
+ <dd>
20302
+
20303
+ <dl>
20304
+ <dd>
20305
+
20306
+ **id:** `string` — The ID of the feature flag to delete.
20307
+
20308
+ </dd>
20309
+ </dl>
20310
+
20311
+ <dl>
20312
+ <dd>
20313
+
20314
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20315
+
20316
+ </dd>
20317
+ </dl>
20318
+ </dd>
20319
+ </dl>
20320
+
20321
+ </dd>
20322
+ </dl>
20323
+ </details>
20324
+
20325
+ <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>
20326
+ <dl>
20327
+ <dd>
20328
+
20329
+ #### 📝 Description
20330
+
20331
+ <dl>
20332
+ <dd>
20333
+
20334
+ <dl>
20335
+ <dd>
20336
+
20337
+ Partially update a feature flag by ID. Only provided fields are updated.
20338
+
20339
+ </dd>
20340
+ </dl>
20341
+ </dd>
20342
+ </dl>
20343
+
20344
+ #### 🔌 Usage
20345
+
20346
+ <dl>
20347
+ <dd>
20348
+
20349
+ <dl>
20350
+ <dd>
20351
+
20352
+ ```typescript
20353
+ await client.experimentation.featureFlags.update("id");
20354
+ ```
20355
+
20356
+ </dd>
20357
+ </dl>
20358
+ </dd>
20359
+ </dl>
20360
+
20361
+ #### ⚙️ Parameters
20362
+
20363
+ <dl>
20364
+ <dd>
20365
+
20366
+ <dl>
20367
+ <dd>
20368
+
20369
+ **id:** `string` — The ID of the feature flag to update.
20370
+
20371
+ </dd>
20372
+ </dl>
20373
+
20374
+ <dl>
20375
+ <dd>
20376
+
20377
+ **request:** `Management.UpdateFeatureFlagRequestContent`
20378
+
20379
+ </dd>
20380
+ </dl>
20381
+
20382
+ <dl>
20383
+ <dd>
20384
+
20385
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20386
+
20387
+ </dd>
20388
+ </dl>
20389
+ </dd>
20390
+ </dl>
20391
+
20392
+ </dd>
20393
+ </dl>
20394
+ </details>
20395
+
20396
+ <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>
20397
+ <dl>
20398
+ <dd>
20399
+
20400
+ #### 📝 Description
20401
+
20402
+ <dl>
20403
+ <dd>
20404
+
20405
+ <dl>
20406
+ <dd>
20407
+
20408
+ Transitions a feature flag through its lifecycle states: draft → active, draft → archived, active → archived.
20409
+
20410
+ </dd>
20411
+ </dl>
20412
+ </dd>
20413
+ </dl>
20414
+
20415
+ #### 🔌 Usage
20416
+
20417
+ <dl>
20418
+ <dd>
20419
+
20420
+ <dl>
20421
+ <dd>
20422
+
20423
+ ```typescript
20424
+ await client.experimentation.featureFlags.updateStatus("id", {
20425
+ status: "draft",
20426
+ });
20427
+ ```
20428
+
20429
+ </dd>
20430
+ </dl>
20431
+ </dd>
20432
+ </dl>
20433
+
20434
+ #### ⚙️ Parameters
20435
+
20436
+ <dl>
20437
+ <dd>
20438
+
20439
+ <dl>
20440
+ <dd>
20441
+
20442
+ **id:** `string` — The ID of the feature flag to transition.
20443
+
20444
+ </dd>
20445
+ </dl>
20446
+
20447
+ <dl>
20448
+ <dd>
20449
+
20450
+ **request:** `Management.UpdateFeatureFlagStatusRequestContent`
20451
+
20452
+ </dd>
20453
+ </dl>
20454
+
20455
+ <dl>
20456
+ <dd>
20457
+
20458
+ **requestOptions:** `FeatureFlagsClient.RequestOptions`
20459
+
20460
+ </dd>
20461
+ </dl>
20462
+ </dd>
20463
+ </dl>
20464
+
20465
+ </dd>
20466
+ </dl>
20467
+ </details>
20468
+
20469
+ ## Experimentation Segments
20470
+
20471
+ <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>
20472
+ <dl>
20473
+ <dd>
20474
+
20475
+ #### 📝 Description
20476
+
20477
+ <dl>
20478
+ <dd>
20479
+
20480
+ <dl>
20481
+ <dd>
20482
+
20483
+ Retrieve a paginated list of segments for the tenant.
20484
+
20485
+ </dd>
20486
+ </dl>
20487
+ </dd>
20488
+ </dl>
20489
+
20490
+ #### 🔌 Usage
20491
+
20492
+ <dl>
20493
+ <dd>
20494
+
20495
+ <dl>
20496
+ <dd>
20497
+
20498
+ ```typescript
20499
+ const pageableResponse = await client.experimentation.segments.list({
20500
+ from: "from",
20501
+ take: 1,
20502
+ type: "auth0",
20503
+ });
20504
+ for await (const item of pageableResponse) {
20505
+ console.log(item);
20506
+ }
20507
+
20508
+ // Or you can manually iterate page-by-page
20509
+ let page = await client.experimentation.segments.list({
20510
+ from: "from",
20511
+ take: 1,
20512
+ type: "auth0",
20513
+ });
20514
+ while (page.hasNextPage()) {
20515
+ page = page.getNextPage();
20516
+ }
20517
+
20518
+ // You can also access the underlying response
20519
+ const response = page.response;
20520
+ ```
20521
+
20522
+ </dd>
20523
+ </dl>
20524
+ </dd>
20525
+ </dl>
20526
+
20527
+ #### ⚙️ Parameters
20528
+
20529
+ <dl>
20530
+ <dd>
20531
+
20532
+ <dl>
20533
+ <dd>
20534
+
20535
+ **request:** `Management.ListSegmentsRequestParameters`
20536
+
20537
+ </dd>
20538
+ </dl>
20539
+
20540
+ <dl>
20541
+ <dd>
20542
+
20543
+ **requestOptions:** `SegmentsClient.RequestOptions`
20544
+
20545
+ </dd>
20546
+ </dl>
20547
+ </dd>
20548
+ </dl>
20549
+
20550
+ </dd>
20551
+ </dl>
20552
+ </details>
20553
+
20554
+ <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>
20555
+ <dl>
20556
+ <dd>
20557
+
20558
+ #### 📝 Description
20559
+
20560
+ <dl>
20561
+ <dd>
20562
+
20563
+ <dl>
20564
+ <dd>
20565
+
20566
+ Create a new segment with rule-based membership criteria for use in experiments.
20567
+
20568
+ </dd>
20569
+ </dl>
20570
+ </dd>
20571
+ </dl>
20572
+
20573
+ #### 🔌 Usage
20574
+
20575
+ <dl>
20576
+ <dd>
20577
+
20578
+ <dl>
20579
+ <dd>
20580
+
20581
+ ```typescript
20582
+ await client.experimentation.segments.create({
20583
+ name: "name",
20584
+ rules: [{}],
20585
+ });
20586
+ ```
20587
+
20588
+ </dd>
20589
+ </dl>
20590
+ </dd>
20591
+ </dl>
20592
+
20593
+ #### ⚙️ Parameters
20594
+
20595
+ <dl>
20596
+ <dd>
20597
+
20598
+ <dl>
20599
+ <dd>
20600
+
20601
+ **request:** `Management.CreateSegmentRequestContent`
20602
+
20603
+ </dd>
20604
+ </dl>
20605
+
20606
+ <dl>
20607
+ <dd>
20608
+
20609
+ **requestOptions:** `SegmentsClient.RequestOptions`
20610
+
20611
+ </dd>
20612
+ </dl>
20613
+ </dd>
20614
+ </dl>
20615
+
20616
+ </dd>
20617
+ </dl>
20618
+ </details>
20619
+
20620
+ <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>
20621
+ <dl>
20622
+ <dd>
20623
+
20624
+ #### 📝 Description
20625
+
20626
+ <dl>
20627
+ <dd>
20628
+
20629
+ <dl>
20630
+ <dd>
20631
+
20632
+ Retrieve a single segment by its ID.
20633
+
20634
+ </dd>
20635
+ </dl>
20636
+ </dd>
20637
+ </dl>
20638
+
20639
+ #### 🔌 Usage
20640
+
20641
+ <dl>
20642
+ <dd>
20643
+
20644
+ <dl>
20645
+ <dd>
20646
+
20647
+ ```typescript
20648
+ await client.experimentation.segments.get("id");
20649
+ ```
20650
+
20651
+ </dd>
20652
+ </dl>
20653
+ </dd>
20654
+ </dl>
20655
+
20656
+ #### ⚙️ Parameters
20657
+
20658
+ <dl>
20659
+ <dd>
20660
+
20661
+ <dl>
20662
+ <dd>
20663
+
20664
+ **id:** `string` — The ID of the segment to retrieve.
20665
+
20666
+ </dd>
20667
+ </dl>
20668
+
20669
+ <dl>
20670
+ <dd>
20671
+
20672
+ **requestOptions:** `SegmentsClient.RequestOptions`
20673
+
20674
+ </dd>
20675
+ </dl>
20676
+ </dd>
20677
+ </dl>
20678
+
20679
+ </dd>
20680
+ </dl>
20681
+ </details>
20682
+
20683
+ <details><summary><code>client.experimentation.segments.<a href="/src/management/api/resources/experimentation/resources/segments/client/Client.ts">delete</a>(id) -> void</code></summary>
20684
+ <dl>
20685
+ <dd>
20686
+
20687
+ #### 📝 Description
20688
+
20689
+ <dl>
20690
+ <dd>
20691
+
20692
+ <dl>
20693
+ <dd>
20694
+
20695
+ Delete a segment by ID. Idempotent: returns 204 even if segment does not exist.
20696
+
20697
+ </dd>
20698
+ </dl>
20699
+ </dd>
20700
+ </dl>
20701
+
20702
+ #### 🔌 Usage
20703
+
20704
+ <dl>
20705
+ <dd>
20706
+
20707
+ <dl>
20708
+ <dd>
20709
+
20710
+ ```typescript
20711
+ await client.experimentation.segments.delete("id");
20712
+ ```
20713
+
20714
+ </dd>
20715
+ </dl>
20716
+ </dd>
20717
+ </dl>
20718
+
20719
+ #### ⚙️ Parameters
20720
+
20721
+ <dl>
20722
+ <dd>
20723
+
20724
+ <dl>
20725
+ <dd>
20726
+
20727
+ **id:** `string` — The ID of the segment to delete.
20728
+
20729
+ </dd>
20730
+ </dl>
20731
+
20732
+ <dl>
20733
+ <dd>
20734
+
20735
+ **requestOptions:** `SegmentsClient.RequestOptions`
20736
+
20737
+ </dd>
20738
+ </dl>
20739
+ </dd>
20740
+ </dl>
20741
+
20742
+ </dd>
20743
+ </dl>
20744
+ </details>
20745
+
20746
+ <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>
20747
+ <dl>
20748
+ <dd>
20749
+
20750
+ #### 📝 Description
20751
+
20752
+ <dl>
20753
+ <dd>
20754
+
20755
+ <dl>
20756
+ <dd>
20757
+
20758
+ Partially update a segment by ID. Only provided fields are updated. Sending rules replaces the entire rules array.
20759
+
20760
+ </dd>
20761
+ </dl>
20762
+ </dd>
20763
+ </dl>
20764
+
20765
+ #### 🔌 Usage
20766
+
20767
+ <dl>
20768
+ <dd>
20769
+
20770
+ <dl>
20771
+ <dd>
20772
+
20773
+ ```typescript
20774
+ await client.experimentation.segments.update("id");
20775
+ ```
20776
+
20777
+ </dd>
20778
+ </dl>
20779
+ </dd>
20780
+ </dl>
20781
+
20782
+ #### ⚙️ Parameters
20783
+
20784
+ <dl>
20785
+ <dd>
20786
+
20787
+ <dl>
20788
+ <dd>
20789
+
20790
+ **id:** `string` — The ID of the segment to update.
20791
+
20792
+ </dd>
20793
+ </dl>
20794
+
20795
+ <dl>
20796
+ <dd>
20797
+
20798
+ **request:** `Management.UpdateSegmentRequestContent`
20799
+
20800
+ </dd>
20801
+ </dl>
20802
+
20803
+ <dl>
20804
+ <dd>
20805
+
20806
+ **requestOptions:** `SegmentsClient.RequestOptions`
20807
+
20808
+ </dd>
20809
+ </dl>
20810
+ </dd>
20811
+ </dl>
20812
+
20813
+ </dd>
20814
+ </dl>
20815
+ </details>
20816
+
20817
+ ## Experimentation FeatureFlags Variations
20818
+
20819
+ <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>
20820
+ <dl>
20821
+ <dd>
20822
+
20823
+ #### 📝 Description
20824
+
20825
+ <dl>
20826
+ <dd>
20827
+
20828
+ <dl>
20829
+ <dd>
20830
+
20831
+ Retrieve all variations defined for a specific feature flag.
20832
+
20833
+ </dd>
20834
+ </dl>
20835
+ </dd>
20836
+ </dl>
20837
+
20838
+ #### 🔌 Usage
20839
+
20840
+ <dl>
20841
+ <dd>
20842
+
20843
+ <dl>
20844
+ <dd>
20845
+
20846
+ ```typescript
20847
+ await client.experimentation.featureFlags.variations.list("id");
20848
+ ```
20849
+
20850
+ </dd>
20851
+ </dl>
20852
+ </dd>
20853
+ </dl>
20854
+
20855
+ #### ⚙️ Parameters
20856
+
20857
+ <dl>
20858
+ <dd>
20859
+
20860
+ <dl>
20861
+ <dd>
20862
+
20863
+ **id:** `string` — The ID of the parent feature flag.
20864
+
20865
+ </dd>
20866
+ </dl>
20867
+
20868
+ <dl>
20869
+ <dd>
20870
+
20871
+ **requestOptions:** `VariationsClient.RequestOptions`
20872
+
20873
+ </dd>
20874
+ </dl>
20875
+ </dd>
20876
+ </dl>
20877
+
20878
+ </dd>
20879
+ </dl>
20880
+ </details>
20881
+
20882
+ <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>
20883
+ <dl>
20884
+ <dd>
20885
+
20886
+ #### 📝 Description
20887
+
20888
+ <dl>
20889
+ <dd>
20890
+
20891
+ <dl>
20892
+ <dd>
20893
+
20894
+ Create a new variation with parameter overrides for a specific feature flag.
20895
+
20896
+ </dd>
20897
+ </dl>
20898
+ </dd>
20899
+ </dl>
20900
+
20901
+ #### 🔌 Usage
20902
+
20903
+ <dl>
20904
+ <dd>
20905
+
20906
+ <dl>
20907
+ <dd>
20908
+
20909
+ ```typescript
20910
+ await client.experimentation.featureFlags.variations.create("id", {
20911
+ name: "name",
20912
+ overrides: {
20913
+ key: "value",
20914
+ },
20915
+ });
20916
+ ```
20917
+
20918
+ </dd>
20919
+ </dl>
20920
+ </dd>
20921
+ </dl>
20922
+
20923
+ #### ⚙️ Parameters
20924
+
20925
+ <dl>
20926
+ <dd>
20927
+
20928
+ <dl>
20929
+ <dd>
20930
+
20931
+ **id:** `string` — The ID of the parent feature flag.
20932
+
20933
+ </dd>
20934
+ </dl>
20935
+
20936
+ <dl>
20937
+ <dd>
20938
+
20939
+ **request:** `Management.CreateVariationRequestContent`
20940
+
20941
+ </dd>
20942
+ </dl>
20943
+
20944
+ <dl>
20945
+ <dd>
20946
+
20947
+ **requestOptions:** `VariationsClient.RequestOptions`
20948
+
20949
+ </dd>
20950
+ </dl>
20951
+ </dd>
20952
+ </dl>
20953
+
20954
+ </dd>
20955
+ </dl>
20956
+ </details>
20957
+
20958
+ <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>
20959
+ <dl>
20960
+ <dd>
20961
+
20962
+ #### 📝 Description
20963
+
20964
+ <dl>
20965
+ <dd>
20966
+
20967
+ <dl>
20968
+ <dd>
20969
+
20970
+ Retrieve a single variation by its ID.
20971
+
20972
+ </dd>
20973
+ </dl>
20974
+ </dd>
20975
+ </dl>
20976
+
20977
+ #### 🔌 Usage
20978
+
20979
+ <dl>
20980
+ <dd>
20981
+
20982
+ <dl>
20983
+ <dd>
20984
+
20985
+ ```typescript
20986
+ await client.experimentation.featureFlags.variations.get("id", "vid");
20987
+ ```
20988
+
20989
+ </dd>
20990
+ </dl>
20991
+ </dd>
20992
+ </dl>
20993
+
20994
+ #### ⚙️ Parameters
20995
+
20996
+ <dl>
20997
+ <dd>
20998
+
20999
+ <dl>
21000
+ <dd>
21001
+
21002
+ **id:** `string` — The ID of the parent feature flag.
21003
+
21004
+ </dd>
21005
+ </dl>
21006
+
21007
+ <dl>
21008
+ <dd>
21009
+
21010
+ **vid:** `string` — The ID of the variation to retrieve.
21011
+
21012
+ </dd>
21013
+ </dl>
21014
+
21015
+ <dl>
21016
+ <dd>
21017
+
21018
+ **requestOptions:** `VariationsClient.RequestOptions`
21019
+
21020
+ </dd>
21021
+ </dl>
21022
+ </dd>
21023
+ </dl>
21024
+
21025
+ </dd>
21026
+ </dl>
21027
+ </details>
21028
+
21029
+ <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>
21030
+ <dl>
21031
+ <dd>
21032
+
21033
+ #### 📝 Description
21034
+
21035
+ <dl>
21036
+ <dd>
21037
+
21038
+ <dl>
21039
+ <dd>
21040
+
21041
+ Delete a variation by ID. Returns 204 if the variation does not exist. Returns 404 if the parent feature flag does not exist.
21042
+
21043
+ </dd>
21044
+ </dl>
21045
+ </dd>
21046
+ </dl>
21047
+
21048
+ #### 🔌 Usage
21049
+
21050
+ <dl>
21051
+ <dd>
21052
+
21053
+ <dl>
21054
+ <dd>
21055
+
21056
+ ```typescript
21057
+ await client.experimentation.featureFlags.variations.delete("id", "vid");
21058
+ ```
21059
+
21060
+ </dd>
21061
+ </dl>
21062
+ </dd>
21063
+ </dl>
21064
+
21065
+ #### ⚙️ Parameters
21066
+
21067
+ <dl>
21068
+ <dd>
21069
+
21070
+ <dl>
21071
+ <dd>
21072
+
21073
+ **id:** `string` — The ID of the parent feature flag.
21074
+
21075
+ </dd>
21076
+ </dl>
21077
+
21078
+ <dl>
21079
+ <dd>
21080
+
21081
+ **vid:** `string` — The ID of the variation to delete.
21082
+
21083
+ </dd>
21084
+ </dl>
21085
+
21086
+ <dl>
21087
+ <dd>
21088
+
21089
+ **requestOptions:** `VariationsClient.RequestOptions`
21090
+
21091
+ </dd>
21092
+ </dl>
21093
+ </dd>
21094
+ </dl>
21095
+
21096
+ </dd>
21097
+ </dl>
21098
+ </details>
21099
+
21100
+ <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>
21101
+ <dl>
21102
+ <dd>
21103
+
21104
+ #### 📝 Description
21105
+
21106
+ <dl>
21107
+ <dd>
21108
+
21109
+ <dl>
21110
+ <dd>
21111
+
21112
+ Partially update a variation by ID. Only provided fields are updated.
21113
+
21114
+ </dd>
21115
+ </dl>
21116
+ </dd>
21117
+ </dl>
21118
+
21119
+ #### 🔌 Usage
21120
+
21121
+ <dl>
21122
+ <dd>
21123
+
21124
+ <dl>
21125
+ <dd>
21126
+
21127
+ ```typescript
21128
+ await client.experimentation.featureFlags.variations.update("id", "vid");
21129
+ ```
21130
+
21131
+ </dd>
21132
+ </dl>
21133
+ </dd>
21134
+ </dl>
21135
+
21136
+ #### ⚙️ Parameters
21137
+
21138
+ <dl>
21139
+ <dd>
21140
+
21141
+ <dl>
21142
+ <dd>
21143
+
21144
+ **id:** `string` — The ID of the parent feature flag.
21145
+
21146
+ </dd>
21147
+ </dl>
21148
+
21149
+ <dl>
21150
+ <dd>
21151
+
21152
+ **vid:** `string` — The ID of the variation to update.
21153
+
21154
+ </dd>
21155
+ </dl>
21156
+
21157
+ <dl>
21158
+ <dd>
21159
+
21160
+ **request:** `Management.UpdateVariationRequestContent`
21161
+
21162
+ </dd>
21163
+ </dl>
21164
+
21165
+ <dl>
21166
+ <dd>
21167
+
21168
+ **requestOptions:** `VariationsClient.RequestOptions`
21169
+
21170
+ </dd>
21171
+ </dl>
21172
+ </dd>
21173
+ </dl>
21174
+
21175
+ </dd>
21176
+ </dl>
21177
+ </details>
21178
+
21179
+ ## Flows Executions
21180
+
21181
+ <details><summary><code>client.flows.executions.<a href="/src/management/api/resources/flows/resources/executions/client/Client.ts">list</a>(flow_id, { ...params }) -> core.Page&lt;Management.FlowExecutionSummary, Management.ListFlowExecutionsPaginatedResponseContent&gt;</code></summary>
21182
+ <dl>
21183
+ <dd>
21184
+
21185
+ #### 🔌 Usage
21186
+
21187
+ <dl>
21188
+ <dd>
21189
+
21190
+ <dl>
21191
+ <dd>
21192
+
21193
+ ```typescript
21194
+ const pageableResponse = await client.flows.executions.list("flow_id", {
21195
+ include_totals: true,
21196
+ from: "from",
21197
+ take: 1,
21198
+ });
21199
+ for await (const item of pageableResponse) {
21200
+ console.log(item);
21201
+ }
21202
+
21203
+ // Or you can manually iterate page-by-page
21204
+ let page = await client.flows.executions.list("flow_id", {
21205
+ include_totals: true,
21206
+ from: "from",
21207
+ take: 1,
21208
+ });
21209
+ while (page.hasNextPage()) {
21210
+ page = page.getNextPage();
21211
+ }
21212
+
21213
+ // You can also access the underlying response
21214
+ const response = page.response;
21215
+ ```
21216
+
21217
+ </dd>
21218
+ </dl>
21219
+ </dd>
21220
+ </dl>
21221
+
21222
+ #### ⚙️ Parameters
21223
+
21224
+ <dl>
21225
+ <dd>
21226
+
21227
+ <dl>
21228
+ <dd>
21229
+
21230
+ **flow_id:** `string` — Flow id
21231
+
21232
+ </dd>
21233
+ </dl>
21234
+
21235
+ <dl>
21236
+ <dd>
21237
+
21238
+ **request:** `Management.ListFlowExecutionsRequestParameters`
21239
+
21240
+ </dd>
21241
+ </dl>
21242
+
21243
+ <dl>
21244
+ <dd>
21245
+
21246
+ **requestOptions:** `ExecutionsClient.RequestOptions`
21247
+
21248
+ </dd>
21249
+ </dl>
21250
+ </dd>
21251
+ </dl>
21252
+
21253
+ </dd>
21254
+ </dl>
21255
+ </details>
21256
+
21257
+ <details><summary><code>client.flows.executions.<a href="/src/management/api/resources/flows/resources/executions/client/Client.ts">get</a>(flow_id, execution_id, { ...params }) -> Management.GetFlowExecutionResponseContent</code></summary>
21258
+ <dl>
21259
+ <dd>
21260
+
21261
+ #### 🔌 Usage
21262
+
21263
+ <dl>
21264
+ <dd>
21265
+
21266
+ <dl>
21267
+ <dd>
21268
+
21269
+ ```typescript
21270
+ await client.flows.executions.get("flow_id", "execution_id", {
21271
+ hydrate: ["debug"],
21272
+ });
21273
+ ```
21274
+
21275
+ </dd>
21276
+ </dl>
21277
+ </dd>
21278
+ </dl>
21279
+
21280
+ #### ⚙️ Parameters
21281
+
21282
+ <dl>
21283
+ <dd>
21284
+
21285
+ <dl>
21286
+ <dd>
21287
+
21288
+ **flow_id:** `string` — Flow id
21289
+
21290
+ </dd>
21291
+ </dl>
21292
+
21293
+ <dl>
21294
+ <dd>
21295
+
21296
+ **execution_id:** `string` — Flow execution id
21297
+
21298
+ </dd>
21299
+ </dl>
21300
+
21301
+ <dl>
21302
+ <dd>
21303
+
21304
+ **request:** `Management.GetFlowExecutionRequestParameters`
21305
+
21306
+ </dd>
21307
+ </dl>
21308
+
21309
+ <dl>
21310
+ <dd>
21311
+
21312
+ **requestOptions:** `ExecutionsClient.RequestOptions`
21313
+
21314
+ </dd>
21315
+ </dl>
21316
+ </dd>
21317
+ </dl>
21318
+
21319
+ </dd>
21320
+ </dl>
21321
+ </details>
21322
+
21323
+ <details><summary><code>client.flows.executions.<a href="/src/management/api/resources/flows/resources/executions/client/Client.ts">delete</a>(flow_id, execution_id) -> void</code></summary>
21324
+ <dl>
21325
+ <dd>
21326
+
21327
+ #### 🔌 Usage
21328
+
21329
+ <dl>
21330
+ <dd>
21331
+
21332
+ <dl>
21333
+ <dd>
21334
+
21335
+ ```typescript
21336
+ await client.flows.executions.delete("flow_id", "execution_id");
21337
+ ```
21338
+
21339
+ </dd>
21340
+ </dl>
21341
+ </dd>
21342
+ </dl>
21343
+
21344
+ #### ⚙️ Parameters
21345
+
21346
+ <dl>
21347
+ <dd>
21348
+
21349
+ <dl>
21350
+ <dd>
21351
+
21352
+ **flow_id:** `string` — Flows id
21353
+
21354
+ </dd>
21355
+ </dl>
21356
+
21357
+ <dl>
21358
+ <dd>
21359
+
21360
+ **execution_id:** `string` — Flow execution identifier
21361
+
21362
+ </dd>
21363
+ </dl>
21364
+
21365
+ <dl>
21366
+ <dd>
21367
+
21368
+ **requestOptions:** `ExecutionsClient.RequestOptions`
21369
+
21370
+ </dd>
21371
+ </dl>
21372
+ </dd>
21373
+ </dl>
21374
+
21375
+ </dd>
21376
+ </dl>
21377
+ </details>
21378
+
21379
+ ## Flows Vault Connections
21380
+
21381
+ <details><summary><code>client.flows.vault.connections.<a href="/src/management/api/resources/flows/resources/vault/resources/connections/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.FlowsVaultConnectionSummary, Management.ListFlowsVaultConnectionsOffsetPaginatedResponseContent&gt;</code></summary>
21382
+ <dl>
21383
+ <dd>
21384
+
21385
+ #### 🔌 Usage
21386
+
21387
+ <dl>
21388
+ <dd>
21389
+
21390
+ <dl>
21391
+ <dd>
21392
+
21393
+ ```typescript
21394
+ const pageableResponse = await client.flows.vault.connections.list({
21395
+ page: 1,
21396
+ per_page: 1,
21397
+ include_totals: true,
21398
+ });
21399
+ for await (const item of pageableResponse) {
21400
+ console.log(item);
21401
+ }
21402
+
21403
+ // Or you can manually iterate page-by-page
21404
+ let page = await client.flows.vault.connections.list({
21405
+ page: 1,
21406
+ per_page: 1,
21407
+ include_totals: true,
21408
+ });
21409
+ while (page.hasNextPage()) {
21410
+ page = page.getNextPage();
21411
+ }
21412
+
21413
+ // You can also access the underlying response
21414
+ const response = page.response;
21415
+ ```
21416
+
21417
+ </dd>
21418
+ </dl>
21419
+ </dd>
21420
+ </dl>
21421
+
21422
+ #### ⚙️ Parameters
21423
+
21424
+ <dl>
21425
+ <dd>
21426
+
21427
+ <dl>
21428
+ <dd>
21429
+
21430
+ **request:** `Management.ListFlowsVaultConnectionsRequestParameters`
21431
+
21432
+ </dd>
21433
+ </dl>
21434
+
21435
+ <dl>
21436
+ <dd>
21437
+
21438
+ **requestOptions:** `ConnectionsClient.RequestOptions`
21439
+
21440
+ </dd>
21441
+ </dl>
21442
+ </dd>
21443
+ </dl>
21444
+
21445
+ </dd>
21446
+ </dl>
21447
+ </details>
21448
+
21449
+ <details><summary><code>client.flows.vault.connections.<a href="/src/management/api/resources/flows/resources/vault/resources/connections/client/Client.ts">create</a>({ ...params }) -> Management.CreateFlowsVaultConnectionResponseContent</code></summary>
21450
+ <dl>
21451
+ <dd>
21452
+
21453
+ #### 🔌 Usage
21454
+
21455
+ <dl>
21456
+ <dd>
21457
+
21458
+ <dl>
21459
+ <dd>
21460
+
21461
+ ```typescript
21462
+ await client.flows.vault.connections.create({
21463
+ name: "name",
21464
+ app_id: "ACTIVECAMPAIGN",
19742
21465
  setup: {
19743
21466
  type: "API_KEY",
19744
21467
  api_key: "api_key",
@@ -26697,213 +28420,6 @@ await client.organizations.members.delete("id", {
26697
28420
  </dl>
26698
28421
  </details>
26699
28422
 
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
28423
  ## Organizations Groups
26908
28424
 
26909
28425
  <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>