Class SegmentsClient

Index

Constructors

constructor

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

Methods

list

list(
request?: ListSegmentsRequestParameters,
requestOptions?: SegmentsClient.RequestOptions,
): Promise<Page<Segment, ListSegmentsResponseContent>>
Retrieve a paginated list of segments for the tenant.
Parameters
- request: ListSegmentsRequestParameters = {}
- OptionalrequestOptions: SegmentsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Segment, ListSegmentsResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

create

create(
request: CreateSegmentRequestContent,
requestOptions?: SegmentsClient.RequestOptions,
): HttpResponsePromise<CreateSegmentResponseContent>
Create a new segment with rule-based membership criteria for use in experiments.
Parameters
- request: CreateSegmentRequestContent
- OptionalrequestOptions: SegmentsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateSegmentResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.UnprocessableEntityError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.experimentation.segments.create({
        name: "name",
        rules: [{}]
    })
```

get

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

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

delete

delete(
id: string,
requestOptions?: SegmentsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a segment by ID. Idempotent: returns 204 even if segment does not exist.
Parameters
- id: string
  The ID of the segment to delete.
- OptionalrequestOptions: SegmentsClient.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.segments.delete("id")
```

update

update(
    id: string,
    request?: UpdateSegmentRequestContent,
    requestOptions?: SegmentsClient.RequestOptions,
): HttpResponsePromise<UpdateSegmentResponseContent>
Partially update a segment by ID. Only provided fields are updated. Sending rules replaces the entire rules array.
Parameters
- id: string
  The ID of the segment to update.
- request: UpdateSegmentRequestContent = {}
- OptionalrequestOptions: SegmentsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateSegmentResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.UnprocessableEntityError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class SegmentsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SegmentsClient

Methods

list

Parameters

Returns Promise<Page<Segment, ListSegmentsResponseContent>>

Throws

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateSegmentResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetSegmentResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateSegmentResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options