Class VariationsClient

Index

Constructors

constructor

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

Methods

list

list(
id: string,
requestOptions?: VariationsClient.RequestOptions,
): HttpResponsePromise<ListVariationsResponseContent>
Retrieve all variations defined for a specific feature flag.
Parameters
- id: string
  The ID of the parent feature flag.
- OptionalrequestOptions: VariationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListVariationsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

create

create(
    id: string,
    request: CreateVariationRequestContent,
    requestOptions?: VariationsClient.RequestOptions,
): HttpResponsePromise<CreateVariationResponseContent>
Create a new variation with parameter overrides for a specific feature flag.
Parameters
- id: string
  The ID of the parent feature flag.
- request: CreateVariationRequestContent
- OptionalrequestOptions: VariationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateVariationResponseContent>
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.variations.create("id", {
        name: "name",
        overrides: {
            "key": "value"
        }
    })
```

get

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

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

delete

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

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

update

update(
    id: string,
    vid: string,
    request?: UpdateVariationRequestContent,
    requestOptions?: VariationsClient.RequestOptions,
): HttpResponsePromise<UpdateVariationResponseContent>
Partially update a variation by ID. Only provided fields are updated.
Parameters
- id: string
  The ID of the parent feature flag.
- vid: string
  The ID of the variation to update.
- request: UpdateVariationRequestContent = {}
- OptionalrequestOptions: VariationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateVariationResponseContent>
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.variations.update("id", "vid")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class VariationsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns VariationsClient

Methods

list

Parameters

Returns HttpResponsePromise<ListVariationsResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateVariationResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetVariationResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateVariationResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options