Class FeatureFlagsClient

Index

Accessors

variations

get variations(): VariationsClient

Returns VariationsClient

Constructors

constructor

new FeatureFlagsClient(options: BaseClientOptions): FeatureFlagsClient
Parameters
- options: BaseClientOptions
Returns FeatureFlagsClient

Methods

list

list(
request?: ListFeatureFlagsRequestParameters,
requestOptions?: FeatureFlagsClient.RequestOptions,
): Promise<Page<FeatureFlag, ListFeatureFlagsResponseContent>>
Retrieve a paginated list of feature flags for the tenant.
Parameters
- request: ListFeatureFlagsRequestParameters = {}
- OptionalrequestOptions: FeatureFlagsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<FeatureFlag, ListFeatureFlagsResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.experimentation.featureFlags.list({
        from: "from",
        take: 1,
        type: "auth0",
        status: "draft"
    })
```

create

create(
request: CreateFeatureFlagRequestContent,
requestOptions?: FeatureFlagsClient.RequestOptions,
): HttpResponsePromise<CreateFeatureFlagResponseContent>
Create a new feature flag with parameters for use in experiments.
Parameters
- request: CreateFeatureFlagRequestContent
- OptionalrequestOptions: FeatureFlagsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateFeatureFlagResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.experimentation.featureFlags.create({
        name: "name",
        parameters: {}
    })
```

get

get(
id: string,
requestOptions?: FeatureFlagsClient.RequestOptions,
): HttpResponsePromise<GetFeatureFlagResponseContent>
Retrieve a single feature flag by its ID.
Parameters
- id: string
  The ID of the feature flag to retrieve.
- OptionalrequestOptions: FeatureFlagsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetFeatureFlagResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.experimentation.featureFlags.get("id")
```

delete

delete(
id: string,
requestOptions?: FeatureFlagsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a feature flag by ID. Idempotent: returns 204 even if flag does not exist.
Parameters
- id: string
  The ID of the feature flag to delete.
- OptionalrequestOptions: FeatureFlagsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.experimentation.featureFlags.delete("id")
```

update

update(
    id: string,
    request?: UpdateFeatureFlagRequestContent,
    requestOptions?: FeatureFlagsClient.RequestOptions,
): HttpResponsePromise<UpdateFeatureFlagResponseContent>
Partially update a feature flag by ID. Only provided fields are updated.
Parameters
- id: string
  The ID of the feature flag to update.
- request: UpdateFeatureFlagRequestContent = {}
- OptionalrequestOptions: FeatureFlagsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateFeatureFlagResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.experimentation.featureFlags.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_variations

_variations: VariationsClient | undefined

Class FeatureFlagsClient

Index

Accessors

Constructors

Methods

Properties

Accessors

variations

Returns VariationsClient

Constructors

constructor

Parameters

Returns FeatureFlagsClient

Methods

list

Parameters

Returns Promise<Page<FeatureFlag, ListFeatureFlagsResponseContent>>

Throws

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateFeatureFlagResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetFeatureFlagResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateFeatureFlagResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Protected_variations

Settings

On This Page

`Protected` `Readonly`_options

`Protected`_variations