# Reference

## Classes

### Api

DefaultApi - interface

DefaultApiInterface

#### Extends

* [`DefaultApi`](#defaultapi)

#### Constructors

**new Api()**

```ts
new Api(config?: ConfigurationParameters): Api
```

**Parameters**

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `config`? | [`ConfigurationParameters`](#configurationparameters) |

**Returns**

[`Api`](#api)

**Overrides**

[`DefaultApi`](#defaultapi).[`constructor`](#constructors-4)

#### Properties

| Property        | Modifier    | Type                                | Default value   |
| --------------- | ----------- | ----------------------------------- | --------------- |
| `configuration` | `protected` | [`Configuration`](#configuration-2) | `DefaultConfig` |

#### Methods

**createFlag()**

```ts
createFlag(requestParameters: CreateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<CreateFlag200Response>
```

Create a new flag in the application. Returns the created flag details. Create a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`CreateFlagOperationRequest`](#createflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`CreateFlag200Response`](#createflag200response)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`createFlag`](#createflag-1)

**createFlagRaw()**

```ts
createFlagRaw(requestParameters: CreateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<CreateFlag200Response>>
```

Create a new flag in the application. Returns the created flag details. Create a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`CreateFlagOperationRequest`](#createflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`CreateFlag200Response`](#createflag200response)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`createFlagRaw`](#createflagraw-1)

**getApp()**

```ts
getApp(requestParameters: GetAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<App>
```

Retrieve a specific application by its identifier Get details of an application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetAppRequest`](#getapprequest)                                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`App`](#app)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getApp`](#getapp-1)

**getAppRaw()**

```ts
getAppRaw(requestParameters: GetAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<App>>
```

Retrieve a specific application by its identifier Get details of an application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetAppRequest`](#getapprequest)                                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`App`](#app)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getAppRaw`](#getappraw-1)

**getCompanyFlags()**

```ts
getCompanyFlags(requestParameters: GetCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Retrieve all flags with their targeting status for a specific company Get flags for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetCompanyFlagsRequest`](#getcompanyflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getCompanyFlags`](#getcompanyflags-1)

**getCompanyFlagsRaw()**

```ts
getCompanyFlagsRaw(requestParameters: GetCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Retrieve all flags with their targeting status for a specific company Get flags for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetCompanyFlagsRequest`](#getcompanyflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getCompanyFlagsRaw`](#getcompanyflagsraw-1)

**getEnvironment()**

```ts
getEnvironment(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Environment>
```

Retrieve details for a specific environment Get environment details

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetEnvironmentRequest`](#getenvironmentrequest)                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Environment`](#environment)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getEnvironment`](#getenvironment-1)

**getEnvironmentRaw()**

```ts
getEnvironmentRaw(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Environment>>
```

Retrieve details for a specific environment Get environment details

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetEnvironmentRequest`](#getenvironmentrequest)                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`Environment`](#environment)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getEnvironmentRaw`](#getenvironmentraw-1)

**getFlagTargeting()**

```ts
getFlagTargeting(requestParameters: GetFlagTargetingRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<FlagTargeting>
```

Retrieve targeting for a flag in an environment Get flag targeting for an environment

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetFlagTargetingRequest`](#getflagtargetingrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`FlagTargeting`](#flagtargeting)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getFlagTargeting`](#getflagtargeting-1)

**getFlagTargetingRaw()**

```ts
getFlagTargetingRaw(requestParameters: GetFlagTargetingRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<FlagTargeting>>
```

Retrieve targeting for a flag in an environment Get flag targeting for an environment

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetFlagTargetingRequest`](#getflagtargetingrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`FlagTargeting`](#flagtargeting)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getFlagTargetingRaw`](#getflagtargetingraw-1)

**getUserFlags()**

```ts
getUserFlags(requestParameters: GetUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Retrieve all flags with their targeting status for a specific user Get flags for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetUserFlagsRequest`](#getuserflagsrequest)                    |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getUserFlags`](#getuserflags-1)

**getUserFlagsRaw()**

```ts
getUserFlagsRaw(requestParameters: GetUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Retrieve all flags with their targeting status for a specific user Get flags for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetUserFlagsRequest`](#getuserflagsrequest)                    |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`getUserFlagsRaw`](#getuserflagsraw-1)

**isJsonMime()**

```ts
protected isJsonMime(mime: undefined | null | string): boolean
```

Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

**Parameters**

| Parameter | Type                              | Description                                  |
| --------- | --------------------------------- | -------------------------------------------- |
| `mime`    | `undefined` \| `null` \| `string` | MIME (Multipurpose Internet Mail Extensions) |

**Returns**

`boolean`

True if the given MIME is JSON, false otherwise.

**Inherited from**

[`DefaultApi`](#defaultapi).[`isJsonMime`](#isjsonmime-2)

**listApps()**

```ts
listApps(requestParameters: ListAppsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AppHeaderCollection>
```

Retrieve all accessible applications List of applications

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListAppsRequest`](#listappsrequest)                            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`AppHeaderCollection`](#appheadercollection)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`listApps`](#listapps-1)

**listAppsRaw()**

```ts
listAppsRaw(requestParameters: ListAppsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AppHeaderCollection>>
```

Retrieve all accessible applications List of applications

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListAppsRequest`](#listappsrequest)                            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`AppHeaderCollection`](#appheadercollection)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`listAppsRaw`](#listappsraw-1)

**listEnvironments()**

```ts
listEnvironments(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EnvironmentHeaderCollection>
```

Retrieve all environments for a specific application List environments for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListEnvironmentsRequest`](#listenvironmentsrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EnvironmentHeaderCollection`](#environmentheadercollection)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`listEnvironments`](#listenvironments-1)

**listEnvironmentsRaw()**

```ts
listEnvironmentsRaw(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EnvironmentHeaderCollection>>
```

Retrieve all environments for a specific application List environments for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListEnvironmentsRequest`](#listenvironmentsrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EnvironmentHeaderCollection`](#environmentheadercollection)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`listEnvironmentsRaw`](#listenvironmentsraw-1)

**listFlags()**

```ts
listFlags(requestParameters: ListFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<FlagHeaderCollection>
```

Retrieve all flags for a specific application List flags for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListFlagsRequest`](#listflagsrequest)                          |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`FlagHeaderCollection`](#flagheadercollection)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`listFlags`](#listflags-1)

**listFlagsRaw()**

```ts
listFlagsRaw(requestParameters: ListFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<FlagHeaderCollection>>
```

Retrieve all flags for a specific application List flags for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListFlagsRequest`](#listflagsrequest)                          |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`FlagHeaderCollection`](#flagheadercollection)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`listFlagsRaw`](#listflagsraw-1)

**request()**

```ts
protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
```

**Parameters**

| Parameter        | Type                                                             |
| ---------------- | ---------------------------------------------------------------- |
| `context`        | [`RequestOpts`](#requestopts)                                    |
| `initOverrides`? | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)>

**Overrides**

[`DefaultApi`](#defaultapi).[`request`](#request-2)

**updateCompanyFlags()**

```ts
updateCompanyFlags(requestParameters: UpdateCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Update specific targeting for flags for a company in an environment Update flag targeting for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)        |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`updateCompanyFlags`](#updatecompanyflags-1)

**updateCompanyFlagsRaw()**

```ts
updateCompanyFlagsRaw(requestParameters: UpdateCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Update specific targeting for flags for a company in an environment Update flag targeting for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)        |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`updateCompanyFlagsRaw`](#updatecompanyflagsraw-1)

**updateFlag()**

```ts
updateFlag(requestParameters: UpdateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<CreateFlag200Response>
```

Update an existing flag Update a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateFlagOperationRequest`](#updateflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`CreateFlag200Response`](#createflag200response)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`updateFlag`](#updateflag-1)

**updateFlagRaw()**

```ts
updateFlagRaw(requestParameters: UpdateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<CreateFlag200Response>>
```

Update an existing flag Update a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateFlagOperationRequest`](#updateflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`CreateFlag200Response`](#createflag200response)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`updateFlagRaw`](#updateflagraw-1)

**updateUserFlags()**

```ts
updateUserFlags(requestParameters: UpdateUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Update specific targeting for flags for a user in an environment Update flag targeting for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateUserFlagsRequest`](#updateuserflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Inherited from**

[`DefaultApi`](#defaultapi).[`updateUserFlags`](#updateuserflags-1)

**updateUserFlagsRaw()**

```ts
updateUserFlagsRaw(requestParameters: UpdateUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Update specific targeting for flags for a user in an environment Update flag targeting for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateUserFlagsRequest`](#updateuserflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Inherited from**

[`DefaultApi`](#defaultapi).[`updateUserFlagsRaw`](#updateuserflagsraw-1)

**withMiddleware()**

```ts
withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter        | Type                             |
| ---------------- | -------------------------------- |
| `this`           | `T`                              |
| ...`middlewares` | [`Middleware`](#middleware-2)\[] |

**Returns**

`T`

**Inherited from**

[`DefaultApi`](#defaultapi).[`withMiddleware`](#withmiddleware-2)

**withPostMiddleware()**

```ts
withPostMiddleware<T>(this: T, ...postMiddlewares: (
  | undefined
  | (context: ResponseContext) => Promise<
  | void
  | Response>)[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter            | Type                                                                                                                                                                                                                                                           |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `this`               | `T`                                                                                                                                                                                                                                                            |
| ...`postMiddlewares` | ( \| `undefined` \| (`context`: [`ResponseContext`](#responsecontext)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)< \| `void` \| [`Response`](https://developer.mozilla.org/docs/Web/API/Response)>)\[] |

**Returns**

`T`

**Inherited from**

[`DefaultApi`](#defaultapi).[`withPostMiddleware`](#withpostmiddleware-2)

**withPreMiddleware()**

```ts
withPreMiddleware<T>(this: T, ...preMiddlewares: (
  | undefined
  | (context: RequestContext) => Promise<void | FetchParams>)[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter           | Type                                                                                                                                                                                                                 |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `this`              | `T`                                                                                                                                                                                                                  |
| ...`preMiddlewares` | ( \| `undefined` \| (`context`: [`RequestContext`](#requestcontext)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void` \| [`FetchParams`](#fetchparams)>)\[] |

**Returns**

`T`

**Inherited from**

[`DefaultApi`](#defaultapi).[`withPreMiddleware`](#withpremiddleware-2)

***

### BaseAPI

This is the base class for all generated API classes.

#### Extended by

* [`DefaultApi`](#defaultapi)

#### Constructors

**new BaseAPI()**

```ts
new BaseAPI(configuration: Configuration): BaseAPI
```

**Parameters**

| Parameter       | Type                                | Default value   |
| --------------- | ----------------------------------- | --------------- |
| `configuration` | [`Configuration`](#configuration-2) | `DefaultConfig` |

**Returns**

[`BaseAPI`](#baseapi)

#### Properties

| Property        | Modifier    | Type                                | Default value   |
| --------------- | ----------- | ----------------------------------- | --------------- |
| `configuration` | `protected` | [`Configuration`](#configuration-2) | `DefaultConfig` |

#### Methods

**isJsonMime()**

```ts
protected isJsonMime(mime: undefined | null | string): boolean
```

Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

**Parameters**

| Parameter | Type                              | Description                                  |
| --------- | --------------------------------- | -------------------------------------------- |
| `mime`    | `undefined` \| `null` \| `string` | MIME (Multipurpose Internet Mail Extensions) |

**Returns**

`boolean`

True if the given MIME is JSON, false otherwise.

**request()**

```ts
protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
```

**Parameters**

| Parameter        | Type                                                             |
| ---------------- | ---------------------------------------------------------------- |
| `context`        | [`RequestOpts`](#requestopts)                                    |
| `initOverrides`? | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)>

**withMiddleware()**

```ts
withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter        | Type                             |
| ---------------- | -------------------------------- |
| `this`           | `T`                              |
| ...`middlewares` | [`Middleware`](#middleware-2)\[] |

**Returns**

`T`

**withPostMiddleware()**

```ts
withPostMiddleware<T>(this: T, ...postMiddlewares: (
  | undefined
  | (context: ResponseContext) => Promise<
  | void
  | Response>)[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter            | Type                                                                                                                                                                                                                                                           |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `this`               | `T`                                                                                                                                                                                                                                                            |
| ...`postMiddlewares` | ( \| `undefined` \| (`context`: [`ResponseContext`](#responsecontext)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)< \| `void` \| [`Response`](https://developer.mozilla.org/docs/Web/API/Response)>)\[] |

**Returns**

`T`

**withPreMiddleware()**

```ts
withPreMiddleware<T>(this: T, ...preMiddlewares: (
  | undefined
  | (context: RequestContext) => Promise<void | FetchParams>)[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter           | Type                                                                                                                                                                                                                 |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `this`              | `T`                                                                                                                                                                                                                  |
| ...`preMiddlewares` | ( \| `undefined` \| (`context`: [`RequestContext`](#requestcontext)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void` \| [`FetchParams`](#fetchparams)>)\[] |

**Returns**

`T`

***

### BlobApiResponse

#### Constructors

**new BlobApiResponse()**

```ts
new BlobApiResponse(raw: Response): BlobApiResponse
```

**Parameters**

| Parameter | Type                                                              |
| --------- | ----------------------------------------------------------------- |
| `raw`     | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

**Returns**

[`BlobApiResponse`](#blobapiresponse)

#### Properties

| Property | Modifier | Type                                                              |
| -------- | -------- | ----------------------------------------------------------------- |
| `raw`    | `public` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

#### Methods

**value()**

```ts
value(): Promise<Blob>
```

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Blob`](https://developer.mozilla.org/docs/Web/API/Blob)>

***

### Configuration

#### Constructors

**new Configuration()**

```ts
new Configuration(configuration: ConfigurationParameters): Configuration
```

**Parameters**

| Parameter       | Type                                                  |
| --------------- | ----------------------------------------------------- |
| `configuration` | [`ConfigurationParameters`](#configurationparameters) |

**Returns**

[`Configuration`](#configuration-2)

#### Accessors

**accessToken**

**Get Signature**

```ts
get accessToken(): 
  | undefined
  | (name?: string, scopes?: string[]) => 
  | string
| Promise<string>
```

**Returns**

\| `undefined` | (`name`?: `string`, `scopes`?: `string`\[]) => | `string` | [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`>

**apiKey**

**Get Signature**

```ts
get apiKey(): 
  | undefined
  | (name: string) => 
  | string
| Promise<string>
```

**Returns**

\| `undefined` | (`name`: `string`) => | `string` | [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`>

**basePath**

**Get Signature**

```ts
get basePath(): string
```

**Returns**

`string`

**config**

**Set Signature**

```ts
set config(configuration: Configuration): void
```

**Parameters**

| Parameter       | Type                                |
| --------------- | ----------------------------------- |
| `configuration` | [`Configuration`](#configuration-2) |

**Returns**

`void`

**credentials**

**Get Signature**

```ts
get credentials(): undefined | RequestCredentials
```

**Returns**

`undefined` | `RequestCredentials`

**fetchApi**

**Get Signature**

```ts
get fetchApi(): 
  | undefined
| (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
```

**Returns**

\| `undefined` | (`input`: `RequestInfo` | [`URL`](https://developer.mozilla.org/docs/Web/API/URL), `init`?: `RequestInit`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)>

**headers**

**Get Signature**

```ts
get headers(): undefined | HTTPHeaders
```

**Returns**

`undefined` | [`HTTPHeaders`](#httpheaders)

**middleware**

**Get Signature**

```ts
get middleware(): Middleware[]
```

**Returns**

[`Middleware`](#middleware-2)\[]

**password**

**Get Signature**

```ts
get password(): undefined | string
```

**Returns**

`undefined` | `string`

**queryParamsStringify**

**Get Signature**

```ts
get queryParamsStringify(): (params: HTTPQuery) => string
```

**Returns**

`Function`

**Parameters**

| Parameter | Type                      |
| --------- | ------------------------- |
| `params`  | [`HTTPQuery`](#httpquery) |

**Returns**

`string`

**username**

**Get Signature**

```ts
get username(): undefined | string
```

**Returns**

`undefined` | `string`

***

### DefaultApi

DefaultApi - interface

DefaultApiInterface

#### Extends

* [`BaseAPI`](#baseapi)

#### Extended by

* [`Api`](#api)

#### Implements

* [`DefaultApiInterface`](#defaultapiinterface)

#### Constructors

**new DefaultApi()**

```ts
new DefaultApi(configuration: Configuration): DefaultApi
```

**Parameters**

| Parameter       | Type                                | Default value   |
| --------------- | ----------------------------------- | --------------- |
| `configuration` | [`Configuration`](#configuration-2) | `DefaultConfig` |

**Returns**

[`DefaultApi`](#defaultapi)

**Inherited from**

[`BaseAPI`](#baseapi).[`constructor`](#constructors-1)

#### Properties

| Property        | Modifier    | Type                                | Default value   |
| --------------- | ----------- | ----------------------------------- | --------------- |
| `configuration` | `protected` | [`Configuration`](#configuration-2) | `DefaultConfig` |

#### Methods

**createFlag()**

```ts
createFlag(requestParameters: CreateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<CreateFlag200Response>
```

Create a new flag in the application. Returns the created flag details. Create a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`CreateFlagOperationRequest`](#createflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`CreateFlag200Response`](#createflag200response)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`createFlag`](#createflag-2)

**createFlagRaw()**

```ts
createFlagRaw(requestParameters: CreateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<CreateFlag200Response>>
```

Create a new flag in the application. Returns the created flag details. Create a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`CreateFlagOperationRequest`](#createflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`CreateFlag200Response`](#createflag200response)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`createFlagRaw`](#createflagraw-2)

**getApp()**

```ts
getApp(requestParameters: GetAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<App>
```

Retrieve a specific application by its identifier Get details of an application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetAppRequest`](#getapprequest)                                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`App`](#app)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getApp`](#getapp-2)

**getAppRaw()**

```ts
getAppRaw(requestParameters: GetAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<App>>
```

Retrieve a specific application by its identifier Get details of an application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetAppRequest`](#getapprequest)                                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`App`](#app)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getAppRaw`](#getappraw-2)

**getCompanyFlags()**

```ts
getCompanyFlags(requestParameters: GetCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Retrieve all flags with their targeting status for a specific company Get flags for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetCompanyFlagsRequest`](#getcompanyflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getCompanyFlags`](#getcompanyflags-2)

**getCompanyFlagsRaw()**

```ts
getCompanyFlagsRaw(requestParameters: GetCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Retrieve all flags with their targeting status for a specific company Get flags for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetCompanyFlagsRequest`](#getcompanyflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getCompanyFlagsRaw`](#getcompanyflagsraw-2)

**getEnvironment()**

```ts
getEnvironment(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Environment>
```

Retrieve details for a specific environment Get environment details

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetEnvironmentRequest`](#getenvironmentrequest)                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Environment`](#environment)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getEnvironment`](#getenvironment-2)

**getEnvironmentRaw()**

```ts
getEnvironmentRaw(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Environment>>
```

Retrieve details for a specific environment Get environment details

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetEnvironmentRequest`](#getenvironmentrequest)                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`Environment`](#environment)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getEnvironmentRaw`](#getenvironmentraw-2)

**getFlagTargeting()**

```ts
getFlagTargeting(requestParameters: GetFlagTargetingRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<FlagTargeting>
```

Retrieve targeting for a flag in an environment Get flag targeting for an environment

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetFlagTargetingRequest`](#getflagtargetingrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`FlagTargeting`](#flagtargeting)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getFlagTargeting`](#getflagtargeting-2)

**getFlagTargetingRaw()**

```ts
getFlagTargetingRaw(requestParameters: GetFlagTargetingRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<FlagTargeting>>
```

Retrieve targeting for a flag in an environment Get flag targeting for an environment

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetFlagTargetingRequest`](#getflagtargetingrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`FlagTargeting`](#flagtargeting)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getFlagTargetingRaw`](#getflagtargetingraw-2)

**getUserFlags()**

```ts
getUserFlags(requestParameters: GetUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Retrieve all flags with their targeting status for a specific user Get flags for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetUserFlagsRequest`](#getuserflagsrequest)                    |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getUserFlags`](#getuserflags-2)

**getUserFlagsRaw()**

```ts
getUserFlagsRaw(requestParameters: GetUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Retrieve all flags with their targeting status for a specific user Get flags for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetUserFlagsRequest`](#getuserflagsrequest)                    |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`getUserFlagsRaw`](#getuserflagsraw-2)

**isJsonMime()**

```ts
protected isJsonMime(mime: undefined | null | string): boolean
```

Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

**Parameters**

| Parameter | Type                              | Description                                  |
| --------- | --------------------------------- | -------------------------------------------- |
| `mime`    | `undefined` \| `null` \| `string` | MIME (Multipurpose Internet Mail Extensions) |

**Returns**

`boolean`

True if the given MIME is JSON, false otherwise.

**Inherited from**

[`BaseAPI`](#baseapi).[`isJsonMime`](#isjsonmime-1)

**listApps()**

```ts
listApps(requestParameters: ListAppsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AppHeaderCollection>
```

Retrieve all accessible applications List of applications

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListAppsRequest`](#listappsrequest)                            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`AppHeaderCollection`](#appheadercollection)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`listApps`](#listapps-2)

**listAppsRaw()**

```ts
listAppsRaw(requestParameters: ListAppsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AppHeaderCollection>>
```

Retrieve all accessible applications List of applications

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListAppsRequest`](#listappsrequest)                            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`AppHeaderCollection`](#appheadercollection)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`listAppsRaw`](#listappsraw-2)

**listEnvironments()**

```ts
listEnvironments(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EnvironmentHeaderCollection>
```

Retrieve all environments for a specific application List environments for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListEnvironmentsRequest`](#listenvironmentsrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EnvironmentHeaderCollection`](#environmentheadercollection)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`listEnvironments`](#listenvironments-2)

**listEnvironmentsRaw()**

```ts
listEnvironmentsRaw(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EnvironmentHeaderCollection>>
```

Retrieve all environments for a specific application List environments for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListEnvironmentsRequest`](#listenvironmentsrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EnvironmentHeaderCollection`](#environmentheadercollection)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`listEnvironmentsRaw`](#listenvironmentsraw-2)

**listFlags()**

```ts
listFlags(requestParameters: ListFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<FlagHeaderCollection>
```

Retrieve all flags for a specific application List flags for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListFlagsRequest`](#listflagsrequest)                          |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`FlagHeaderCollection`](#flagheadercollection)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`listFlags`](#listflags-2)

**listFlagsRaw()**

```ts
listFlagsRaw(requestParameters: ListFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<FlagHeaderCollection>>
```

Retrieve all flags for a specific application List flags for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListFlagsRequest`](#listflagsrequest)                          |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`FlagHeaderCollection`](#flagheadercollection)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`listFlagsRaw`](#listflagsraw-2)

**request()**

```ts
protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
```

**Parameters**

| Parameter        | Type                                                             |
| ---------------- | ---------------------------------------------------------------- |
| `context`        | [`RequestOpts`](#requestopts)                                    |
| `initOverrides`? | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)>

**Inherited from**

[`BaseAPI`](#baseapi).[`request`](#request-1)

**updateCompanyFlags()**

```ts
updateCompanyFlags(requestParameters: UpdateCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Update specific targeting for flags for a company in an environment Update flag targeting for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)        |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`updateCompanyFlags`](#updatecompanyflags-2)

**updateCompanyFlagsRaw()**

```ts
updateCompanyFlagsRaw(requestParameters: UpdateCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Update specific targeting for flags for a company in an environment Update flag targeting for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)        |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`updateCompanyFlagsRaw`](#updatecompanyflagsraw-2)

**updateFlag()**

```ts
updateFlag(requestParameters: UpdateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<CreateFlag200Response>
```

Update an existing flag Update a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateFlagOperationRequest`](#updateflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`CreateFlag200Response`](#createflag200response)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`updateFlag`](#updateflag-2)

**updateFlagRaw()**

```ts
updateFlagRaw(requestParameters: UpdateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<CreateFlag200Response>>
```

Update an existing flag Update a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateFlagOperationRequest`](#updateflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`CreateFlag200Response`](#createflag200response)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`updateFlagRaw`](#updateflagraw-2)

**updateUserFlags()**

```ts
updateUserFlags(requestParameters: UpdateUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Update specific targeting for flags for a user in an environment Update flag targeting for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateUserFlagsRequest`](#updateuserflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`updateUserFlags`](#updateuserflags-2)

**updateUserFlagsRaw()**

```ts
updateUserFlagsRaw(requestParameters: UpdateUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Update specific targeting for flags for a user in an environment Update flag targeting for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateUserFlagsRequest`](#updateuserflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Implementation of**

[`DefaultApiInterface`](#defaultapiinterface).[`updateUserFlagsRaw`](#updateuserflagsraw-2)

**withMiddleware()**

```ts
withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter        | Type                             |
| ---------------- | -------------------------------- |
| `this`           | `T`                              |
| ...`middlewares` | [`Middleware`](#middleware-2)\[] |

**Returns**

`T`

**Inherited from**

[`BaseAPI`](#baseapi).[`withMiddleware`](#withmiddleware-1)

**withPostMiddleware()**

```ts
withPostMiddleware<T>(this: T, ...postMiddlewares: (
  | undefined
  | (context: ResponseContext) => Promise<
  | void
  | Response>)[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter            | Type                                                                                                                                                                                                                                                           |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `this`               | `T`                                                                                                                                                                                                                                                            |
| ...`postMiddlewares` | ( \| `undefined` \| (`context`: [`ResponseContext`](#responsecontext)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)< \| `void` \| [`Response`](https://developer.mozilla.org/docs/Web/API/Response)>)\[] |

**Returns**

`T`

**Inherited from**

[`BaseAPI`](#baseapi).[`withPostMiddleware`](#withpostmiddleware-1)

**withPreMiddleware()**

```ts
withPreMiddleware<T>(this: T, ...preMiddlewares: (
  | undefined
  | (context: RequestContext) => Promise<void | FetchParams>)[]): T
```

**Type Parameters**

| Type Parameter                      |
| ----------------------------------- |
| `T` *extends* [`BaseAPI`](#baseapi) |

**Parameters**

| Parameter           | Type                                                                                                                                                                                                                 |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `this`              | `T`                                                                                                                                                                                                                  |
| ...`preMiddlewares` | ( \| `undefined` \| (`context`: [`RequestContext`](#requestcontext)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void` \| [`FetchParams`](#fetchparams)>)\[] |

**Returns**

`T`

**Inherited from**

[`BaseAPI`](#baseapi).[`withPreMiddleware`](#withpremiddleware-1)

***

### FetchError

#### Extends

* [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)

#### Constructors

**new FetchError()**

```ts
new FetchError(cause: Error, msg?: string): FetchError
```

**Parameters**

| Parameter | Type                                                                                        |
| --------- | ------------------------------------------------------------------------------------------- |
| `cause`   | [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) |
| `msg`?    | `string`                                                                                    |

**Returns**

[`FetchError`](#fetcherror)

**Overrides**

```ts
Error.constructor
```

#### Properties

<table><thead><tr><th>Property</th><th>Modifier</th><th>Type</th><th>Default value</th><th>Description</th><th>Overrides</th></tr></thead><tbody><tr><td><code>cause</code></td><td><code>public</code></td><td><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"><code>Error</code></a></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>message</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>name</code></td><td><code>public</code></td><td><code>"FetchError"</code></td><td><code>"FetchError"</code></td><td>‐</td><td><pre class="language-ts"><code class="lang-ts">Error.name
</code></pre></td></tr><tr><td><code>stack?</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>prepareStackTrace?</code></td><td><code>static</code></td><td>(<code>err</code>: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"><code>Error</code></a>, <code>stackTraces</code>: <code>CallSite</code>[]) => <code>any</code></td><td><code>undefined</code></td><td><p>Optional override for formatting stack traces</p><p><strong>See</strong></p><p>https://v8.dev/docs/stack-trace-api#customizing-stack-traces</p></td><td>‐</td></tr><tr><td><code>stackTraceLimit</code></td><td><code>static</code></td><td><code>number</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr></tbody></table>

#### Methods

**captureStackTrace()**

```ts
static captureStackTrace(targetObject: object, constructorOpt?: Function): void
```

Create .stack property on a target object

**Parameters**

| Parameter         | Type                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------- |
| `targetObject`    | `object`                                                                                          |
| `constructorOpt`? | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

**Returns**

`void`

**Inherited from**

```ts
Error.captureStackTrace
```

***

### JSONApiResponse\<T>

#### Type Parameters

| Type Parameter |
| -------------- |
| `T`            |

#### Constructors

**new JSONApiResponse()**

```ts
new JSONApiResponse<T>(raw: Response, transformer: ResponseTransformer<T>): JSONApiResponse<T>
```

**Parameters**

| Parameter     | Type                                                              |
| ------------- | ----------------------------------------------------------------- |
| `raw`         | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |
| `transformer` | [`ResponseTransformer`](#responsetransformert)<`T`>               |

**Returns**

[`JSONApiResponse`](#jsonapiresponset)<`T`>

#### Properties

| Property | Modifier | Type                                                              |
| -------- | -------- | ----------------------------------------------------------------- |
| `raw`    | `public` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

#### Methods

**value()**

```ts
value(): Promise<T>
```

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`T`>

***

### ReflagApiError

#### Extends

* [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)

#### Constructors

**new ReflagApiError()**

```ts
new ReflagApiError(
   status: number, 
   message: string, 
   code?: string, 
   details?: unknown): ReflagApiError
```

**Parameters**

| Parameter  | Type      |
| ---------- | --------- |
| `status`   | `number`  |
| `message`  | `string`  |
| `code`?    | `string`  |
| `details`? | `unknown` |

**Returns**

[`ReflagApiError`](#reflagapierror)

**Overrides**

```ts
Error.constructor
```

#### Properties

| Property             | Modifier | Type                                                                                                                                        | Description                                                                                                                                          |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code?`              | `public` | `string`                                                                                                                                    | ‐                                                                                                                                                    |
| `details?`           | `public` | `unknown`                                                                                                                                   | ‐                                                                                                                                                    |
| `message`            | `public` | `string`                                                                                                                                    | ‐                                                                                                                                                    |
| `name`               | `public` | `string`                                                                                                                                    | ‐                                                                                                                                                    |
| `stack?`             | `public` | `string`                                                                                                                                    | ‐                                                                                                                                                    |
| `status`             | `public` | `number`                                                                                                                                    | ‐                                                                                                                                                    |
| `prepareStackTrace?` | `static` | (`err`: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error), `stackTraces`: `CallSite`\[]) => `any` | <p>Optional override for formatting stack traces</p><p><strong>See</strong></p><p><https://v8.dev/docs/stack-trace-api#customizing-stack-traces></p> |
| `stackTraceLimit`    | `static` | `number`                                                                                                                                    | ‐                                                                                                                                                    |

#### Methods

**captureStackTrace()**

```ts
static captureStackTrace(targetObject: object, constructorOpt?: Function): void
```

Create .stack property on a target object

**Parameters**

| Parameter         | Type                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------- |
| `targetObject`    | `object`                                                                                          |
| `constructorOpt`? | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

**Returns**

`void`

**Inherited from**

```ts
Error.captureStackTrace
```

***

### RequiredError

#### Extends

* [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)

#### Constructors

**new RequiredError()**

```ts
new RequiredError(field: string, msg?: string): RequiredError
```

**Parameters**

| Parameter | Type     |
| --------- | -------- |
| `field`   | `string` |
| `msg`?    | `string` |

**Returns**

[`RequiredError`](#requirederror)

**Overrides**

```ts
Error.constructor
```

#### Properties

<table><thead><tr><th>Property</th><th>Modifier</th><th>Type</th><th>Default value</th><th>Description</th><th>Overrides</th></tr></thead><tbody><tr><td><code>field</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>message</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>name</code></td><td><code>public</code></td><td><code>"RequiredError"</code></td><td><code>"RequiredError"</code></td><td>‐</td><td><pre class="language-ts"><code class="lang-ts">Error.name
</code></pre></td></tr><tr><td><code>stack?</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>prepareStackTrace?</code></td><td><code>static</code></td><td>(<code>err</code>: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"><code>Error</code></a>, <code>stackTraces</code>: <code>CallSite</code>[]) => <code>any</code></td><td><code>undefined</code></td><td><p>Optional override for formatting stack traces</p><p><strong>See</strong></p><p>https://v8.dev/docs/stack-trace-api#customizing-stack-traces</p></td><td>‐</td></tr><tr><td><code>stackTraceLimit</code></td><td><code>static</code></td><td><code>number</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr></tbody></table>

#### Methods

**captureStackTrace()**

```ts
static captureStackTrace(targetObject: object, constructorOpt?: Function): void
```

Create .stack property on a target object

**Parameters**

| Parameter         | Type                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------- |
| `targetObject`    | `object`                                                                                          |
| `constructorOpt`? | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

**Returns**

`void`

**Inherited from**

```ts
Error.captureStackTrace
```

***

### ResponseError

#### Extends

* [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)

#### Constructors

**new ResponseError()**

```ts
new ResponseError(response: Response, msg?: string): ResponseError
```

**Parameters**

| Parameter  | Type                                                              |
| ---------- | ----------------------------------------------------------------- |
| `response` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |
| `msg`?     | `string`                                                          |

**Returns**

[`ResponseError`](#responseerror)

**Overrides**

```ts
Error.constructor
```

#### Properties

<table><thead><tr><th>Property</th><th>Modifier</th><th>Type</th><th>Default value</th><th>Description</th><th>Overrides</th></tr></thead><tbody><tr><td><code>message</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>name</code></td><td><code>public</code></td><td><code>"ResponseError"</code></td><td><code>"ResponseError"</code></td><td>‐</td><td><pre class="language-ts"><code class="lang-ts">Error.name
</code></pre></td></tr><tr><td><code>response</code></td><td><code>public</code></td><td><a href="https://developer.mozilla.org/docs/Web/API/Response"><code>Response</code></a></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>stack?</code></td><td><code>public</code></td><td><code>string</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr><tr><td><code>prepareStackTrace?</code></td><td><code>static</code></td><td>(<code>err</code>: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"><code>Error</code></a>, <code>stackTraces</code>: <code>CallSite</code>[]) => <code>any</code></td><td><code>undefined</code></td><td><p>Optional override for formatting stack traces</p><p><strong>See</strong></p><p>https://v8.dev/docs/stack-trace-api#customizing-stack-traces</p></td><td>‐</td></tr><tr><td><code>stackTraceLimit</code></td><td><code>static</code></td><td><code>number</code></td><td><code>undefined</code></td><td>‐</td><td>‐</td></tr></tbody></table>

#### Methods

**captureStackTrace()**

```ts
static captureStackTrace(targetObject: object, constructorOpt?: Function): void
```

Create .stack property on a target object

**Parameters**

| Parameter         | Type                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------- |
| `targetObject`    | `object`                                                                                          |
| `constructorOpt`? | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

**Returns**

`void`

**Inherited from**

```ts
Error.captureStackTrace
```

***

### TextApiResponse

#### Constructors

**new TextApiResponse()**

```ts
new TextApiResponse(raw: Response): TextApiResponse
```

**Parameters**

| Parameter | Type                                                              |
| --------- | ----------------------------------------------------------------- |
| `raw`     | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

**Returns**

[`TextApiResponse`](#textapiresponse)

#### Properties

| Property | Modifier | Type                                                              |
| -------- | -------- | ----------------------------------------------------------------- |
| `raw`    | `public` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

#### Methods

**value()**

```ts
value(): Promise<string>
```

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`>

***

### VoidApiResponse

#### Constructors

**new VoidApiResponse()**

```ts
new VoidApiResponse(raw: Response): VoidApiResponse
```

**Parameters**

| Parameter | Type                                                              |
| --------- | ----------------------------------------------------------------- |
| `raw`     | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

**Returns**

[`VoidApiResponse`](#voidapiresponse)

#### Properties

| Property | Modifier | Type                                                              |
| -------- | -------- | ----------------------------------------------------------------- |
| `raw`    | `public` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

#### Methods

**value()**

```ts
value(): Promise<void>
```

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`>

## Interfaces

### ApiResponse\<T>

#### Type Parameters

| Type Parameter |
| -------------- |
| `T`            |

#### Properties

| Property | Type                                                              |
| -------- | ----------------------------------------------------------------- |
| `raw`    | [`Response`](https://developer.mozilla.org/docs/Web/API/Response) |

#### Methods

**value()**

```ts
value(): Promise<T>
```

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`T`>

***

### App

App information with related collections App

#### Properties

| Property        | Type                                 | Description                   |
| --------------- | ------------------------------------ | ----------------------------- |
| `demo`          | `boolean`                            | Whether the app is a demo app |
| `environments`  | [`Environment`](#environment)\[]     | Environments within the app   |
| `flagKeyFormat` | [`FlagKeyFormat`](#flagkeyformat-2)  | ‐                             |
| `id`            | `string`                             | App identifier                |
| `name`          | `string`                             | App name                      |
| `org`           | [`OrgHeader`](#orgheader)            | ‐                             |
| `segments`      | [`SegmentHeader`](#segmentheader)\[] | Segments within the app       |
| `stages`        | [`StageHeader`](#stageheader)\[]     | Stages within the app         |

***

### AppHeader

Basic app information AppHeader

#### Properties

| Property        | Type                                         | Description                   |
| --------------- | -------------------------------------------- | ----------------------------- |
| `demo`          | `boolean`                                    | Whether the app is a demo app |
| `environments`  | [`EnvironmentHeader`](#environmentheader)\[] | Environments within the app   |
| `flagKeyFormat` | [`FlagKeyFormat`](#flagkeyformat-2)          | ‐                             |
| `id`            | `string`                                     | App identifier                |
| `name`          | `string`                                     | App name                      |
| `org`           | [`OrgHeader`](#orgheader)                    | ‐                             |

***

### AppHeaderCollection

Collection of Basic app information AppHeaderCollection

#### Properties

| Property | Type                         | Description                            |
| -------- | ---------------------------- | -------------------------------------- |
| `data`   | [`AppHeader`](#appheader)\[] | The individual items in the collection |

***

### ConfigurationParameters

#### Properties

| Property                | Type                                                                                                                                                                                                                                                                                                |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accessToken?`          | \| `string` \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`> \| (`name`?: `string`, `scopes`?: `string`\[]) => \| `string` \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`> |
| `apiKey?`               | \| `string` \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`> \| (`name`: `string`) => \| `string` \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`string`>                          |
| `basePath?`             | `string`                                                                                                                                                                                                                                                                                            |
| `credentials?`          | `RequestCredentials`                                                                                                                                                                                                                                                                                |
| `fetchApi?`             | (`input`: `RequestInfo` \| [`URL`](https://developer.mozilla.org/docs/Web/API/URL), `init`?: `RequestInit`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)>                   |
| `headers?`              | [`HTTPHeaders`](#httpheaders)                                                                                                                                                                                                                                                                       |
| `middleware?`           | [`Middleware`](#middleware-2)\[]                                                                                                                                                                                                                                                                    |
| `password?`             | `string`                                                                                                                                                                                                                                                                                            |
| `queryParamsStringify?` | (`params`: [`HTTPQuery`](#httpquery)) => `string`                                                                                                                                                                                                                                                   |
| `username?`             | `string`                                                                                                                                                                                                                                                                                            |

***

### Consume

#### Properties

| Property      | Type     |
| ------------- | -------- |
| `contentType` | `string` |

***

### CreateFlag200Response

CreateFlag200Response

#### Properties

| Property | Type                                                      |
| -------- | --------------------------------------------------------- |
| `flag`   | [`CreateFlag200ResponseFlag`](#createflag200responseflag) |

***

### CreateFlag200ResponseFlag

CreateFlag200ResponseFlag

#### Properties

| Property                       | Type                                    | Description                                                |
| ------------------------------ | --------------------------------------- | ---------------------------------------------------------- |
| `archived`                     | `boolean`                               | Whether the flag is archived                               |
| `codeRefsCleanedUp`            | `boolean`                               | Whether code references for this flag have been cleaned up |
| `codeRefsMarkedCleanAt?`       | `string`                                | Timestamp when code references were marked as cleaned up   |
| `codeRefsMarkedCleanUserName?` | `string`                                | Name of the user who marked code references as cleaned up  |
| `createdAt?`                   | `string`                                | Timestamp when the flag was created                        |
| `description?`                 | `string`                                | Flag description                                           |
| `id`                           | `string`                                | Flag ID                                                    |
| `key`                          | `string`                                | Unique flag key                                            |
| `lastCheckAt?`                 | `string`                                | Timestamp when the flag was last checked                   |
| `lastTrackAt?`                 | `string`                                | Timestamp when the flag was last tracked                   |
| `name`                         | `string`                                | Flag name                                                  |
| `noRecentChecks`               | `boolean`                               | Whether the flag has no recent access checks               |
| `owner?`                       | [`ReflagUserHeader`](#reflaguserheader) | ‐                                                          |
| `parentFlagId?`                | `string`                                | Parent flag ID                                             |
| `permanent`                    | `boolean`                               | Whether the flag is permanent                              |
| `rolledOutToEveryoneAt?`       | `string`                                | Timestamp when the flag was rolled out to everyone         |
| `stage?`                       | [`StageHeader`](#stageheader)           | ‐                                                          |
| `stale`                        | `boolean`                               | Whether the flag is stale                                  |

***

### CreateFlagOperationRequest

CreateFlagRequest

#### Extends

* [`CreateFlagRequest`](#createflagrequest)

#### Properties

| Property       | Type               | Description                |
| -------------- | ------------------ | -------------------------- |
| `appId`        | `string`           | ‐                          |
| `description?` | `null` \| `string` | ‐                          |
| `key`          | `string`           | Key of the flag            |
| `name`         | `string`           | Name of the flag           |
| `ownerUserId?` | `null` \| `string` | ‐                          |
| `permanent?`   | `boolean`          | ‐                          |
| `secret?`      | `boolean`          | Whether the flag is secret |
| `stageId?`     | `string`           | Stage ID of the flag       |

***

### CreateFlagRequest

CreateFlagRequest

#### Extended by

* [`CreateFlagOperationRequest`](#createflagoperationrequest)

#### Properties

| Property       | Type               | Description                |
| -------------- | ------------------ | -------------------------- |
| `description?` | `null` \| `string` | ‐                          |
| `key`          | `string`           | Key of the flag            |
| `name`         | `string`           | Name of the flag           |
| `ownerUserId?` | `null` \| `string` | ‐                          |
| `permanent?`   | `boolean`          | ‐                          |
| `secret?`      | `boolean`          | Whether the flag is secret |
| `stageId?`     | `string`           | Stage ID of the flag       |

***

### DefaultApiInterface

DefaultApi - interface

DefaultApiInterface

#### Methods

**createFlag()**

```ts
createFlag(requestParameters: CreateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<CreateFlag200Response>
```

Create a new flag in the application. Returns the created flag details. Create a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`CreateFlagOperationRequest`](#createflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`CreateFlag200Response`](#createflag200response)>

**createFlagRaw()**

```ts
createFlagRaw(requestParameters: CreateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<CreateFlag200Response>>
```

Create a new flag in the application. Returns the created flag details.

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`CreateFlagOperationRequest`](#createflagoperationrequest)      | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`CreateFlag200Response`](#createflag200response)>>

**Throws**

**getApp()**

```ts
getApp(requestParameters: GetAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<App>
```

Retrieve a specific application by its identifier Get details of an application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetAppRequest`](#getapprequest)                                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`App`](#app)>

**getAppRaw()**

```ts
getAppRaw(requestParameters: GetAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<App>>
```

Retrieve a specific application by its identifier

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`GetAppRequest`](#getapprequest)                                | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`App`](#app)>>

**Throws**

**getCompanyFlags()**

```ts
getCompanyFlags(requestParameters: GetCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Retrieve all flags with their targeting status for a specific company Get flags for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetCompanyFlagsRequest`](#getcompanyflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**getCompanyFlagsRaw()**

```ts
getCompanyFlagsRaw(requestParameters: GetCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Retrieve all flags with their targeting status for a specific company

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`GetCompanyFlagsRequest`](#getcompanyflagsrequest)              | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Throws**

**getEnvironment()**

```ts
getEnvironment(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Environment>
```

Retrieve details for a specific environment Get environment details

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetEnvironmentRequest`](#getenvironmentrequest)                |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Environment`](#environment)>

**getEnvironmentRaw()**

```ts
getEnvironmentRaw(requestParameters: GetEnvironmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Environment>>
```

Retrieve details for a specific environment

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`GetEnvironmentRequest`](#getenvironmentrequest)                | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`Environment`](#environment)>>

**Throws**

**getFlagTargeting()**

```ts
getFlagTargeting(requestParameters: GetFlagTargetingRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<FlagTargeting>
```

Retrieve targeting for a flag in an environment Get flag targeting for an environment

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetFlagTargetingRequest`](#getflagtargetingrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`FlagTargeting`](#flagtargeting)>

**getFlagTargetingRaw()**

```ts
getFlagTargetingRaw(requestParameters: GetFlagTargetingRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<FlagTargeting>>
```

Retrieve targeting for a flag in an environment

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`GetFlagTargetingRequest`](#getflagtargetingrequest)            | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`FlagTargeting`](#flagtargeting)>>

**Throws**

**getUserFlags()**

```ts
getUserFlags(requestParameters: GetUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Retrieve all flags with their targeting status for a specific user Get flags for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`GetUserFlagsRequest`](#getuserflagsrequest)                    |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**getUserFlagsRaw()**

```ts
getUserFlagsRaw(requestParameters: GetUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Retrieve all flags with their targeting status for a specific user

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`GetUserFlagsRequest`](#getuserflagsrequest)                    | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Throws**

**listApps()**

```ts
listApps(requestParameters: ListAppsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AppHeaderCollection>
```

Retrieve all accessible applications List of applications

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListAppsRequest`](#listappsrequest)                            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`AppHeaderCollection`](#appheadercollection)>

**listAppsRaw()**

```ts
listAppsRaw(requestParameters: ListAppsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AppHeaderCollection>>
```

Retrieve all accessible applications

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`ListAppsRequest`](#listappsrequest)                            | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`AppHeaderCollection`](#appheadercollection)>>

**Throws**

**listEnvironments()**

```ts
listEnvironments(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EnvironmentHeaderCollection>
```

Retrieve all environments for a specific application List environments for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListEnvironmentsRequest`](#listenvironmentsrequest)            |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EnvironmentHeaderCollection`](#environmentheadercollection)>

**listEnvironmentsRaw()**

```ts
listEnvironmentsRaw(requestParameters: ListEnvironmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EnvironmentHeaderCollection>>
```

Retrieve all environments for a specific application

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`ListEnvironmentsRequest`](#listenvironmentsrequest)            | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EnvironmentHeaderCollection`](#environmentheadercollection)>>

**Throws**

**listFlags()**

```ts
listFlags(requestParameters: ListFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<FlagHeaderCollection>
```

Retrieve all flags for a specific application List flags for application

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`ListFlagsRequest`](#listflagsrequest)                          |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`FlagHeaderCollection`](#flagheadercollection)>

**listFlagsRaw()**

```ts
listFlagsRaw(requestParameters: ListFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<FlagHeaderCollection>>
```

Retrieve all flags for a specific application

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`ListFlagsRequest`](#listflagsrequest)                          | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`FlagHeaderCollection`](#flagheadercollection)>>

**Throws**

**updateCompanyFlags()**

```ts
updateCompanyFlags(requestParameters: UpdateCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Update specific targeting for flags for a company in an environment Update flag targeting for a company

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)        |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**updateCompanyFlagsRaw()**

```ts
updateCompanyFlagsRaw(requestParameters: UpdateCompanyFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Update specific targeting for flags for a company in an environment

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)        | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Throws**

**updateFlag()**

```ts
updateFlag(requestParameters: UpdateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<CreateFlag200Response>
```

Update an existing flag Update a flag

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateFlagOperationRequest`](#updateflagoperationrequest)      |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`CreateFlag200Response`](#createflag200response)>

**updateFlagRaw()**

```ts
updateFlagRaw(requestParameters: UpdateFlagOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<CreateFlag200Response>>
```

Update an existing flag

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`UpdateFlagOperationRequest`](#updateflagoperationrequest)      | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`CreateFlag200Response`](#createflag200response)>>

**Throws**

**updateUserFlags()**

```ts
updateUserFlags(requestParameters: UpdateUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<EntityFlagsResponse>
```

Update specific targeting for flags for a user in an environment Update flag targeting for a user

**Parameters**

| Parameter           | Type                                                             |
| ------------------- | ---------------------------------------------------------------- |
| `requestParameters` | [`UpdateUserFlagsRequest`](#updateuserflagsrequest)              |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`EntityFlagsResponse`](#entityflagsresponse)>

**updateUserFlagsRaw()**

```ts
updateUserFlagsRaw(requestParameters: UpdateUserFlagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<EntityFlagsResponse>>
```

Update specific targeting for flags for a user in an environment

**Parameters**

| Parameter           | Type                                                             | Description                            |
| ------------------- | ---------------------------------------------------------------- | -------------------------------------- |
| `requestParameters` | [`UpdateUserFlagsRequest`](#updateuserflagsrequest)              | Request parameters for this operation. |
| `initOverrides`?    | `RequestInit` \| [`InitOverrideFunction`](#initoverridefunction) | ‐                                      |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`ApiResponse`](#apiresponset)<[`EntityFlagsResponse`](#entityflagsresponse)>>

**Throws**

***

### EntityFlag

Flag information with enabled status for an entity EntityFlag

#### Properties

| Property              | Type                | Description                                         |
| --------------------- | ------------------- | --------------------------------------------------- |
| `createdAt`           | `string`            | Timestamp when the flag was created                 |
| `exposureCount`       | `number`            | Number of times the entity was exposed to this flag |
| `firstExposureAt`     | `null` \| `string`  | ‐                                                   |
| `firstTrackAt`        | `null` \| `string`  | ‐                                                   |
| `id`                  | `string`            | Flag ID                                             |
| `key`                 | `string`            | Unique flag key                                     |
| `lastCheckAt`         | `null` \| `string`  | ‐                                                   |
| `lastExposureAt`      | `null` \| `string`  | ‐                                                   |
| `lastTrackAt`         | `null` \| `string`  | ‐                                                   |
| `name`                | `string`            | Flag name                                           |
| `specificTargetValue` | `null` \| `boolean` | ‐                                                   |
| `trackCount`          | `number`            | Number of track events for this flag                |
| `value`               | `boolean`           | Whether the flag is enabled for this entity         |

***

### EntityFlagsResponse

Response containing flags for an entity EntityFlagsResponse

#### Properties

| Property     | Type                           | Description                             |
| ------------ | ------------------------------ | --------------------------------------- |
| `data`       | [`EntityFlag`](#entityflag)\[] | List of flags with their enabled status |
| `pageIndex`  | `number`                       | Page index                              |
| `pageSize`   | `number`                       | Page size                               |
| `totalCount` | `number`                       | Total number of flags                   |

***

### EntityFlagUpdate

Update for a single flag's explicit targeting override EntityFlagUpdate

#### Properties

| Property              | Type             | Description     |
| --------------------- | ---------------- | --------------- |
| `flagKey`             | `string`         | Unique flag key |
| `specificTargetValue` | `null` \| `true` | ‐               |

***

### Environment

Environment details Environment

#### Properties

| Property           | Type                                            | Description                                             |
| ------------------ | ----------------------------------------------- | ------------------------------------------------------- |
| `flagStateVersion` | `number`                                        | Environment version incremented when flag state changes |
| `id`               | `string`                                        | Environment identifier                                  |
| `isProduction`     | `boolean`                                       | Whether the environment is a production environment     |
| `name`             | `string`                                        | Environment name                                        |
| `order`            | `number`                                        | Environment order in the app (zero-indexed)             |
| `sdkAccess`        | [`EnvironmentSdkAccess`](#environmentsdkaccess) | ‐                                                       |

***

### EnvironmentHeader

Basic environment information EnvironmentHeader

#### Properties

| Property           | Type      | Description                                             |
| ------------------ | --------- | ------------------------------------------------------- |
| `flagStateVersion` | `number`  | Environment version incremented when flag state changes |
| `id`               | `string`  | Environment identifier                                  |
| `isProduction`     | `boolean` | Whether the environment is a production environment     |
| `name`             | `string`  | Environment name                                        |
| `order`            | `number`  | Environment order in the app (zero-indexed)             |

***

### EnvironmentHeaderCollection

Collection of Basic environment information EnvironmentHeaderCollection

#### Properties

| Property    | Type                                                              | Description                            |
| ----------- | ----------------------------------------------------------------- | -------------------------------------- |
| `data`      | [`EnvironmentHeader`](#environmentheader)\[]                      | The individual items in the collection |
| `sortBy`    | [`EnvironmentHeaderSortByColumn`](#environmentheadersortbycolumn) | ‐                                      |
| `sortOrder` | [`SortOrder`](#sortorder-3)                                       | ‐                                      |

***

### EnvironmentSdkAccess

SDK access details EnvironmentSdkAccess

#### Properties

| Property         | Type     | Description     |
| ---------------- | -------- | --------------- |
| `publishableKey` | `string` | Publishable key |
| `secretKey`      | `string` | Secret key      |

***

### ErrorContext

#### Properties

| Property    | Type                                                                                                                                                                                                                                                                              |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `error`     | `unknown`                                                                                                                                                                                                                                                                         |
| `fetch`     | (`input`: `RequestInfo` \| [`URL`](https://developer.mozilla.org/docs/Web/API/URL), `init`?: `RequestInit`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)> |
| `init`      | `RequestInit`                                                                                                                                                                                                                                                                     |
| `response?` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response)                                                                                                                                                                                                                 |
| `url`       | `string`                                                                                                                                                                                                                                                                          |

***

### ErrorResponse

The error response, including individual issues, if applicable ErrorResponse

#### Properties

| Property  | Type                                        | Description                                 |
| --------- | ------------------------------------------- | ------------------------------------------- |
| `error`   | [`ErrorResponseError`](#errorresponseerror) | ‐                                           |
| `issues?` | {}                                          | Individual validation issues, if applicable |

***

### ErrorResponseError

The error ErrorResponseError

#### Properties

| Property  | Type                                                        | Description                  |
| --------- | ----------------------------------------------------------- | ---------------------------- |
| `code`    | [`ErrorResponseErrorCodeEnum`](#errorresponseerrorcodeenum) | Error code                   |
| `message` | `string`                                                    | Human readable error message |

***

### FetchParams

#### Properties

| Property | Type          |
| -------- | ------------- |
| `init`   | `RequestInit` |
| `url`    | `string`      |

***

### FlagHeader

Basic flag information FlagHeader

#### Properties

| Property                       | Type                                    | Description                                                |
| ------------------------------ | --------------------------------------- | ---------------------------------------------------------- |
| `archived`                     | `boolean`                               | Whether the flag is archived                               |
| `codeRefsCleanedUp`            | `boolean`                               | Whether code references for this flag have been cleaned up |
| `codeRefsMarkedCleanAt?`       | `string`                                | Timestamp when code references were marked as cleaned up   |
| `codeRefsMarkedCleanUserName?` | `string`                                | Name of the user who marked code references as cleaned up  |
| `createdAt?`                   | `string`                                | Timestamp when the flag was created                        |
| `description?`                 | `string`                                | Flag description                                           |
| `id`                           | `string`                                | Flag ID                                                    |
| `key`                          | `string`                                | Unique flag key                                            |
| `lastCheckAt?`                 | `string`                                | Timestamp when the flag was last checked                   |
| `lastTrackAt?`                 | `string`                                | Timestamp when the flag was last tracked                   |
| `name`                         | `string`                                | Flag name                                                  |
| `noRecentChecks`               | `boolean`                               | Whether the flag has no recent access checks               |
| `owner?`                       | [`ReflagUserHeader`](#reflaguserheader) | ‐                                                          |
| `permanent`                    | `boolean`                               | Whether the flag is permanent                              |
| `rolledOutToEveryoneAt?`       | `string`                                | Timestamp when the flag was rolled out to everyone         |
| `stage?`                       | [`StageHeader`](#stageheader)           | ‐                                                          |
| `stale`                        | `boolean`                               | Whether the flag is stale                                  |

***

### FlagHeaderCollection

Collection response containing flags FlagHeaderCollection

#### Properties

| Property     | Type                                                                | Description                         |
| ------------ | ------------------------------------------------------------------- | ----------------------------------- |
| `data`       | [`FlagHeader`](#flagheader)\[]                                      | Page of the collection of flags     |
| `pageIndex`  | `number`                                                            | Page index                          |
| `pageSize`   | `number`                                                            | Page size                           |
| `sortBy`     | [`FlagHeaderCollectionSortByEnum`](#flagheadercollectionsortbyenum) | Sort by                             |
| `sortOrder`  | [`SortOrder`](#sortorder-3)                                         | Sort order                          |
| `totalCount` | `number`                                                            | Total number of flags in collection |

***

### FlagTargeting

Flag targeting information and its audience FlagTargeting

#### Properties

| Property          | Type                                                                                      | Description                         |
| ----------------- | ----------------------------------------------------------------------------------------- | ----------------------------------- |
| `flagKey`         | `string`                                                                                  | Unique flag key                     |
| `specificTargets` | {}                                                                                        | The flag targeting for each value   |
| `updatedAt`       | [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) | Last time the targeting was updated |
| `version`         | `number`                                                                                  | Flag targeting version              |

***

### FlagValueTargeting

Flag targeting value and its audience FlagValueTargeting

#### Properties

| Property     | Type        | Description                                    |
| ------------ | ----------- | ---------------------------------------------- |
| `companyIds` | `string`\[] | Companies that were explicitly given the value |
| `userIds`    | `string`\[] | Users that were explicitly given the value     |

***

### GetAppRequest

#### Properties

| Property | Type     |
| -------- | -------- |
| `appId`  | `string` |

***

### GetCompanyFlagsRequest

#### Properties

| Property    | Type     |
| ----------- | -------- |
| `appId`     | `string` |
| `companyId` | `string` |
| `envId`     | `string` |

***

### GetEnvironmentRequest

#### Properties

| Property | Type     |
| -------- | -------- |
| `appId`  | `string` |
| `envId`  | `string` |

***

### GetFlagTargetingRequest

#### Properties

| Property  | Type     |
| --------- | -------- |
| `appId`   | `string` |
| `envId`   | `string` |
| `flagKey` | `string` |

***

### GetUserFlagsRequest

#### Properties

| Property | Type     |
| -------- | -------- |
| `appId`  | `string` |
| `envId`  | `string` |
| `userId` | `string` |

***

### ListAppsRequest

#### Properties

| Property | Type     |
| -------- | -------- |
| `orgId?` | `string` |

***

### ListEnvironmentsRequest

#### Properties

| Property     | Type                                                              |
| ------------ | ----------------------------------------------------------------- |
| `appId`      | `string`                                                          |
| `sortBy?`    | [`EnvironmentHeaderSortByColumn`](#environmentheadersortbycolumn) |
| `sortOrder?` | [`SortOrder`](#sortorder-3)                                       |

***

### ListFlagsRequest

#### Properties

| Property | Type     |
| -------- | -------- |
| `appId`  | `string` |

***

### Middleware

#### Methods

**onError()?**

```ts
optional onError(context: ErrorContext): Promise<
  | void
| Response>
```

**Parameters**

| Parameter | Type                            |
| --------- | ------------------------------- |
| `context` | [`ErrorContext`](#errorcontext) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)< | `void` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response)>

**post()?**

```ts
optional post(context: ResponseContext): Promise<
  | void
| Response>
```

**Parameters**

| Parameter | Type                                  |
| --------- | ------------------------------------- |
| `context` | [`ResponseContext`](#responsecontext) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)< | `void` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response)>

**pre()?**

```ts
optional pre(context: RequestContext): Promise<void | FetchParams>
```

**Parameters**

| Parameter | Type                                |
| --------- | ----------------------------------- |
| `context` | [`RequestContext`](#requestcontext) |

**Returns**

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void` | [`FetchParams`](#fetchparams)>

***

### OrgHeader

Organization's basic information OrgHeader

#### Properties

| Property | Type     | Description             |
| -------- | -------- | ----------------------- |
| `id`     | `string` | Organization identifier |
| `name`   | `string` | Organization name       |

***

### ReflagUserHeader

Reflag user's basic information ReflagUserHeader

#### Properties

| Property     | Type     | Description            |
| ------------ | -------- | ---------------------- |
| `avatarUrl?` | `string` | User's avatar URL      |
| `email`      | `string` | User's email           |
| `id`         | `string` | Reflag user identifier |
| `name`       | `string` | User's name            |

***

### RequestContext

#### Properties

| Property | Type                                                                                                                                                                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch`  | (`input`: `RequestInfo` \| [`URL`](https://developer.mozilla.org/docs/Web/API/URL), `init`?: `RequestInit`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)> |
| `init`   | `RequestInit`                                                                                                                                                                                                                                                                     |
| `url`    | `string`                                                                                                                                                                                                                                                                          |

***

### RequestOpts

#### Properties

| Property  | Type                          |
| --------- | ----------------------------- |
| `body?`   | `any`                         |
| `headers` | [`HTTPHeaders`](#httpheaders) |
| `method`  | [`HTTPMethod`](#httpmethod)   |
| `path`    | `string`                      |
| `query?`  | [`HTTPQuery`](#httpquery)     |

***

### ResponseContext

#### Properties

| Property   | Type                                                                                                                                                                                                                                                                              |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch`    | (`input`: `RequestInfo` \| [`URL`](https://developer.mozilla.org/docs/Web/API/URL), `init`?: `RequestInit`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)> |
| `init`     | `RequestInit`                                                                                                                                                                                                                                                                     |
| `response` | [`Response`](https://developer.mozilla.org/docs/Web/API/Response)                                                                                                                                                                                                                 |
| `url`      | `string`                                                                                                                                                                                                                                                                          |

***

### ResponseTransformer()\<T>

#### Type Parameters

| Type Parameter |
| -------------- |
| `T`            |

```ts
interface ResponseTransformer(json: any): T
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

`T`

***

### SegmentHeader

Segment's basic information SegmentHeader

#### Properties

| Property | Type                          | Description        |
| -------- | ----------------------------- | ------------------ |
| `id`     | `string`                      | Segment identifier |
| `name`   | `string`                      | Segment name       |
| `type`   | [`SegmentType`](#segmenttype) | ‐                  |

***

### StageHeader

Stage's basic information StageHeader

#### Properties

| Property | Type     | Description                               |
| -------- | -------- | ----------------------------------------- |
| `color`  | `string` | Stage color (HTML color name or hex code) |
| `id`     | `string` | Stage identifier                          |
| `name`   | `string` | Stage name                                |
| `order`  | `number` | Stage order                               |

***

### UpdateCompanyFlagsRequest

Request body for updating flags for an entity UpdateEntityFlagsBody

#### Extends

* [`UpdateEntityFlagsBody`](#updateentityflagsbody)

#### Properties

| Property             | Type                                                                                   | Description                                                                                                             |
| -------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `appId`              | `string`                                                                               | ‐                                                                                                                       |
| `changeDescription?` | `string`                                                                               | Description of the change for audit history                                                                             |
| `companyId`          | `string`                                                                               | ‐                                                                                                                       |
| `envId`              | `string`                                                                               | ‐                                                                                                                       |
| `notifications?`     | [`UpdateEntityFlagsBodyNotificationsEnum`](#updateentityflagsbodynotificationsenum)\[] | Destination list for notifications about the change. Use \[] to disable notifications. Omit to use configured defaults. |
| `updates`            | [`EntityFlagUpdate`](#entityflagupdate)\[]                                             | List of flag updates to apply                                                                                           |

***

### UpdateEntityFlagsBody

Request body for updating flags for an entity UpdateEntityFlagsBody

#### Extended by

* [`UpdateCompanyFlagsRequest`](#updatecompanyflagsrequest)
* [`UpdateUserFlagsRequest`](#updateuserflagsrequest)

#### Properties

| Property             | Type                                                                                   | Description                                                                                                             |
| -------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `changeDescription?` | `string`                                                                               | Description of the change for audit history                                                                             |
| `notifications?`     | [`UpdateEntityFlagsBodyNotificationsEnum`](#updateentityflagsbodynotificationsenum)\[] | Destination list for notifications about the change. Use \[] to disable notifications. Omit to use configured defaults. |
| `updates`            | [`EntityFlagUpdate`](#entityflagupdate)\[]                                             | List of flag updates to apply                                                                                           |

***

### UpdateFlagOperationRequest

UpdateFlagRequest

#### Extends

* [`UpdateFlagRequest`](#updateflagrequest)

#### Properties

| Property       | Type               | Description                |
| -------------- | ------------------ | -------------------------- |
| `appId`        | `string`           | ‐                          |
| `description?` | `null` \| `string` | ‐                          |
| `flagId`       | `string`           | ‐                          |
| `isArchived?`  | `boolean`          | ‐                          |
| `name?`        | `string`           | Name of the flag           |
| `ownerUserId?` | `null` \| `string` | ‐                          |
| `permanent?`   | `boolean`          | ‐                          |
| `secret?`      | `boolean`          | Whether the flag is secret |
| `stageId?`     | `string`           | Stage ID of the flag       |

***

### UpdateFlagRequest

UpdateFlagRequest

#### Extended by

* [`UpdateFlagOperationRequest`](#updateflagoperationrequest)

#### Properties

| Property       | Type               | Description                |
| -------------- | ------------------ | -------------------------- |
| `description?` | `null` \| `string` | ‐                          |
| `isArchived?`  | `boolean`          | ‐                          |
| `name?`        | `string`           | Name of the flag           |
| `ownerUserId?` | `null` \| `string` | ‐                          |
| `permanent?`   | `boolean`          | ‐                          |
| `secret?`      | `boolean`          | Whether the flag is secret |
| `stageId?`     | `string`           | Stage ID of the flag       |

***

### UpdateUserFlagsRequest

Request body for updating flags for an entity UpdateEntityFlagsBody

#### Extends

* [`UpdateEntityFlagsBody`](#updateentityflagsbody)

#### Properties

| Property             | Type                                                                                   | Description                                                                                                             |
| -------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `appId`              | `string`                                                                               | ‐                                                                                                                       |
| `changeDescription?` | `string`                                                                               | Description of the change for audit history                                                                             |
| `envId`              | `string`                                                                               | ‐                                                                                                                       |
| `notifications?`     | [`UpdateEntityFlagsBodyNotificationsEnum`](#updateentityflagsbodynotificationsenum)\[] | Destination list for notifications about the change. Use \[] to disable notifications. Omit to use configured defaults. |
| `updates`            | [`EntityFlagUpdate`](#entityflagupdate)\[]                                             | List of flag updates to apply                                                                                           |
| `userId`             | `string`                                                                               | ‐                                                                                                                       |

## Type Aliases

### AppScopedApi\<T>

```ts
type AppScopedApi<T> = { [K in keyof T]: OmitAppIdParam<T[K]> };
```

#### Type Parameters

| Type Parameter |
| -------------- |
| `T`            |

***

### EntityFlagUpdateSpecificTargetValueEnum

```ts
type EntityFlagUpdateSpecificTargetValueEnum = typeof EntityFlagUpdateSpecificTargetValueEnum[keyof typeof EntityFlagUpdateSpecificTargetValueEnum];
```

***

### EnvironmentHeaderSortByColumn

```ts
type EnvironmentHeaderSortByColumn = typeof EnvironmentHeaderSortByColumn[keyof typeof EnvironmentHeaderSortByColumn];
```

***

### ErrorResponseErrorCodeEnum

```ts
type ErrorResponseErrorCodeEnum = typeof ErrorResponseErrorCodeEnum[keyof typeof ErrorResponseErrorCodeEnum];
```

***

### FetchAPI

```ts
type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
```

***

### FlagHeaderCollectionSortByEnum

```ts
type FlagHeaderCollectionSortByEnum = typeof FlagHeaderCollectionSortByEnum[keyof typeof FlagHeaderCollectionSortByEnum];
```

***

### FlagKeyFormat

```ts
type FlagKeyFormat = typeof FlagKeyFormat[keyof typeof FlagKeyFormat];
```

***

### FlagValue

```ts
type FlagValue = typeof FlagValue[keyof typeof FlagValue];
```

***

### HTTPBody

```ts
type HTTPBody = 
  | Json
  | FormData
  | URLSearchParams;
```

***

### HTTPHeaders

```ts
type HTTPHeaders = {};
```

#### Index Signature

```ts
[key: string]: string
```

***

### HTTPMethod

```ts
type HTTPMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
```

***

### HTTPQuery

```ts
type HTTPQuery = {};
```

#### Index Signature

```ts
[key: string]: 
  | null
  | string
  | number
  | boolean
  | HTTPQuery
  | (null | string | number | boolean)[]
| Set<null | string | number | boolean>
```

***

### HTTPRequestInit

```ts
type HTTPRequestInit = {
  body: HTTPBody;
  credentials: RequestCredentials;
  headers: HTTPHeaders;
  method: HTTPMethod;
};
```

#### Type declaration

| Name           | Type                          |
| -------------- | ----------------------------- |
| `body`?        | [`HTTPBody`](#httpbody)       |
| `credentials`? | `RequestCredentials`          |
| `headers`?     | [`HTTPHeaders`](#httpheaders) |
| `method`       | [`HTTPMethod`](#httpmethod)   |

***

### InitOverrideFunction()

```ts
type InitOverrideFunction = (requestContext: {
  context: RequestOpts;
  init: HTTPRequestInit;
}) => Promise<RequestInit>;
```

#### Parameters

| Parameter                | Type                                                                                         |
| ------------------------ | -------------------------------------------------------------------------------------------- |
| `requestContext`         | { `context`: [`RequestOpts`](#requestopts); `init`: [`HTTPRequestInit`](#httprequestinit); } |
| `requestContext.context` | [`RequestOpts`](#requestopts)                                                                |
| `requestContext.init`    | [`HTTPRequestInit`](#httprequestinit)                                                        |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`RequestInit`>

***

### Json

```ts
type Json = any;
```

***

### ModelPropertyNaming

```ts
type ModelPropertyNaming = "camelCase" | "snake_case" | "PascalCase" | "original";
```

***

### OmitAppIdParam\<F>

```ts
type OmitAppIdParam<F> = F extends (arg1: infer A, ...rest: infer R) => infer Ret ? A extends {
  appId: string;
 } ? (arg1: Omit<A, "appId">, ...rest: R) => Ret : F : F;
```

#### Type Parameters

| Type Parameter |
| -------------- |
| `F`            |

***

### SegmentType

```ts
type SegmentType = typeof SegmentType[keyof typeof SegmentType];
```

***

### SortOrder

```ts
type SortOrder = typeof SortOrder[keyof typeof SortOrder];
```

***

### UpdateEntityFlagsBodyNotificationsEnum

```ts
type UpdateEntityFlagsBodyNotificationsEnum = typeof UpdateEntityFlagsBodyNotificationsEnum[keyof typeof UpdateEntityFlagsBodyNotificationsEnum];
```

## Variables

### BASE\_PATH

```ts
const BASE_PATH: string;
```

Reflag Management API Feature flag Management API

The version of the OpenAPI document: 3.0.1

NOTE: This class is auto generated by OpenAPI Generator (<https://openapi-generator.tech>). <https://openapi-generator.tech> Do not edit the class manually.

***

### COLLECTION\_FORMATS

```ts
const COLLECTION_FORMATS: {
  csv: string;
  pipes: string;
  ssv: string;
  tsv: string;
};
```

#### Type declaration

| Name    | Type     | Default value |
| ------- | -------- | ------------- |
| `csv`   | `string` | ","           |
| `pipes` | `string` | "\|"          |
| `ssv`   | `string` | " "           |
| `tsv`   | `string` | "\t"          |

***

### DefaultConfig

```ts
const DefaultConfig: Configuration;
```

***

### EntityFlagUpdateSpecificTargetValueEnum

```ts
const EntityFlagUpdateSpecificTargetValueEnum: {
  True: true;
};
```

#### Type declaration

| Name   | Type   | Default value |
| ------ | ------ | ------------- |
| `True` | `true` | true          |

***

### EnvironmentHeaderSortByColumn

```ts
const EnvironmentHeaderSortByColumn: {
  Name: "name";
  Order: "order";
};
```

The column to sort by

#### Type declaration

| Name    | Type      | Default value |
| ------- | --------- | ------------- |
| `Name`  | `"name"`  | 'name'        |
| `Order` | `"order"` | 'order'       |

***

### ErrorResponseErrorCodeEnum

```ts
const ErrorResponseErrorCodeEnum: {
  InvalidRequest: "invalid_request";
  NotAllowed: "not_allowed";
  NotAvailable: "not_available";
  NotFound: "not_found";
  NotPossible: "not_possible";
  Unauthenticated: "unauthenticated";
  Unauthorized: "unauthorized";
  UnknownError: "unknown_error";
};
```

#### Type declaration

| Name              | Type                | Default value      |
| ----------------- | ------------------- | ------------------ |
| `InvalidRequest`  | `"invalid_request"` | 'invalid\_request' |
| `NotAllowed`      | `"not_allowed"`     | 'not\_allowed'     |
| `NotAvailable`    | `"not_available"`   | 'not\_available'   |
| `NotFound`        | `"not_found"`       | 'not\_found'       |
| `NotPossible`     | `"not_possible"`    | 'not\_possible'    |
| `Unauthenticated` | `"unauthenticated"` | 'unauthenticated'  |
| `Unauthorized`    | `"unauthorized"`    | 'unauthorized'     |
| `UnknownError`    | `"unknown_error"`   | 'unknown\_error'   |

***

### FlagHeaderCollectionSortByEnum

```ts
const FlagHeaderCollectionSortByEnum: {
  ArchivingChecks: "archivingChecks";
  AutoFeedbackSurveysEnabled: "autoFeedbackSurveysEnabled";
  CreatedAt: "createdAt";
  EnvironmentStatus: "environmentStatus";
  Key: "key";
  LastCheck: "lastCheck";
  LastTrack: "lastTrack";
  Name: "name";
  Owner: "owner";
  RolledOutToEveryoneAt: "rolledOutToEveryoneAt";
  Stage: "stage";
  Stale: "stale";
};
```

#### Type declaration

| Name                         | Type                           | Default value                |
| ---------------------------- | ------------------------------ | ---------------------------- |
| `ArchivingChecks`            | `"archivingChecks"`            | 'archivingChecks'            |
| `AutoFeedbackSurveysEnabled` | `"autoFeedbackSurveysEnabled"` | 'autoFeedbackSurveysEnabled' |
| `CreatedAt`                  | `"createdAt"`                  | 'createdAt'                  |
| `EnvironmentStatus`          | `"environmentStatus"`          | 'environmentStatus'          |
| `Key`                        | `"key"`                        | 'key'                        |
| `LastCheck`                  | `"lastCheck"`                  | 'lastCheck'                  |
| `LastTrack`                  | `"lastTrack"`                  | 'lastTrack'                  |
| `Name`                       | `"name"`                       | 'name'                       |
| `Owner`                      | `"owner"`                      | 'owner'                      |
| `RolledOutToEveryoneAt`      | `"rolledOutToEveryoneAt"`      | 'rolledOutToEveryoneAt'      |
| `Stage`                      | `"stage"`                      | 'stage'                      |
| `Stale`                      | `"stale"`                      | 'stale'                      |

***

### FlagKeyFormat

```ts
const FlagKeyFormat: {
  CamelCase: "camelCase";
  Custom: "custom";
  KebabCaseLower: "kebabCaseLower";
  KebabCaseUpper: "kebabCaseUpper";
  PascalCase: "pascalCase";
  SnakeCaseLower: "snakeCaseLower";
  SnakeCaseUpper: "snakeCaseUpper";
};
```

The enforced key format when creating flags

#### Type declaration

| Name             | Type               | Default value    |
| ---------------- | ------------------ | ---------------- |
| `CamelCase`      | `"camelCase"`      | 'camelCase'      |
| `Custom`         | `"custom"`         | 'custom'         |
| `KebabCaseLower` | `"kebabCaseLower"` | 'kebabCaseLower' |
| `KebabCaseUpper` | `"kebabCaseUpper"` | 'kebabCaseUpper' |
| `PascalCase`     | `"pascalCase"`     | 'pascalCase'     |
| `SnakeCaseLower` | `"snakeCaseLower"` | 'snakeCaseLower' |
| `SnakeCaseUpper` | `"snakeCaseUpper"` | 'snakeCaseUpper' |

***

### FlagValue

```ts
const FlagValue: {
  True: "true";
};
```

The value of the flag served to the audience.

#### Type declaration

| Name   | Type     | Default value |
| ------ | -------- | ------------- |
| `True` | `"true"` | 'true'        |

***

### SegmentType

```ts
const SegmentType: {
  All: "all";
  Custom: "custom";
};
```

Segment type

#### Type declaration

| Name     | Type       | Default value |
| -------- | ---------- | ------------- |
| `All`    | `"all"`    | 'all'         |
| `Custom` | `"custom"` | 'custom'      |

***

### SortOrder

```ts
const SortOrder: {
  Asc: "asc";
  Desc: "desc";
};
```

Sort order applied to the sorting column

#### Type declaration

| Name   | Type     | Default value |
| ------ | -------- | ------------- |
| `Asc`  | `"asc"`  | 'asc'         |
| `Desc` | `"desc"` | 'desc'        |

***

### UpdateEntityFlagsBodyNotificationsEnum

```ts
const UpdateEntityFlagsBodyNotificationsEnum: {
  LinearComment: "linearComment";
  Slack: "slack";
};
```

#### Type declaration

| Name            | Type              | Default value   |
| --------------- | ----------------- | --------------- |
| `LinearComment` | `"linearComment"` | 'linearComment' |
| `Slack`         | `"slack"`         | 'slack'         |

## Functions

### AppFromJSON()

```ts
function AppFromJSON(json: any): App
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`App`](#app)

***

### AppFromJSONTyped()

```ts
function AppFromJSONTyped(json: any, ignoreDiscriminator: boolean): App
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`App`](#app)

***

### AppHeaderCollectionFromJSON()

```ts
function AppHeaderCollectionFromJSON(json: any): AppHeaderCollection
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`AppHeaderCollection`](#appheadercollection)

***

### AppHeaderCollectionFromJSONTyped()

```ts
function AppHeaderCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppHeaderCollection
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`AppHeaderCollection`](#appheadercollection)

***

### AppHeaderCollectionToJSON()

```ts
function AppHeaderCollectionToJSON(json: any): AppHeaderCollection
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`AppHeaderCollection`](#appheadercollection)

***

### AppHeaderCollectionToJSONTyped()

```ts
function AppHeaderCollectionToJSONTyped(value?: null | AppHeaderCollection, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                    | Default value |
| ---------------------- | ------------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`AppHeaderCollection`](#appheadercollection) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                               | `false`       |

#### Returns

`any`

***

### AppHeaderFromJSON()

```ts
function AppHeaderFromJSON(json: any): AppHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`AppHeader`](#appheader)

***

### AppHeaderFromJSONTyped()

```ts
function AppHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`AppHeader`](#appheader)

***

### AppHeaderToJSON()

```ts
function AppHeaderToJSON(json: any): AppHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`AppHeader`](#appheader)

***

### AppHeaderToJSONTyped()

```ts
function AppHeaderToJSONTyped(value?: null | AppHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                | Default value |
| ---------------------- | ----------------------------------- | ------------- |
| `value`?               | `null` \| [`AppHeader`](#appheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                           | `false`       |

#### Returns

`any`

***

### AppToJSON()

```ts
function AppToJSON(json: any): App
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`App`](#app)

***

### AppToJSONTyped()

```ts
function AppToJSONTyped(value?: null | App, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                    | Default value |
| ---------------------- | ----------------------- | ------------- |
| `value`?               | `null` \| [`App`](#app) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`               | `false`       |

#### Returns

`any`

***

### canConsumeForm()

```ts
function canConsumeForm(consumes: Consume[]): boolean
```

#### Parameters

| Parameter  | Type                     |
| ---------- | ------------------------ |
| `consumes` | [`Consume`](#consume)\[] |

#### Returns

`boolean`

***

### createAppClient()

```ts
function createAppClient(appId: string, config?: ConfigurationParameters): AppScopedApi<Api>
```

#### Parameters

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `appId`   | `string`                                              |
| `config`? | [`ConfigurationParameters`](#configurationparameters) |

#### Returns

[`AppScopedApi`](#appscopedapit)<[`Api`](#api)>

***

### CreateFlag200ResponseFlagFromJSON()

```ts
function CreateFlag200ResponseFlagFromJSON(json: any): CreateFlag200ResponseFlag
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`CreateFlag200ResponseFlag`](#createflag200responseflag)

***

### CreateFlag200ResponseFlagFromJSONTyped()

```ts
function CreateFlag200ResponseFlagFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFlag200ResponseFlag
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`CreateFlag200ResponseFlag`](#createflag200responseflag)

***

### CreateFlag200ResponseFlagToJSON()

```ts
function CreateFlag200ResponseFlagToJSON(json: any): CreateFlag200ResponseFlag
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`CreateFlag200ResponseFlag`](#createflag200responseflag)

***

### CreateFlag200ResponseFlagToJSONTyped()

```ts
function CreateFlag200ResponseFlagToJSONTyped(value?: 
  | null
  | CreateFlag200ResponseFlag, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                                   | Default value |
| ---------------------- | ---------------------------------------------------------------------- | ------------- |
| `value`?               | \| `null` \| [`CreateFlag200ResponseFlag`](#createflag200responseflag) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                                              | `false`       |

#### Returns

`any`

***

### CreateFlag200ResponseFromJSON()

```ts
function CreateFlag200ResponseFromJSON(json: any): CreateFlag200Response
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`CreateFlag200Response`](#createflag200response)

***

### CreateFlag200ResponseFromJSONTyped()

```ts
function CreateFlag200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFlag200Response
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`CreateFlag200Response`](#createflag200response)

***

### CreateFlag200ResponseToJSON()

```ts
function CreateFlag200ResponseToJSON(json: any): CreateFlag200Response
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`CreateFlag200Response`](#createflag200response)

***

### CreateFlag200ResponseToJSONTyped()

```ts
function CreateFlag200ResponseToJSONTyped(value?: null | CreateFlag200Response, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                        | Default value |
| ---------------------- | ----------------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`CreateFlag200Response`](#createflag200response) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                                   | `false`       |

#### Returns

`any`

***

### CreateFlagRequestFromJSON()

```ts
function CreateFlagRequestFromJSON(json: any): CreateFlagRequest
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`CreateFlagRequest`](#createflagrequest)

***

### CreateFlagRequestFromJSONTyped()

```ts
function CreateFlagRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFlagRequest
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`CreateFlagRequest`](#createflagrequest)

***

### CreateFlagRequestToJSON()

```ts
function CreateFlagRequestToJSON(json: any): CreateFlagRequest
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`CreateFlagRequest`](#createflagrequest)

***

### CreateFlagRequestToJSONTyped()

```ts
function CreateFlagRequestToJSONTyped(value?: null | CreateFlagRequest, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                | Default value |
| ---------------------- | --------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`CreateFlagRequest`](#createflagrequest) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                           | `false`       |

#### Returns

`any`

***

### EntityFlagFromJSON()

```ts
function EntityFlagFromJSON(json: any): EntityFlag
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EntityFlag`](#entityflag)

***

### EntityFlagFromJSONTyped()

```ts
function EntityFlagFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityFlag
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EntityFlag`](#entityflag)

***

### EntityFlagsResponseFromJSON()

```ts
function EntityFlagsResponseFromJSON(json: any): EntityFlagsResponse
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EntityFlagsResponse`](#entityflagsresponse)

***

### EntityFlagsResponseFromJSONTyped()

```ts
function EntityFlagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityFlagsResponse
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EntityFlagsResponse`](#entityflagsresponse)

***

### EntityFlagsResponseToJSON()

```ts
function EntityFlagsResponseToJSON(json: any): EntityFlagsResponse
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EntityFlagsResponse`](#entityflagsresponse)

***

### EntityFlagsResponseToJSONTyped()

```ts
function EntityFlagsResponseToJSONTyped(value?: null | EntityFlagsResponse, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                    | Default value |
| ---------------------- | ------------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`EntityFlagsResponse`](#entityflagsresponse) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                               | `false`       |

#### Returns

`any`

***

### EntityFlagToJSON()

```ts
function EntityFlagToJSON(json: any): EntityFlag
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EntityFlag`](#entityflag)

***

### EntityFlagToJSONTyped()

```ts
function EntityFlagToJSONTyped(value?: null | EntityFlag, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                  | Default value |
| ---------------------- | ------------------------------------- | ------------- |
| `value`?               | `null` \| [`EntityFlag`](#entityflag) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                             | `false`       |

#### Returns

`any`

***

### EntityFlagUpdateFromJSON()

```ts
function EntityFlagUpdateFromJSON(json: any): EntityFlagUpdate
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EntityFlagUpdate`](#entityflagupdate)

***

### EntityFlagUpdateFromJSONTyped()

```ts
function EntityFlagUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityFlagUpdate
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EntityFlagUpdate`](#entityflagupdate)

***

### EntityFlagUpdateToJSON()

```ts
function EntityFlagUpdateToJSON(json: any): EntityFlagUpdate
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EntityFlagUpdate`](#entityflagupdate)

***

### EntityFlagUpdateToJSONTyped()

```ts
function EntityFlagUpdateToJSONTyped(value?: null | EntityFlagUpdate, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                              | Default value |
| ---------------------- | ------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`EntityFlagUpdate`](#entityflagupdate) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                         | `false`       |

#### Returns

`any`

***

### EnvironmentFromJSON()

```ts
function EnvironmentFromJSON(json: any): Environment
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`Environment`](#environment)

***

### EnvironmentFromJSONTyped()

```ts
function EnvironmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): Environment
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`Environment`](#environment)

***

### EnvironmentHeaderCollectionFromJSON()

```ts
function EnvironmentHeaderCollectionFromJSON(json: any): EnvironmentHeaderCollection
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentHeaderCollection`](#environmentheadercollection)

***

### EnvironmentHeaderCollectionFromJSONTyped()

```ts
function EnvironmentHeaderCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentHeaderCollection
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EnvironmentHeaderCollection`](#environmentheadercollection)

***

### EnvironmentHeaderCollectionToJSON()

```ts
function EnvironmentHeaderCollectionToJSON(json: any): EnvironmentHeaderCollection
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentHeaderCollection`](#environmentheadercollection)

***

### EnvironmentHeaderCollectionToJSONTyped()

```ts
function EnvironmentHeaderCollectionToJSONTyped(value?: 
  | null
  | EnvironmentHeaderCollection, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                                       | Default value |
| ---------------------- | -------------------------------------------------------------------------- | ------------- |
| `value`?               | \| `null` \| [`EnvironmentHeaderCollection`](#environmentheadercollection) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                                                  | `false`       |

#### Returns

`any`

***

### EnvironmentHeaderFromJSON()

```ts
function EnvironmentHeaderFromJSON(json: any): EnvironmentHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentHeader`](#environmentheader)

***

### EnvironmentHeaderFromJSONTyped()

```ts
function EnvironmentHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EnvironmentHeader`](#environmentheader)

***

### EnvironmentHeaderSortByColumnFromJSON()

```ts
function EnvironmentHeaderSortByColumnFromJSON(json: any): EnvironmentHeaderSortByColumn
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentHeaderSortByColumn`](#environmentheadersortbycolumn)

***

### EnvironmentHeaderSortByColumnFromJSONTyped()

```ts
function EnvironmentHeaderSortByColumnFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentHeaderSortByColumn
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EnvironmentHeaderSortByColumn`](#environmentheadersortbycolumn)

***

### EnvironmentHeaderSortByColumnToJSON()

```ts
function EnvironmentHeaderSortByColumnToJSON(value?: 
  | null
  | EnvironmentHeaderSortByColumn): any
```

#### Parameters

| Parameter | Type                                                                           |
| --------- | ------------------------------------------------------------------------------ |
| `value`?  | \| `null` \| [`EnvironmentHeaderSortByColumn`](#environmentheadersortbycolumn) |

#### Returns

`any`

***

### EnvironmentHeaderSortByColumnToJSONTyped()

```ts
function EnvironmentHeaderSortByColumnToJSONTyped(value: any, ignoreDiscriminator: boolean): EnvironmentHeaderSortByColumn
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `value`               | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EnvironmentHeaderSortByColumn`](#environmentheadersortbycolumn)

***

### EnvironmentHeaderToJSON()

```ts
function EnvironmentHeaderToJSON(json: any): EnvironmentHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentHeader`](#environmentheader)

***

### EnvironmentHeaderToJSONTyped()

```ts
function EnvironmentHeaderToJSONTyped(value?: null | EnvironmentHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                | Default value |
| ---------------------- | --------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`EnvironmentHeader`](#environmentheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                           | `false`       |

#### Returns

`any`

***

### EnvironmentSdkAccessFromJSON()

```ts
function EnvironmentSdkAccessFromJSON(json: any): EnvironmentSdkAccess
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentSdkAccess`](#environmentsdkaccess)

***

### EnvironmentSdkAccessFromJSONTyped()

```ts
function EnvironmentSdkAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentSdkAccess
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`EnvironmentSdkAccess`](#environmentsdkaccess)

***

### EnvironmentSdkAccessToJSON()

```ts
function EnvironmentSdkAccessToJSON(json: any): EnvironmentSdkAccess
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`EnvironmentSdkAccess`](#environmentsdkaccess)

***

### EnvironmentSdkAccessToJSONTyped()

```ts
function EnvironmentSdkAccessToJSONTyped(value?: null | EnvironmentSdkAccess, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                      | Default value |
| ---------------------- | --------------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`EnvironmentSdkAccess`](#environmentsdkaccess) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                                 | `false`       |

#### Returns

`any`

***

### EnvironmentToJSON()

```ts
function EnvironmentToJSON(json: any): Environment
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`Environment`](#environment)

***

### EnvironmentToJSONTyped()

```ts
function EnvironmentToJSONTyped(value?: null | Environment, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                    | Default value |
| ---------------------- | --------------------------------------- | ------------- |
| `value`?               | `null` \| [`Environment`](#environment) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                               | `false`       |

#### Returns

`any`

***

### ErrorResponseErrorFromJSON()

```ts
function ErrorResponseErrorFromJSON(json: any): ErrorResponseError
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`ErrorResponseError`](#errorresponseerror)

***

### ErrorResponseErrorFromJSONTyped()

```ts
function ErrorResponseErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorResponseError
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`ErrorResponseError`](#errorresponseerror)

***

### ErrorResponseErrorToJSON()

```ts
function ErrorResponseErrorToJSON(json: any): ErrorResponseError
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`ErrorResponseError`](#errorresponseerror)

***

### ErrorResponseErrorToJSONTyped()

```ts
function ErrorResponseErrorToJSONTyped(value?: null | ErrorResponseError, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                  | Default value |
| ---------------------- | ----------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`ErrorResponseError`](#errorresponseerror) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                             | `false`       |

#### Returns

`any`

***

### ErrorResponseFromJSON()

```ts
function ErrorResponseFromJSON(json: any): ErrorResponse
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`ErrorResponse`](#errorresponse)

***

### ErrorResponseFromJSONTyped()

```ts
function ErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorResponse
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`ErrorResponse`](#errorresponse)

***

### ErrorResponseToJSON()

```ts
function ErrorResponseToJSON(json: any): ErrorResponse
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`ErrorResponse`](#errorresponse)

***

### ErrorResponseToJSONTyped()

```ts
function ErrorResponseToJSONTyped(value?: null | ErrorResponse, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                        | Default value |
| ---------------------- | ------------------------------------------- | ------------- |
| `value`?               | `null` \| [`ErrorResponse`](#errorresponse) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                   | `false`       |

#### Returns

`any`

***

### exists()

```ts
function exists(json: any, key: string): boolean
```

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `json`    | `any`    |
| `key`     | `string` |

#### Returns

`boolean`

***

### FlagHeaderCollectionFromJSON()

```ts
function FlagHeaderCollectionFromJSON(json: any): FlagHeaderCollection
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagHeaderCollection`](#flagheadercollection)

***

### FlagHeaderCollectionFromJSONTyped()

```ts
function FlagHeaderCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlagHeaderCollection
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagHeaderCollection`](#flagheadercollection)

***

### FlagHeaderCollectionToJSON()

```ts
function FlagHeaderCollectionToJSON(json: any): FlagHeaderCollection
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagHeaderCollection`](#flagheadercollection)

***

### FlagHeaderCollectionToJSONTyped()

```ts
function FlagHeaderCollectionToJSONTyped(value?: null | FlagHeaderCollection, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                      | Default value |
| ---------------------- | --------------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`FlagHeaderCollection`](#flagheadercollection) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                                 | `false`       |

#### Returns

`any`

***

### FlagHeaderFromJSON()

```ts
function FlagHeaderFromJSON(json: any): FlagHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagHeader`](#flagheader)

***

### FlagHeaderFromJSONTyped()

```ts
function FlagHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlagHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagHeader`](#flagheader)

***

### FlagHeaderToJSON()

```ts
function FlagHeaderToJSON(json: any): FlagHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagHeader`](#flagheader)

***

### FlagHeaderToJSONTyped()

```ts
function FlagHeaderToJSONTyped(value?: null | FlagHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                  | Default value |
| ---------------------- | ------------------------------------- | ------------- |
| `value`?               | `null` \| [`FlagHeader`](#flagheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                             | `false`       |

#### Returns

`any`

***

### FlagKeyFormatFromJSON()

```ts
function FlagKeyFormatFromJSON(json: any): FlagKeyFormat
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagKeyFormat`](#flagkeyformat-2)

***

### FlagKeyFormatFromJSONTyped()

```ts
function FlagKeyFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlagKeyFormat
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagKeyFormat`](#flagkeyformat-2)

***

### FlagKeyFormatToJSON()

```ts
function FlagKeyFormatToJSON(value?: null | FlagKeyFormat): any
```

#### Parameters

| Parameter | Type                                          |
| --------- | --------------------------------------------- |
| `value`?  | `null` \| [`FlagKeyFormat`](#flagkeyformat-2) |

#### Returns

`any`

***

### FlagKeyFormatToJSONTyped()

```ts
function FlagKeyFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): FlagKeyFormat
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `value`               | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagKeyFormat`](#flagkeyformat-2)

***

### FlagTargetingFromJSON()

```ts
function FlagTargetingFromJSON(json: any): FlagTargeting
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagTargeting`](#flagtargeting)

***

### FlagTargetingFromJSONTyped()

```ts
function FlagTargetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlagTargeting
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagTargeting`](#flagtargeting)

***

### FlagTargetingToJSON()

```ts
function FlagTargetingToJSON(json: any): FlagTargeting
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagTargeting`](#flagtargeting)

***

### FlagTargetingToJSONTyped()

```ts
function FlagTargetingToJSONTyped(value?: null | FlagTargeting, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                        | Default value |
| ---------------------- | ------------------------------------------- | ------------- |
| `value`?               | `null` \| [`FlagTargeting`](#flagtargeting) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                   | `false`       |

#### Returns

`any`

***

### FlagValueFromJSON()

```ts
function FlagValueFromJSON(json: any): FlagValue
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagValue`](#flagvalue)

***

### FlagValueFromJSONTyped()

```ts
function FlagValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlagValue
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagValue`](#flagvalue)

***

### FlagValueTargetingFromJSON()

```ts
function FlagValueTargetingFromJSON(json: any): FlagValueTargeting
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagValueTargeting`](#flagvaluetargeting)

***

### FlagValueTargetingFromJSONTyped()

```ts
function FlagValueTargetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlagValueTargeting
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagValueTargeting`](#flagvaluetargeting)

***

### FlagValueTargetingToJSON()

```ts
function FlagValueTargetingToJSON(json: any): FlagValueTargeting
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`FlagValueTargeting`](#flagvaluetargeting)

***

### FlagValueTargetingToJSONTyped()

```ts
function FlagValueTargetingToJSONTyped(value?: null | FlagValueTargeting, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                  | Default value |
| ---------------------- | ----------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`FlagValueTargeting`](#flagvaluetargeting) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                             | `false`       |

#### Returns

`any`

***

### FlagValueToJSON()

```ts
function FlagValueToJSON(value?: null | "true"): any
```

#### Parameters

| Parameter | Type               |
| --------- | ------------------ |
| `value`?  | `null` \| `"true"` |

#### Returns

`any`

***

### FlagValueToJSONTyped()

```ts
function FlagValueToJSONTyped(value: any, ignoreDiscriminator: boolean): FlagValue
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `value`               | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`FlagValue`](#flagvalue)

***

### instanceOfApp()

```ts
function instanceOfApp(value: object): value is App
```

Check if a given object implements the App interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is App`

***

### instanceOfAppHeader()

```ts
function instanceOfAppHeader(value: object): value is AppHeader
```

Check if a given object implements the AppHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is AppHeader`

***

### instanceOfAppHeaderCollection()

```ts
function instanceOfAppHeaderCollection(value: object): value is AppHeaderCollection
```

Check if a given object implements the AppHeaderCollection interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is AppHeaderCollection`

***

### instanceOfCreateFlag200Response()

```ts
function instanceOfCreateFlag200Response(value: object): value is CreateFlag200Response
```

Check if a given object implements the CreateFlag200Response interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is CreateFlag200Response`

***

### instanceOfCreateFlag200ResponseFlag()

```ts
function instanceOfCreateFlag200ResponseFlag(value: object): value is CreateFlag200ResponseFlag
```

Check if a given object implements the CreateFlag200ResponseFlag interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is CreateFlag200ResponseFlag`

***

### instanceOfCreateFlagRequest()

```ts
function instanceOfCreateFlagRequest(value: object): value is CreateFlagRequest
```

Check if a given object implements the CreateFlagRequest interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is CreateFlagRequest`

***

### instanceOfEntityFlag()

```ts
function instanceOfEntityFlag(value: object): value is EntityFlag
```

Check if a given object implements the EntityFlag interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is EntityFlag`

***

### instanceOfEntityFlagsResponse()

```ts
function instanceOfEntityFlagsResponse(value: object): value is EntityFlagsResponse
```

Check if a given object implements the EntityFlagsResponse interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is EntityFlagsResponse`

***

### instanceOfEntityFlagUpdate()

```ts
function instanceOfEntityFlagUpdate(value: object): value is EntityFlagUpdate
```

Check if a given object implements the EntityFlagUpdate interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is EntityFlagUpdate`

***

### instanceOfEnvironment()

```ts
function instanceOfEnvironment(value: object): value is Environment
```

Check if a given object implements the Environment interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is Environment`

***

### instanceOfEnvironmentHeader()

```ts
function instanceOfEnvironmentHeader(value: object): value is EnvironmentHeader
```

Check if a given object implements the EnvironmentHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is EnvironmentHeader`

***

### instanceOfEnvironmentHeaderCollection()

```ts
function instanceOfEnvironmentHeaderCollection(value: object): value is EnvironmentHeaderCollection
```

Check if a given object implements the EnvironmentHeaderCollection interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is EnvironmentHeaderCollection`

***

### instanceOfEnvironmentHeaderSortByColumn()

```ts
function instanceOfEnvironmentHeaderSortByColumn(value: any): boolean
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `value`   | `any` |

#### Returns

`boolean`

***

### instanceOfEnvironmentSdkAccess()

```ts
function instanceOfEnvironmentSdkAccess(value: object): value is EnvironmentSdkAccess
```

Check if a given object implements the EnvironmentSdkAccess interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is EnvironmentSdkAccess`

***

### instanceOfErrorResponse()

```ts
function instanceOfErrorResponse(value: object): value is ErrorResponse
```

Check if a given object implements the ErrorResponse interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is ErrorResponse`

***

### instanceOfErrorResponseError()

```ts
function instanceOfErrorResponseError(value: object): value is ErrorResponseError
```

Check if a given object implements the ErrorResponseError interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is ErrorResponseError`

***

### instanceOfFlagHeader()

```ts
function instanceOfFlagHeader(value: object): value is FlagHeader
```

Check if a given object implements the FlagHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is FlagHeader`

***

### instanceOfFlagHeaderCollection()

```ts
function instanceOfFlagHeaderCollection(value: object): value is FlagHeaderCollection
```

Check if a given object implements the FlagHeaderCollection interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is FlagHeaderCollection`

***

### instanceOfFlagKeyFormat()

```ts
function instanceOfFlagKeyFormat(value: any): boolean
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `value`   | `any` |

#### Returns

`boolean`

***

### instanceOfFlagTargeting()

```ts
function instanceOfFlagTargeting(value: object): value is FlagTargeting
```

Check if a given object implements the FlagTargeting interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is FlagTargeting`

***

### instanceOfFlagValue()

```ts
function instanceOfFlagValue(value: any): boolean
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `value`   | `any` |

#### Returns

`boolean`

***

### instanceOfFlagValueTargeting()

```ts
function instanceOfFlagValueTargeting(value: object): value is FlagValueTargeting
```

Check if a given object implements the FlagValueTargeting interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is FlagValueTargeting`

***

### instanceOfOrgHeader()

```ts
function instanceOfOrgHeader(value: object): value is OrgHeader
```

Check if a given object implements the OrgHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is OrgHeader`

***

### instanceOfReflagUserHeader()

```ts
function instanceOfReflagUserHeader(value: object): value is ReflagUserHeader
```

Check if a given object implements the ReflagUserHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is ReflagUserHeader`

***

### instanceOfSegmentHeader()

```ts
function instanceOfSegmentHeader(value: object): value is SegmentHeader
```

Check if a given object implements the SegmentHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is SegmentHeader`

***

### instanceOfSegmentType()

```ts
function instanceOfSegmentType(value: any): boolean
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `value`   | `any` |

#### Returns

`boolean`

***

### instanceOfSortOrder()

```ts
function instanceOfSortOrder(value: any): boolean
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `value`   | `any` |

#### Returns

`boolean`

***

### instanceOfStageHeader()

```ts
function instanceOfStageHeader(value: object): value is StageHeader
```

Check if a given object implements the StageHeader interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is StageHeader`

***

### instanceOfUpdateEntityFlagsBody()

```ts
function instanceOfUpdateEntityFlagsBody(value: object): value is UpdateEntityFlagsBody
```

Check if a given object implements the UpdateEntityFlagsBody interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is UpdateEntityFlagsBody`

***

### instanceOfUpdateFlagRequest()

```ts
function instanceOfUpdateFlagRequest(value: object): value is UpdateFlagRequest
```

Check if a given object implements the UpdateFlagRequest interface.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `value`   | `object` |

#### Returns

`value is UpdateFlagRequest`

***

### mapValues()

```ts
function mapValues(data: any, fn: (item: any) => any): {}
```

#### Parameters

| Parameter | Type                     |
| --------- | ------------------------ |
| `data`    | `any`                    |
| `fn`      | (`item`: `any`) => `any` |

#### Returns

```ts
{}
```

***

### OrgHeaderFromJSON()

```ts
function OrgHeaderFromJSON(json: any): OrgHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`OrgHeader`](#orgheader)

***

### OrgHeaderFromJSONTyped()

```ts
function OrgHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrgHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`OrgHeader`](#orgheader)

***

### OrgHeaderToJSON()

```ts
function OrgHeaderToJSON(json: any): OrgHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`OrgHeader`](#orgheader)

***

### OrgHeaderToJSONTyped()

```ts
function OrgHeaderToJSONTyped(value?: null | OrgHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                | Default value |
| ---------------------- | ----------------------------------- | ------------- |
| `value`?               | `null` \| [`OrgHeader`](#orgheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                           | `false`       |

#### Returns

`any`

***

### querystring()

```ts
function querystring(params: HTTPQuery, prefix: string): string
```

#### Parameters

| Parameter | Type                      | Default value |
| --------- | ------------------------- | ------------- |
| `params`  | [`HTTPQuery`](#httpquery) | `undefined`   |
| `prefix`  | `string`                  | `''`          |

#### Returns

`string`

***

### ReflagUserHeaderFromJSON()

```ts
function ReflagUserHeaderFromJSON(json: any): ReflagUserHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`ReflagUserHeader`](#reflaguserheader)

***

### ReflagUserHeaderFromJSONTyped()

```ts
function ReflagUserHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReflagUserHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`ReflagUserHeader`](#reflaguserheader)

***

### ReflagUserHeaderToJSON()

```ts
function ReflagUserHeaderToJSON(json: any): ReflagUserHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`ReflagUserHeader`](#reflaguserheader)

***

### ReflagUserHeaderToJSONTyped()

```ts
function ReflagUserHeaderToJSONTyped(value?: null | ReflagUserHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                              | Default value |
| ---------------------- | ------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`ReflagUserHeader`](#reflaguserheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                         | `false`       |

#### Returns

`any`

***

### SegmentHeaderFromJSON()

```ts
function SegmentHeaderFromJSON(json: any): SegmentHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`SegmentHeader`](#segmentheader)

***

### SegmentHeaderFromJSONTyped()

```ts
function SegmentHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`SegmentHeader`](#segmentheader)

***

### SegmentHeaderToJSON()

```ts
function SegmentHeaderToJSON(json: any): SegmentHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`SegmentHeader`](#segmentheader)

***

### SegmentHeaderToJSONTyped()

```ts
function SegmentHeaderToJSONTyped(value?: null | SegmentHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                        | Default value |
| ---------------------- | ------------------------------------------- | ------------- |
| `value`?               | `null` \| [`SegmentHeader`](#segmentheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                   | `false`       |

#### Returns

`any`

***

### SegmentTypeFromJSON()

```ts
function SegmentTypeFromJSON(json: any): SegmentType
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`SegmentType`](#segmenttype)

***

### SegmentTypeFromJSONTyped()

```ts
function SegmentTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentType
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`SegmentType`](#segmenttype)

***

### SegmentTypeToJSON()

```ts
function SegmentTypeToJSON(value?: null | SegmentType): any
```

#### Parameters

| Parameter | Type                                    |
| --------- | --------------------------------------- |
| `value`?  | `null` \| [`SegmentType`](#segmenttype) |

#### Returns

`any`

***

### SegmentTypeToJSONTyped()

```ts
function SegmentTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SegmentType
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `value`               | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`SegmentType`](#segmenttype)

***

### SortOrderFromJSON()

```ts
function SortOrderFromJSON(json: any): SortOrder
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`SortOrder`](#sortorder-3)

***

### SortOrderFromJSONTyped()

```ts
function SortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SortOrder
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`SortOrder`](#sortorder-3)

***

### SortOrderToJSON()

```ts
function SortOrderToJSON(value?: null | SortOrder): any
```

#### Parameters

| Parameter | Type                                  |
| --------- | ------------------------------------- |
| `value`?  | `null` \| [`SortOrder`](#sortorder-3) |

#### Returns

`any`

***

### SortOrderToJSONTyped()

```ts
function SortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): SortOrder
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `value`               | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`SortOrder`](#sortorder-3)

***

### StageHeaderFromJSON()

```ts
function StageHeaderFromJSON(json: any): StageHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`StageHeader`](#stageheader)

***

### StageHeaderFromJSONTyped()

```ts
function StageHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): StageHeader
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`StageHeader`](#stageheader)

***

### StageHeaderToJSON()

```ts
function StageHeaderToJSON(json: any): StageHeader
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`StageHeader`](#stageheader)

***

### StageHeaderToJSONTyped()

```ts
function StageHeaderToJSONTyped(value?: null | StageHeader, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                    | Default value |
| ---------------------- | --------------------------------------- | ------------- |
| `value`?               | `null` \| [`StageHeader`](#stageheader) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                               | `false`       |

#### Returns

`any`

***

### UpdateEntityFlagsBodyFromJSON()

```ts
function UpdateEntityFlagsBodyFromJSON(json: any): UpdateEntityFlagsBody
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`UpdateEntityFlagsBody`](#updateentityflagsbody)

***

### UpdateEntityFlagsBodyFromJSONTyped()

```ts
function UpdateEntityFlagsBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateEntityFlagsBody
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`UpdateEntityFlagsBody`](#updateentityflagsbody)

***

### UpdateEntityFlagsBodyToJSON()

```ts
function UpdateEntityFlagsBodyToJSON(json: any): UpdateEntityFlagsBody
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`UpdateEntityFlagsBody`](#updateentityflagsbody)

***

### UpdateEntityFlagsBodyToJSONTyped()

```ts
function UpdateEntityFlagsBodyToJSONTyped(value?: null | UpdateEntityFlagsBody, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                        | Default value |
| ---------------------- | ----------------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`UpdateEntityFlagsBody`](#updateentityflagsbody) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                                   | `false`       |

#### Returns

`any`

***

### UpdateFlagRequestFromJSON()

```ts
function UpdateFlagRequestFromJSON(json: any): UpdateFlagRequest
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`UpdateFlagRequest`](#updateflagrequest)

***

### UpdateFlagRequestFromJSONTyped()

```ts
function UpdateFlagRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateFlagRequest
```

#### Parameters

| Parameter             | Type      |
| --------------------- | --------- |
| `json`                | `any`     |
| `ignoreDiscriminator` | `boolean` |

#### Returns

[`UpdateFlagRequest`](#updateflagrequest)

***

### UpdateFlagRequestToJSON()

```ts
function UpdateFlagRequestToJSON(json: any): UpdateFlagRequest
```

#### Parameters

| Parameter | Type  |
| --------- | ----- |
| `json`    | `any` |

#### Returns

[`UpdateFlagRequest`](#updateflagrequest)

***

### UpdateFlagRequestToJSONTyped()

```ts
function UpdateFlagRequestToJSONTyped(value?: null | UpdateFlagRequest, ignoreDiscriminator?: boolean): any
```

#### Parameters

| Parameter              | Type                                                | Default value |
| ---------------------- | --------------------------------------------------- | ------------- |
| `value`?               | `null` \| [`UpdateFlagRequest`](#updateflagrequest) | `undefined`   |
| `ignoreDiscriminator`? | `boolean`                                           | `false`       |

#### Returns

`any`