auth0 7.2.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.
- package/dist/cjs/management/api/requests/requests.d.ts +208 -4
- package/dist/cjs/management/api/resources/experimentation/client/Client.d.ts +6 -0
- package/dist/cjs/management/api/resources/experimentation/client/Client.js +10 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.d.ts +133 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.js +485 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.d.ts +126 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/client/Client.js +471 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/exports.d.ts +3 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/exports.js +22 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/index.js +18 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.ts +109 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.js +390 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.js +2 -0
- package/dist/cjs/management/api/resources/experimentation/resources/featureFlags/resources/variations/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/exports.js +2 -2
- package/dist/cjs/management/api/resources/experimentation/resources/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/experimentation/resources/index.js +3 -1
- package/dist/cjs/management/api/resources/experimentation/resources/segments/client/Client.d.ts +104 -0
- package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/segments}/client/Client.js +205 -39
- package/dist/cjs/management/api/resources/experimentation/resources/segments/client/index.js +2 -0
- package/dist/cjs/management/api/resources/experimentation/resources/segments/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/experimentation/resources/segments/exports.js +21 -0
- package/dist/cjs/management/api/resources/experimentation/resources/segments/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/experimentation/resources/segments/index.js +17 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +0 -3
- package/dist/cjs/management/api/resources/organizations/client/Client.js +2 -7
- package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +0 -1
- package/dist/cjs/management/api/resources/organizations/resources/index.js +1 -2
- package/dist/cjs/management/api/resources/users/client/Client.d.ts +8 -10
- package/dist/cjs/management/api/resources/users/client/Client.js +8 -10
- package/dist/cjs/management/api/types/types.d.ts +507 -91
- package/dist/cjs/management/api/types/types.js +99 -50
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/api/requests/requests.d.mts +208 -4
- package/dist/esm/management/api/resources/experimentation/client/Client.d.mts +6 -0
- package/dist/esm/management/api/resources/experimentation/client/Client.mjs +10 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.d.mts +133 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.mjs +485 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.d.mts +126 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/Client.mjs +434 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/exports.d.mts +3 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/exports.mjs +4 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/index.d.mts +2 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/index.mjs +2 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.d.mts +109 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/Client.mjs +353 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/featureFlags/resources/variations/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/exports.mjs +1 -1
- package/dist/esm/management/api/resources/experimentation/resources/index.d.mts +2 -0
- package/dist/esm/management/api/resources/experimentation/resources/index.mjs +2 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.d.mts +104 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.mjs +361 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/exports.mjs +3 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/segments/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +0 -3
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +0 -5
- package/dist/esm/management/api/resources/organizations/resources/index.d.mts +0 -1
- package/dist/esm/management/api/resources/organizations/resources/index.mjs +0 -1
- package/dist/esm/management/api/resources/users/client/Client.d.mts +8 -10
- package/dist/esm/management/api/resources/users/client/Client.mjs +8 -10
- package/dist/esm/management/api/types/types.d.mts +507 -91
- package/dist/esm/management/api/types/types.mjs +78 -29
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +34 -12
- package/reference.md +1635 -220
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.ts +0 -63
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/exports.d.ts +0 -2
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.mts +0 -63
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.mjs +0 -195
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/exports.d.mts +0 -2
- /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags}/client/index.d.ts +0 -0
- /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags}/client/index.js +0 -0
- /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
- /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.d.ts +0 -0
- /package/dist/cjs/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.js +0 -0
- /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
- /package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.d.mts +0 -0
- /package/dist/esm/management/api/resources/{organizations/resources/organizationTemplate → experimentation/resources/featureFlags/resources/variations}/index.mjs +0 -0
|
@@ -347,6 +347,7 @@ export interface CreateClientRequestContent {
|
|
|
347
347
|
b2b_integration_configuration?: Management.B2BIntegrationConfiguration;
|
|
348
348
|
my_organization_configuration?: Management.ClientMyOrganizationPostConfiguration;
|
|
349
349
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration;
|
|
350
|
+
oidc_support?: Management.ClientOidcSupportPost;
|
|
350
351
|
}
|
|
351
352
|
/**
|
|
352
353
|
* @example
|
|
@@ -1470,6 +1471,8 @@ export interface CreateResourceServerRequestContent {
|
|
|
1470
1471
|
access_token?: Management.ResourceServerAccessToken | null;
|
|
1471
1472
|
token_encryption?: Management.ResourceServerTokenEncryption | null;
|
|
1472
1473
|
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
|
|
1474
|
+
/** When true, the resource server requires every consent approval to be digitally signed, so the approver cannot later deny a consent they granted. When false, consent decisions do not need a signature. Defaults to false. A configured value is still returned even after the related entitlement is disabled. */
|
|
1475
|
+
require_consent_non_repudiation?: boolean;
|
|
1473
1476
|
authorization_details?: unknown[] | null;
|
|
1474
1477
|
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
|
|
1475
1478
|
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
|
|
@@ -1543,6 +1546,8 @@ export interface UpdateResourceServerRequestContent {
|
|
|
1543
1546
|
access_token?: Management.ResourceServerAccessToken | null;
|
|
1544
1547
|
token_encryption?: Management.ResourceServerTokenEncryption | null;
|
|
1545
1548
|
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
|
|
1549
|
+
/** When true, the resource server requires every consent approval to be digitally signed, so the approver cannot later deny a consent they granted. When false, consent decisions do not need a signature. Defaults to false. A configured value is still returned even after the related entitlement is disabled. */
|
|
1550
|
+
require_consent_non_repudiation?: boolean;
|
|
1546
1551
|
authorization_details?: unknown[] | null;
|
|
1547
1552
|
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
|
|
1548
1553
|
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
|
|
@@ -1898,8 +1903,8 @@ export interface ListUserBlocksByIdentifierRequestParameters {
|
|
|
1898
1903
|
/** Should be any of a username, phone number, or email. */
|
|
1899
1904
|
identifier: string;
|
|
1900
1905
|
/**
|
|
1901
|
-
* If true
|
|
1902
|
-
* If
|
|
1906
|
+
* If true, returns only blocks that are currently enforced (e.g. subject to protection status, IP allowlist, etc.).
|
|
1907
|
+
* If false or omitted, returns all blocks regardless of enforcement state.
|
|
1903
1908
|
*
|
|
1904
1909
|
*/
|
|
1905
1910
|
consider_brute_force_enablement?: boolean | null;
|
|
@@ -1922,8 +1927,8 @@ export interface DeleteUserBlocksByIdentifierRequestParameters {
|
|
|
1922
1927
|
*/
|
|
1923
1928
|
export interface ListUserBlocksRequestParameters {
|
|
1924
1929
|
/**
|
|
1925
|
-
* If true
|
|
1926
|
-
* If
|
|
1930
|
+
* If true, returns only blocks that are currently enforced (e.g. subject to protection status, IP allowlist, etc.).
|
|
1931
|
+
* If false or omitted, returns all blocks regardless of enforcement state.
|
|
1927
1932
|
*
|
|
1928
1933
|
*/
|
|
1929
1934
|
consider_brute_force_enablement?: boolean | null;
|
|
@@ -2824,6 +2829,71 @@ export interface CreateEventStreamRedeliveryRequestContent {
|
|
|
2824
2829
|
/** Filter by event type */
|
|
2825
2830
|
event_types?: Management.EventStreamEventTypeEnum[];
|
|
2826
2831
|
}
|
|
2832
|
+
/**
|
|
2833
|
+
* @example
|
|
2834
|
+
* {
|
|
2835
|
+
* from: "from",
|
|
2836
|
+
* take: 1,
|
|
2837
|
+
* status: "draft",
|
|
2838
|
+
* authentication_flow: "authentication_flow",
|
|
2839
|
+
* feature_flag_id: "feature_flag_id"
|
|
2840
|
+
* }
|
|
2841
|
+
*/
|
|
2842
|
+
export interface ListExperimentsRequestParameters {
|
|
2843
|
+
/** Optional Id from which to start selection. */
|
|
2844
|
+
from?: string | null;
|
|
2845
|
+
/** Number of experiments to return per page. Defaults to 25, maximum 50. */
|
|
2846
|
+
take?: number | null;
|
|
2847
|
+
/** Filter by status. Exact match. */
|
|
2848
|
+
status?: Management.ExperimentStatusEnum | null;
|
|
2849
|
+
/** Filter by authentication flow. Exact match. */
|
|
2850
|
+
authentication_flow?: string | null;
|
|
2851
|
+
/** Filter by feature flag ID. Exact match. */
|
|
2852
|
+
feature_flag_id?: string | null;
|
|
2853
|
+
}
|
|
2854
|
+
/**
|
|
2855
|
+
* @example
|
|
2856
|
+
* {
|
|
2857
|
+
* name: "name",
|
|
2858
|
+
* feature_flag_id: "feature_flag_id",
|
|
2859
|
+
* authentication_flow: "authentication"
|
|
2860
|
+
* }
|
|
2861
|
+
*/
|
|
2862
|
+
export interface CreateExperimentRequestContent {
|
|
2863
|
+
/** A human-readable name for the experiment */
|
|
2864
|
+
name: string;
|
|
2865
|
+
/** A description of the experiment */
|
|
2866
|
+
description?: string;
|
|
2867
|
+
/** The ID of the feature flag this experiment is based on */
|
|
2868
|
+
feature_flag_id: string;
|
|
2869
|
+
authentication_flow: Management.AuthenticationFlowEnum;
|
|
2870
|
+
/** Applies only to Auth0-managed flags. Controls where non-overridden config keys resolve from: 'tenant' inherits the tenant's live config so the experiment overlays only its changes, 'flag' uses the flag's frozen defaults for a complete config. Optional; defaults to 'tenant' when omitted. Rejected for customer-defined flags. */
|
|
2871
|
+
default_config?: Management.DefaultConfigEnum;
|
|
2872
|
+
/** The traffic allocation strategy for this experiment */
|
|
2873
|
+
allocation_strategy?: Management.AllocationStrategyEnum;
|
|
2874
|
+
/** Traffic allocations mapping variations to weights or segments */
|
|
2875
|
+
allocations?: Management.AllocationRequestItem[];
|
|
2876
|
+
/** Ramp experiment levels configuration. A strictly-increasing sequence of exposure percentages, each an integer in [0, 100]. */
|
|
2877
|
+
levels?: number[];
|
|
2878
|
+
}
|
|
2879
|
+
/**
|
|
2880
|
+
* @example
|
|
2881
|
+
* {}
|
|
2882
|
+
*/
|
|
2883
|
+
export interface UpdateExperimentRequestParameters {
|
|
2884
|
+
/** A human-readable name for the experiment */
|
|
2885
|
+
name?: string;
|
|
2886
|
+
/** A description of the experiment */
|
|
2887
|
+
description?: string | null;
|
|
2888
|
+
/** Specifies the target authentication flow for this experiment. This field can only be modified on draft experiments. Must be one of: authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, or all. Note that the all value targets every flow at once, but requires that this is the only active experiment. */
|
|
2889
|
+
authentication_flow?: Management.AuthenticationFlowEnum;
|
|
2890
|
+
/** Replaces all traffic allocations. Cannot be modified while the experiment is active. */
|
|
2891
|
+
allocations?: Management.AllocationRequestItem[];
|
|
2892
|
+
/** Applies only to Auth0-managed flags. Controls where non-overridden config keys resolve from: 'tenant' inherits the tenant's live config, 'flag' uses the flag's frozen defaults. Can only be modified on draft experiments. Rejected for customer-defined flags. */
|
|
2893
|
+
default_config?: Management.DefaultConfigEnum;
|
|
2894
|
+
/** Ramp experiment levels configuration. A strictly-increasing sequence of exposure percentages, each an integer in [0, 100]. Can only be modified on draft experiments. */
|
|
2895
|
+
levels?: number[];
|
|
2896
|
+
}
|
|
2827
2897
|
/**
|
|
2828
2898
|
* @example
|
|
2829
2899
|
* {
|
|
@@ -2834,6 +2904,140 @@ export interface AdvanceRampRequestContent {
|
|
|
2834
2904
|
/** The target percentage level from the experiment schedule. Must be the immediate next level. */
|
|
2835
2905
|
target_level: number;
|
|
2836
2906
|
}
|
|
2907
|
+
/**
|
|
2908
|
+
* @example
|
|
2909
|
+
* {
|
|
2910
|
+
* status: "active"
|
|
2911
|
+
* }
|
|
2912
|
+
*/
|
|
2913
|
+
export interface UpdateExperimentStatusRequestContent {
|
|
2914
|
+
status: Management.ExperimentTransitionStatusEnum;
|
|
2915
|
+
}
|
|
2916
|
+
/**
|
|
2917
|
+
* @example
|
|
2918
|
+
* {
|
|
2919
|
+
* from: "from",
|
|
2920
|
+
* take: 1,
|
|
2921
|
+
* type: "auth0",
|
|
2922
|
+
* status: "draft"
|
|
2923
|
+
* }
|
|
2924
|
+
*/
|
|
2925
|
+
export interface ListFeatureFlagsRequestParameters {
|
|
2926
|
+
/** Optional Id from which to start selection. */
|
|
2927
|
+
from?: string | null;
|
|
2928
|
+
/** Number of feature flags to return per page. Defaults to 25, maximum 50. */
|
|
2929
|
+
take?: number | null;
|
|
2930
|
+
/** Filter by type. Exact match. */
|
|
2931
|
+
type?: Management.FeatureFlagTypeEnum | null;
|
|
2932
|
+
/** Filter by status. Exact match. */
|
|
2933
|
+
status?: Management.FeatureFlagStatusEnum | null;
|
|
2934
|
+
}
|
|
2935
|
+
/**
|
|
2936
|
+
* @example
|
|
2937
|
+
* {
|
|
2938
|
+
* name: "name",
|
|
2939
|
+
* parameters: {}
|
|
2940
|
+
* }
|
|
2941
|
+
*/
|
|
2942
|
+
export interface CreateFeatureFlagRequestContent {
|
|
2943
|
+
/** A human-readable name for the feature flag */
|
|
2944
|
+
name: string;
|
|
2945
|
+
/** A description of what this feature flag controls */
|
|
2946
|
+
description?: string;
|
|
2947
|
+
parameters: Management.CreateFeatureFlagParameters;
|
|
2948
|
+
}
|
|
2949
|
+
/**
|
|
2950
|
+
* @example
|
|
2951
|
+
* {}
|
|
2952
|
+
*/
|
|
2953
|
+
export interface UpdateFeatureFlagRequestContent {
|
|
2954
|
+
/** A human-readable name for the feature flag */
|
|
2955
|
+
name?: string;
|
|
2956
|
+
/** A description of what this feature flag controls */
|
|
2957
|
+
description?: string | null;
|
|
2958
|
+
parameters?: Management.UpdateFeatureFlagParameters;
|
|
2959
|
+
}
|
|
2960
|
+
/**
|
|
2961
|
+
* @example
|
|
2962
|
+
* {
|
|
2963
|
+
* status: "draft"
|
|
2964
|
+
* }
|
|
2965
|
+
*/
|
|
2966
|
+
export interface UpdateFeatureFlagStatusRequestContent {
|
|
2967
|
+
/** The target status to transition the feature flag to. */
|
|
2968
|
+
status: Management.FeatureFlagStatusEnum;
|
|
2969
|
+
}
|
|
2970
|
+
/**
|
|
2971
|
+
* @example
|
|
2972
|
+
* {
|
|
2973
|
+
* from: "from",
|
|
2974
|
+
* take: 1,
|
|
2975
|
+
* type: "auth0"
|
|
2976
|
+
* }
|
|
2977
|
+
*/
|
|
2978
|
+
export interface ListSegmentsRequestParameters {
|
|
2979
|
+
/** Optional Id from which to start selection. */
|
|
2980
|
+
from?: string | null;
|
|
2981
|
+
/** Number of segments to return per page. Defaults to 25, maximum 50. */
|
|
2982
|
+
take?: number | null;
|
|
2983
|
+
/** Filter by type. Exact match. */
|
|
2984
|
+
type?: Management.SegmentTypeFilterEnum | null;
|
|
2985
|
+
}
|
|
2986
|
+
/**
|
|
2987
|
+
* @example
|
|
2988
|
+
* {
|
|
2989
|
+
* name: "name",
|
|
2990
|
+
* rules: [{}]
|
|
2991
|
+
* }
|
|
2992
|
+
*/
|
|
2993
|
+
export interface CreateSegmentRequestContent {
|
|
2994
|
+
/** A human-readable name for the segment */
|
|
2995
|
+
name: string;
|
|
2996
|
+
/** A description of the segment */
|
|
2997
|
+
description?: string;
|
|
2998
|
+
/** An ordered list of rules. A segment matches if any rule matches. Each rule is limited to 4KB and the whole segment to 10KB (serialized). */
|
|
2999
|
+
rules: Management.SegmentRule[];
|
|
3000
|
+
}
|
|
3001
|
+
/**
|
|
3002
|
+
* @example
|
|
3003
|
+
* {}
|
|
3004
|
+
*/
|
|
3005
|
+
export interface UpdateSegmentRequestContent {
|
|
3006
|
+
/** A human-readable name for the segment */
|
|
3007
|
+
name?: string;
|
|
3008
|
+
/** A description of the segment */
|
|
3009
|
+
description?: string | null;
|
|
3010
|
+
/** Replaces the entire rules array. Each rule is limited to 4KB and the whole segment to 10KB (serialized). */
|
|
3011
|
+
rules?: Management.SegmentRule[];
|
|
3012
|
+
}
|
|
3013
|
+
/**
|
|
3014
|
+
* @example
|
|
3015
|
+
* {
|
|
3016
|
+
* name: "name",
|
|
3017
|
+
* overrides: {
|
|
3018
|
+
* "key": "value"
|
|
3019
|
+
* }
|
|
3020
|
+
* }
|
|
3021
|
+
*/
|
|
3022
|
+
export interface CreateVariationRequestContent {
|
|
3023
|
+
/** A human-readable name for the variation */
|
|
3024
|
+
name: string;
|
|
3025
|
+
/** A description of what this variation controls */
|
|
3026
|
+
description?: string;
|
|
3027
|
+
/** Configuration overrides for this variation; keys must exist in the parent flag parameters. Empty {} is the baseline (control) variation that overrides nothing. */
|
|
3028
|
+
overrides: Management.VariationOverridesMap;
|
|
3029
|
+
}
|
|
3030
|
+
/**
|
|
3031
|
+
* @example
|
|
3032
|
+
* {}
|
|
3033
|
+
*/
|
|
3034
|
+
export interface UpdateVariationRequestContent {
|
|
3035
|
+
/** A human-readable name for the variation */
|
|
3036
|
+
name?: string;
|
|
3037
|
+
/** A description of what this variation controls */
|
|
3038
|
+
description?: string | null;
|
|
3039
|
+
overrides?: Management.UpdateVariationOverridesMap;
|
|
3040
|
+
}
|
|
2837
3041
|
/**
|
|
2838
3042
|
* @example
|
|
2839
3043
|
* {
|
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
import type { BaseClientOptions } from "../../../../BaseClient.js";
|
|
2
2
|
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
3
3
|
import { ExperimentsClient } from "../resources/experiments/client/Client.js";
|
|
4
|
+
import { FeatureFlagsClient } from "../resources/featureFlags/client/Client.js";
|
|
5
|
+
import { SegmentsClient } from "../resources/segments/client/Client.js";
|
|
4
6
|
export declare namespace ExperimentationClient {
|
|
5
7
|
type Options = BaseClientOptions;
|
|
6
8
|
}
|
|
7
9
|
export declare class ExperimentationClient {
|
|
8
10
|
protected readonly _options: NormalizedClientOptionsWithAuth<ExperimentationClient.Options>;
|
|
9
11
|
protected _experiments: ExperimentsClient | undefined;
|
|
12
|
+
protected _featureFlags: FeatureFlagsClient | undefined;
|
|
13
|
+
protected _segments: SegmentsClient | undefined;
|
|
10
14
|
constructor(options: ExperimentationClient.Options);
|
|
11
15
|
get experiments(): ExperimentsClient;
|
|
16
|
+
get featureFlags(): FeatureFlagsClient;
|
|
17
|
+
get segments(): SegmentsClient;
|
|
12
18
|
}
|
|
@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.ExperimentationClient = void 0;
|
|
5
5
|
const BaseClient_js_1 = require("../../../../BaseClient.js");
|
|
6
6
|
const Client_js_1 = require("../resources/experiments/client/Client.js");
|
|
7
|
+
const Client_js_2 = require("../resources/featureFlags/client/Client.js");
|
|
8
|
+
const Client_js_3 = require("../resources/segments/client/Client.js");
|
|
7
9
|
class ExperimentationClient {
|
|
8
10
|
constructor(options) {
|
|
9
11
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
@@ -12,5 +14,13 @@ class ExperimentationClient {
|
|
|
12
14
|
var _a;
|
|
13
15
|
return ((_a = this._experiments) !== null && _a !== void 0 ? _a : (this._experiments = new Client_js_1.ExperimentsClient(this._options)));
|
|
14
16
|
}
|
|
17
|
+
get featureFlags() {
|
|
18
|
+
var _a;
|
|
19
|
+
return ((_a = this._featureFlags) !== null && _a !== void 0 ? _a : (this._featureFlags = new Client_js_2.FeatureFlagsClient(this._options)));
|
|
20
|
+
}
|
|
21
|
+
get segments() {
|
|
22
|
+
var _a;
|
|
23
|
+
return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_js_3.SegmentsClient(this._options)));
|
|
24
|
+
}
|
|
15
25
|
}
|
|
16
26
|
exports.ExperimentationClient = ExperimentationClient;
|
package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.d.ts
CHANGED
|
@@ -10,6 +10,101 @@ export declare namespace ExperimentsClient {
|
|
|
10
10
|
export declare class ExperimentsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ExperimentsClient.Options>;
|
|
12
12
|
constructor(options: ExperimentsClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Retrieve a paginated list of experiments for the tenant, with optional filters.
|
|
15
|
+
*
|
|
16
|
+
* @param {Management.ListExperimentsRequestParameters} request
|
|
17
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
|
+
*
|
|
19
|
+
* @throws {@link Management.BadRequestError}
|
|
20
|
+
* @throws {@link Management.UnauthorizedError}
|
|
21
|
+
* @throws {@link Management.ForbiddenError}
|
|
22
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* await client.experimentation.experiments.list({
|
|
26
|
+
* from: "from",
|
|
27
|
+
* take: 1,
|
|
28
|
+
* status: "draft",
|
|
29
|
+
* authentication_flow: "authentication_flow",
|
|
30
|
+
* feature_flag_id: "feature_flag_id"
|
|
31
|
+
* })
|
|
32
|
+
*/
|
|
33
|
+
list(request?: Management.ListExperimentsRequestParameters, requestOptions?: ExperimentsClient.RequestOptions): Promise<core.Page<Management.ExperimentListItem, Management.ListExperimentsResponseContent>>;
|
|
34
|
+
/**
|
|
35
|
+
* Create a new experiment for A/B testing.
|
|
36
|
+
*
|
|
37
|
+
* @param {Management.CreateExperimentRequestContent} request
|
|
38
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link Management.BadRequestError}
|
|
41
|
+
* @throws {@link Management.UnauthorizedError}
|
|
42
|
+
* @throws {@link Management.ForbiddenError}
|
|
43
|
+
* @throws {@link Management.NotFoundError}
|
|
44
|
+
* @throws {@link Management.ConflictError}
|
|
45
|
+
* @throws {@link Management.UnprocessableEntityError}
|
|
46
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* await client.experimentation.experiments.create({
|
|
50
|
+
* name: "name",
|
|
51
|
+
* feature_flag_id: "feature_flag_id",
|
|
52
|
+
* authentication_flow: "authentication"
|
|
53
|
+
* })
|
|
54
|
+
*/
|
|
55
|
+
create(request: Management.CreateExperimentRequestContent, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.CreateExperimentResponseContent>;
|
|
56
|
+
private __create;
|
|
57
|
+
/**
|
|
58
|
+
* Retrieve a single experiment with its allocations by ID.
|
|
59
|
+
*
|
|
60
|
+
* @param {string} id - The ID of the experiment to retrieve.
|
|
61
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link Management.UnauthorizedError}
|
|
64
|
+
* @throws {@link Management.ForbiddenError}
|
|
65
|
+
* @throws {@link Management.NotFoundError}
|
|
66
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* await client.experimentation.experiments.get("id")
|
|
70
|
+
*/
|
|
71
|
+
get(id: string, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.GetExperimentResponseContent>;
|
|
72
|
+
private __get;
|
|
73
|
+
/**
|
|
74
|
+
* 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.
|
|
75
|
+
*
|
|
76
|
+
* @param {string} id - The ID of the experiment to delete.
|
|
77
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link Management.BadRequestError}
|
|
80
|
+
* @throws {@link Management.ForbiddenError}
|
|
81
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* await client.experimentation.experiments.delete("id")
|
|
85
|
+
*/
|
|
86
|
+
delete(id: string, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
87
|
+
private __delete;
|
|
88
|
+
/**
|
|
89
|
+
* Partially update an experiment by ID. Only provided fields are updated. Providing allocations replaces the entire allocations set.
|
|
90
|
+
*
|
|
91
|
+
* @param {string} id - The ID of the experiment to update.
|
|
92
|
+
* @param {Management.UpdateExperimentRequestParameters} request
|
|
93
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link Management.BadRequestError}
|
|
96
|
+
* @throws {@link Management.UnauthorizedError}
|
|
97
|
+
* @throws {@link Management.ForbiddenError}
|
|
98
|
+
* @throws {@link Management.NotFoundError}
|
|
99
|
+
* @throws {@link Management.ConflictError}
|
|
100
|
+
* @throws {@link Management.UnprocessableEntityError}
|
|
101
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* await client.experimentation.experiments.update("id")
|
|
105
|
+
*/
|
|
106
|
+
update(id: string, request?: Management.UpdateExperimentRequestParameters, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.UpdateExperimentResponseContent>;
|
|
107
|
+
private __update;
|
|
13
108
|
/**
|
|
14
109
|
* 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.
|
|
15
110
|
*
|
|
@@ -31,4 +126,42 @@ export declare class ExperimentsClient {
|
|
|
31
126
|
*/
|
|
32
127
|
advanceRamp(id: string, request: Management.AdvanceRampRequestContent, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.AdvanceRampResponseContent>;
|
|
33
128
|
private __advanceRamp;
|
|
129
|
+
/**
|
|
130
|
+
* Transitions an experiment through its lifecycle: draft → active, active → paused, paused → active, active/paused → completed. Activation runs full readiness validation.
|
|
131
|
+
*
|
|
132
|
+
* @param {string} id - The ID of the experiment to transition.
|
|
133
|
+
* @param {Management.UpdateExperimentStatusRequestContent} request
|
|
134
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link Management.BadRequestError}
|
|
137
|
+
* @throws {@link Management.UnauthorizedError}
|
|
138
|
+
* @throws {@link Management.ForbiddenError}
|
|
139
|
+
* @throws {@link Management.NotFoundError}
|
|
140
|
+
* @throws {@link Management.ConflictError}
|
|
141
|
+
* @throws {@link Management.UnprocessableEntityError}
|
|
142
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* await client.experimentation.experiments.updateStatus("id", {
|
|
146
|
+
* status: "active"
|
|
147
|
+
* })
|
|
148
|
+
*/
|
|
149
|
+
updateStatus(id: string, request: Management.UpdateExperimentStatusRequestContent, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.UpdateExperimentStatusResponseContent>;
|
|
150
|
+
private __updateStatus;
|
|
151
|
+
/**
|
|
152
|
+
* 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.
|
|
153
|
+
*
|
|
154
|
+
* @param {string} id - The ID of the experiment to validate.
|
|
155
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link Management.UnauthorizedError}
|
|
158
|
+
* @throws {@link Management.ForbiddenError}
|
|
159
|
+
* @throws {@link Management.NotFoundError}
|
|
160
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* await client.experimentation.experiments.validate("id")
|
|
164
|
+
*/
|
|
165
|
+
validate(id: string, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.ValidateExperimentResponseContent>;
|
|
166
|
+
private __validate;
|
|
34
167
|
}
|