Reference

Classes

Api

DefaultApi - interface

DefaultApiInterface

Extends

• DefaultApi

Constructors

new Api()

new Api(config?: ConfigurationParameters): Api

Parameters

Parameter	Type
config?	ConfigurationParameters

Returns

Api

Overrides

DefaultApi.constructor

Properties

Property	Modifier	Type	Default value
configuration	protected	Configuration	DefaultConfig

Methods

createFlag()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<CreateFlag200Response>

Inherited from

DefaultApi.createFlag

createFlagRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<CreateFlag200Response>>

Inherited from

DefaultApi.createFlagRaw

getApp()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<App>

Inherited from

DefaultApi.getApp

getAppRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<App>>

Inherited from

DefaultApi.getAppRaw

getCompanyFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Inherited from

DefaultApi.getCompanyFlags

getCompanyFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Inherited from

DefaultApi.getCompanyFlagsRaw

getEnvironment()

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

Retrieve details for a specific environment Get environment details

Parameters

Parameter	Type
requestParameters	GetEnvironmentRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<Environment>

Inherited from

DefaultApi.getEnvironment

getEnvironmentRaw()

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

Retrieve details for a specific environment Get environment details

Parameters

Parameter	Type
requestParameters	GetEnvironmentRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Environment>>

Inherited from

DefaultApi.getEnvironmentRaw

getFlagTargeting()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<FlagTargeting>

Inherited from

DefaultApi.getFlagTargeting

getFlagTargetingRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FlagTargeting>>

Inherited from

DefaultApi.getFlagTargetingRaw

getUserFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Inherited from

DefaultApi.getUserFlags

getUserFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Inherited from

DefaultApi.getUserFlagsRaw

isJsonMime()

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.isJsonMime

listApps()

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

Retrieve all accessible applications List of applications

Parameters

Parameter	Type
requestParameters	ListAppsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<AppHeaderCollection>

Inherited from

DefaultApi.listApps

listAppsRaw()

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

Retrieve all accessible applications List of applications

Parameters

Parameter	Type
requestParameters	ListAppsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AppHeaderCollection>>

Inherited from

DefaultApi.listAppsRaw

listEnvironments()

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

Retrieve all environments for a specific application List environments for application

Parameters

Parameter	Type
requestParameters	ListEnvironmentsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EnvironmentHeaderCollection>

Inherited from

DefaultApi.listEnvironments

listEnvironmentsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EnvironmentHeaderCollection>>

Inherited from

DefaultApi.listEnvironmentsRaw

listFlags()

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

Retrieve all flags for a specific application List flags for application

Parameters

Parameter	Type
requestParameters	ListFlagsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<FlagHeaderCollection>

Inherited from

DefaultApi.listFlags

listFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FlagHeaderCollection>>

Inherited from

DefaultApi.listFlagsRaw

request()

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

Parameters

Parameter	Type
context	RequestOpts
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<Response>

Overrides

DefaultApi.request

updateCompanyFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Inherited from

DefaultApi.updateCompanyFlags

updateCompanyFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Inherited from

DefaultApi.updateCompanyFlagsRaw

updateFlag()

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

Update an existing flag Update a flag

Parameters

Parameter	Type
requestParameters	UpdateFlagOperationRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<CreateFlag200Response>

Inherited from

DefaultApi.updateFlag

updateFlagRaw()

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

Update an existing flag Update a flag

Parameters

Parameter	Type
requestParameters	UpdateFlagOperationRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<CreateFlag200Response>>

Inherited from

DefaultApi.updateFlagRaw

updateUserFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Inherited from

DefaultApi.updateUserFlags

updateUserFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Inherited from

DefaultApi.updateUserFlagsRaw

withMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...middlewares	Middleware[]

Returns

T

Inherited from

DefaultApi.withMiddleware

withPostMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...postMiddlewares	( | undefined | (context: ResponseContext) => Promise< | void | Response>)[]

Returns

T

Inherited from

DefaultApi.withPostMiddleware

withPreMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...preMiddlewares	( | undefined | (context: RequestContext) => Promise<void | FetchParams>)[]

Returns

T

Inherited from

DefaultApi.withPreMiddleware

---

BaseAPI

This is the base class for all generated API classes.

Extended by

• DefaultApi

Constructors

new BaseAPI()

new BaseAPI(configuration: Configuration): BaseAPI

Parameters

Parameter	Type	Default value
configuration	Configuration	DefaultConfig

Returns

BaseAPI

Properties

Property	Modifier	Type	Default value
configuration	protected	Configuration	DefaultConfig

Methods

isJsonMime()

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()

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

Parameters

Parameter	Type
context	RequestOpts
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<Response>

withMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...middlewares	Middleware[]

Returns

T

withPostMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...postMiddlewares	( | undefined | (context: ResponseContext) => Promise< | void | Response>)[]

Returns

T

withPreMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...preMiddlewares	( | undefined | (context: RequestContext) => Promise<void | FetchParams>)[]

Returns

T

---

BlobApiResponse

Constructors

new BlobApiResponse()

new BlobApiResponse(raw: Response): BlobApiResponse

Parameters

Parameter	Type
raw	Response

Returns

BlobApiResponse

Properties

Property	Modifier	Type
raw	public	Response

Methods

value()

value(): Promise<Blob>

Returns

Promise<Blob>

---

Configuration

Constructors

new Configuration()

new Configuration(configuration: ConfigurationParameters): Configuration

Parameters

Parameter	Type
configuration	ConfigurationParameters

Returns

Configuration

Accessors

accessToken

Get Signature

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

Returns

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

apiKey

Get Signature

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

Returns

| undefined | (name: string) => | string | Promise<string>

basePath

Get Signature

get basePath(): string

Returns

string

config

Set Signature

set config(configuration: Configuration): void

Parameters

Parameter	Type
configuration	Configuration

Returns

void

credentials

Get Signature

get credentials(): undefined | RequestCredentials

Returns

undefined | RequestCredentials

fetchApi

Get Signature

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

Returns

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

headers

Get Signature

get headers(): undefined | HTTPHeaders

Returns

undefined | HTTPHeaders

middleware

Get Signature

get middleware(): Middleware[]

Returns

Middleware[]

password

Get Signature

get password(): undefined | string

Returns

undefined | string

queryParamsStringify

Get Signature

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

Returns

Function

Parameters

Parameter	Type
params	HTTPQuery

Returns

string

username

Get Signature

get username(): undefined | string

Returns

undefined | string

---

DefaultApi

DefaultApi - interface

DefaultApiInterface

Extends

• BaseAPI

Extended by

• Api

Implements

• DefaultApiInterface

Constructors

new DefaultApi()

new DefaultApi(configuration: Configuration): DefaultApi

Parameters

Parameter	Type	Default value
configuration	Configuration	DefaultConfig

Returns

DefaultApi

Inherited from

BaseAPI.constructor

Properties

Property	Modifier	Type	Default value
configuration	protected	Configuration	DefaultConfig

Methods

createFlag()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<CreateFlag200Response>

Implementation of

DefaultApiInterface.createFlag

createFlagRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<CreateFlag200Response>>

Implementation of

DefaultApiInterface.createFlagRaw

getApp()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<App>

Implementation of

DefaultApiInterface.getApp

getAppRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<App>>

Implementation of

DefaultApiInterface.getAppRaw

getCompanyFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Implementation of

DefaultApiInterface.getCompanyFlags

getCompanyFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Implementation of

DefaultApiInterface.getCompanyFlagsRaw

getEnvironment()

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

Retrieve details for a specific environment Get environment details

Parameters

Parameter	Type
requestParameters	GetEnvironmentRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<Environment>

Implementation of

DefaultApiInterface.getEnvironment

getEnvironmentRaw()

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

Retrieve details for a specific environment Get environment details

Parameters

Parameter	Type
requestParameters	GetEnvironmentRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Environment>>

Implementation of

DefaultApiInterface.getEnvironmentRaw

getFlagTargeting()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<FlagTargeting>

Implementation of

DefaultApiInterface.getFlagTargeting

getFlagTargetingRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FlagTargeting>>

Implementation of

DefaultApiInterface.getFlagTargetingRaw

getUserFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Implementation of

DefaultApiInterface.getUserFlags

getUserFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Implementation of

DefaultApiInterface.getUserFlagsRaw

isJsonMime()

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.isJsonMime

listApps()

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

Retrieve all accessible applications List of applications

Parameters

Parameter	Type
requestParameters	ListAppsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<AppHeaderCollection>

Implementation of

DefaultApiInterface.listApps

listAppsRaw()

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

Retrieve all accessible applications List of applications

Parameters

Parameter	Type
requestParameters	ListAppsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AppHeaderCollection>>

Implementation of

DefaultApiInterface.listAppsRaw

listEnvironments()

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

Retrieve all environments for a specific application List environments for application

Parameters

Parameter	Type
requestParameters	ListEnvironmentsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EnvironmentHeaderCollection>

Implementation of

DefaultApiInterface.listEnvironments

listEnvironmentsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EnvironmentHeaderCollection>>

Implementation of

DefaultApiInterface.listEnvironmentsRaw

listFlags()

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

Retrieve all flags for a specific application List flags for application

Parameters

Parameter	Type
requestParameters	ListFlagsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<FlagHeaderCollection>

Implementation of

DefaultApiInterface.listFlags

listFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FlagHeaderCollection>>

Implementation of

DefaultApiInterface.listFlagsRaw

request()

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

Parameters

Parameter	Type
context	RequestOpts
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<Response>

Inherited from

BaseAPI.request

updateCompanyFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Implementation of

DefaultApiInterface.updateCompanyFlags

updateCompanyFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Implementation of

DefaultApiInterface.updateCompanyFlagsRaw

updateFlag()

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

Update an existing flag Update a flag

Parameters

Parameter	Type
requestParameters	UpdateFlagOperationRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<CreateFlag200Response>

Implementation of

DefaultApiInterface.updateFlag

updateFlagRaw()

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

Update an existing flag Update a flag

Parameters

Parameter	Type
requestParameters	UpdateFlagOperationRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<CreateFlag200Response>>

Implementation of

DefaultApiInterface.updateFlagRaw

updateUserFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

Implementation of

DefaultApiInterface.updateUserFlags

updateUserFlagsRaw()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Implementation of

DefaultApiInterface.updateUserFlagsRaw

withMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...middlewares	Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware

withPostMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...postMiddlewares	( | undefined | (context: ResponseContext) => Promise< | void | Response>)[]

Returns

T

Inherited from

BaseAPI.withPostMiddleware

withPreMiddleware()

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

Type Parameters

Type Parameter
T extends BaseAPI

Parameters

Parameter	Type
this	T
...preMiddlewares	( | undefined | (context: RequestContext) => Promise<void | FetchParams>)[]

Returns

T

Inherited from

BaseAPI.withPreMiddleware

---

FetchError

Extends

• Error

Constructors

new FetchError()

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

Parameters

Parameter	Type
cause	Error
msg?	string

Returns

FetchError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides
cause	public	Error	undefined	‐	‐
message	public	string	undefined	‐	‐
name	public	"FetchError"	"FetchError"	‐	Error.name
stack?	public	string	undefined	‐	‐
prepareStackTrace?	static	(err: Error, stackTraces: CallSite[]) => any	undefined	Optional override for formatting stack traces See https://v8.dev/docs/stack-trace-api#customizing-stack-traces	‐
stackTraceLimit	static	number	undefined	‐	‐

Methods

captureStackTrace()

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

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

JSONApiResponse<T>

Type Parameters

Type Parameter
T

Constructors

new JSONApiResponse()

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

Parameters

Parameter	Type
raw	Response
transformer	ResponseTransformer<T>

Returns

JSONApiResponse<T>

Properties

Property	Modifier	Type
raw	public	Response

Methods

value()

value(): Promise<T>

Returns

Promise<T>

---

ReflagApiError

Extends

• Error

Constructors

new ReflagApiError()

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

Parameters

Parameter	Type
status	number
message	string
code?	string
details?	unknown

Returns

ReflagApiError

Overrides

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, stackTraces: CallSite[]) => any	Optional override for formatting stack traces See https://v8.dev/docs/stack-trace-api#customizing-stack-traces
stackTraceLimit	static	number	‐

Methods

captureStackTrace()

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

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

RequiredError

Extends

• Error

Constructors

new RequiredError()

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

Parameters

Parameter	Type
field	string
msg?	string

Returns

RequiredError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides
field	public	string	undefined	‐	‐
message	public	string	undefined	‐	‐
name	public	"RequiredError"	"RequiredError"	‐	Error.name
stack?	public	string	undefined	‐	‐
prepareStackTrace?	static	(err: Error, stackTraces: CallSite[]) => any	undefined	Optional override for formatting stack traces See https://v8.dev/docs/stack-trace-api#customizing-stack-traces	‐
stackTraceLimit	static	number	undefined	‐	‐

Methods

captureStackTrace()

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

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

ResponseError

Extends

• Error

Constructors

new ResponseError()

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

Parameters

Parameter	Type
response	Response
msg?	string

Returns

ResponseError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides
message	public	string	undefined	‐	‐
name	public	"ResponseError"	"ResponseError"	‐	Error.name
response	public	Response	undefined	‐	‐
stack?	public	string	undefined	‐	‐
prepareStackTrace?	static	(err: Error, stackTraces: CallSite[]) => any	undefined	Optional override for formatting stack traces See https://v8.dev/docs/stack-trace-api#customizing-stack-traces	‐
stackTraceLimit	static	number	undefined	‐	‐

Methods

captureStackTrace()

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

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

TextApiResponse

Constructors

new TextApiResponse()

new TextApiResponse(raw: Response): TextApiResponse

Parameters

Parameter	Type
raw	Response

Returns

TextApiResponse

Properties

Property	Modifier	Type
raw	public	Response

Methods

value()

value(): Promise<string>

Returns

Promise<string>

---

VoidApiResponse

Constructors

new VoidApiResponse()

new VoidApiResponse(raw: Response): VoidApiResponse

Parameters

Parameter	Type
raw	Response

Returns

VoidApiResponse

Properties

Property	Modifier	Type
raw	public	Response

Methods

value()

value(): Promise<void>

Returns

Promise<void>

Interfaces

ApiResponse<T>

Type Parameters

Type Parameter
T

Properties

Property	Type
raw	Response

Methods

value()

value(): Promise<T>

Returns

Promise<T>

---

App

App information with related collections App

Properties

Property	Type	Description
demo	boolean	Whether the app is a demo app
environments	Environment[]	Environments within the app
flagKeyFormat	FlagKeyFormat	‐
id	string	App identifier
name	string	App name
org	OrgHeader	‐
segments	SegmentHeader[]	Segments within the app
stages	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[]	Environments within the app
flagKeyFormat	FlagKeyFormat	‐
id	string	App identifier
name	string	App name
org	OrgHeader	‐

---

AppHeaderCollection

Collection of Basic app information AppHeaderCollection

Properties

Property	Type	Description
data	AppHeader[]	The individual items in the collection

---

ConfigurationParameters

Properties

Property	Type
accessToken?	| string | Promise<string> | (name?: string, scopes?: string[]) => | string | Promise<string>
apiKey?	| string | Promise<string> | (name: string) => | string | Promise<string>
basePath?	string
credentials?	RequestCredentials
fetchApi?	(input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
headers?	HTTPHeaders
middleware?	Middleware[]
password?	string
queryParamsStringify?	(params: HTTPQuery) => string
username?	string

---

Consume

Properties

Property	Type
contentType	string

---

CreateFlag200Response

CreateFlag200Response

Properties

Property	Type
flag	CreateFlag200ResponseFlag

---

CreateFlag200ResponseFlag

CreateFlag200ResponseFlag

Properties

Property	Type	Description
archived	boolean	Whether the flag is archived
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
owner?	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	‐
stale	boolean	Whether the flag is stale

---

CreateFlagOperationRequest

CreateFlagRequest

Extends

• 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

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()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<CreateFlag200Response>

createFlagRaw()

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	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<CreateFlag200Response>>

Throws

getApp()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<App>

getAppRaw()

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

Retrieve a specific application by its identifier

Parameters

Parameter	Type	Description
requestParameters	GetAppRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<App>>

Throws

getCompanyFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

getCompanyFlagsRaw()

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	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Throws

getEnvironment()

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

Retrieve details for a specific environment Get environment details

Parameters

Parameter	Type
requestParameters	GetEnvironmentRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<Environment>

getEnvironmentRaw()

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

Retrieve details for a specific environment

Parameters

Parameter	Type	Description
requestParameters	GetEnvironmentRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<Environment>>

Throws

getFlagTargeting()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<FlagTargeting>

getFlagTargetingRaw()

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

Retrieve targeting for a flag in an environment

Parameters

Parameter	Type	Description
requestParameters	GetFlagTargetingRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<FlagTargeting>>

Throws

getUserFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

getUserFlagsRaw()

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	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Throws

listApps()

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

Retrieve all accessible applications List of applications

Parameters

Parameter	Type
requestParameters	ListAppsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<AppHeaderCollection>

listAppsRaw()

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

Retrieve all accessible applications

Parameters

Parameter	Type	Description
requestParameters	ListAppsRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<AppHeaderCollection>>

Throws

listEnvironments()

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

Retrieve all environments for a specific application List environments for application

Parameters

Parameter	Type
requestParameters	ListEnvironmentsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EnvironmentHeaderCollection>

listEnvironmentsRaw()

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

Retrieve all environments for a specific application

Parameters

Parameter	Type	Description
requestParameters	ListEnvironmentsRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<EnvironmentHeaderCollection>>

Throws

listFlags()

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

Retrieve all flags for a specific application List flags for application

Parameters

Parameter	Type
requestParameters	ListFlagsRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<FlagHeaderCollection>

listFlagsRaw()

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

Retrieve all flags for a specific application

Parameters

Parameter	Type	Description
requestParameters	ListFlagsRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<FlagHeaderCollection>>

Throws

updateCompanyFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

updateCompanyFlagsRaw()

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	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<EntityFlagsResponse>>

Throws

updateFlag()

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

Update an existing flag Update a flag

Parameters

Parameter	Type
requestParameters	UpdateFlagOperationRequest
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<CreateFlag200Response>

updateFlagRaw()

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

Update an existing flag

Parameters

Parameter	Type	Description
requestParameters	UpdateFlagOperationRequest	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<CreateFlag200Response>>

Throws

updateUserFlags()

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
initOverrides?	RequestInit | InitOverrideFunction

Returns

Promise<EntityFlagsResponse>

updateUserFlagsRaw()

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	Request parameters for this operation.
initOverrides?	RequestInit | InitOverrideFunction	‐

Returns

Promise<ApiResponse<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[]	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
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	‐

---

EnvironmentHeader

Basic environment information EnvironmentHeader

Properties

Property	Type	Description
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[]	The individual items in the collection
sortBy	EnvironmentHeaderSortByColumn	‐
sortOrder	SortOrder	‐

---

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, init?: RequestInit) => Promise<Response>
init	RequestInit
response?	Response
url	string

---

ErrorResponse

The error response, including individual issues, if applicable ErrorResponse

Properties

Property	Type	Description
error	ErrorResponseError	‐
issues?	{}	Individual validation issues, if applicable

---

ErrorResponseError

The error ErrorResponseError

Properties

Property	Type	Description
code	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
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
owner?	ReflagUserHeader	‐
permanent	boolean	Whether the flag is permanent
stage?	StageHeader	‐
stale	boolean	Whether the flag is stale

---

FlagHeaderCollection

Collection response containing flags FlagHeaderCollection

Properties

Property	Type	Description
data	FlagHeader[]	Page of the collection of flags
pageIndex	number	Page index
pageSize	number	Page size
sortBy	FlagHeaderCollectionSortByEnum	Sort by
sortOrder	SortOrder	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	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
sortOrder?	SortOrder

---

ListFlagsRequest

Properties

Property	Type
appId	string

---

Middleware

Methods

onError()?

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

Parameters

Parameter	Type
context	ErrorContext

Returns

Promise< | void | Response>

post()?

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

Parameters

Parameter	Type
context	ResponseContext

Returns

Promise< | void | Response>

pre()?

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

Parameters

Parameter	Type
context	RequestContext

Returns

Promise<void | 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, init?: RequestInit) => Promise<Response>
init	RequestInit
url	string

---

RequestOpts

Properties

Property	Type
body?	any
headers	HTTPHeaders
method	HTTPMethod
path	string
query?	HTTPQuery

---

ResponseContext

Properties

Property	Type
fetch	(input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
init	RequestInit
response	Response
url	string

---

ResponseTransformer()<T>

Type Parameters

Type Parameter
T

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	‐

---

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

Properties

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

---

UpdateEntityFlagsBody

Request body for updating flags for an entity UpdateEntityFlagsBody

Extended by

• UpdateCompanyFlagsRequest

• UpdateUserFlagsRequest

Properties

Property	Type	Description
changeDescription?	string	Description of the change for audit history
notifications?	UpdateEntityFlagsBodyNotificationsEnum[]	Destination list for notifications about the change. Use [] to disable notifications. Omit to use configured defaults.
updates	EntityFlagUpdate[]	List of flag updates to apply

---

UpdateFlagOperationRequest

UpdateFlagRequest

Extends

• 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

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

Properties

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

Type Aliases

AppScopedApi<T>

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

Type Parameters

Type Parameter
T

---

EntityFlagUpdateSpecificTargetValueEnum

type EntityFlagUpdateSpecificTargetValueEnum = typeof EntityFlagUpdateSpecificTargetValueEnum[keyof typeof EntityFlagUpdateSpecificTargetValueEnum];

---

EnvironmentHeaderSortByColumn

type EnvironmentHeaderSortByColumn = typeof EnvironmentHeaderSortByColumn[keyof typeof EnvironmentHeaderSortByColumn];

---

ErrorResponseErrorCodeEnum

type ErrorResponseErrorCodeEnum = typeof ErrorResponseErrorCodeEnum[keyof typeof ErrorResponseErrorCodeEnum];

---

FetchAPI

type FetchAPI = WindowOrWorkerGlobalScope["fetch"];

---

FlagHeaderCollectionSortByEnum

type FlagHeaderCollectionSortByEnum = typeof FlagHeaderCollectionSortByEnum[keyof typeof FlagHeaderCollectionSortByEnum];

---

FlagKeyFormat

type FlagKeyFormat = typeof FlagKeyFormat[keyof typeof FlagKeyFormat];

---

FlagValue

type FlagValue = typeof FlagValue[keyof typeof FlagValue];

---

HTTPBody

type HTTPBody = 
  | Json
  | FormData
  | URLSearchParams;

---

HTTPHeaders

type HTTPHeaders = {};

Index Signature

[key: string]: string

---

HTTPMethod

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

---

HTTPQuery

type HTTPQuery = {};

Index Signature

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

---

HTTPRequestInit

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

Type declaration

Name	Type
body?	HTTPBody
credentials?	RequestCredentials
headers?	HTTPHeaders
method	HTTPMethod

---

InitOverrideFunction()

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

Parameters

Parameter	Type
requestContext	{ context: RequestOpts; init: HTTPRequestInit; }
requestContext.context	RequestOpts
requestContext.init	HTTPRequestInit

Returns

Promise<RequestInit>

---

Json

type Json = any;

---

ModelPropertyNaming

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

---

OmitAppIdParam<F>

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

type SegmentType = typeof SegmentType[keyof typeof SegmentType];

---

SortOrder

type SortOrder = typeof SortOrder[keyof typeof SortOrder];

---

UpdateEntityFlagsBodyNotificationsEnum

type UpdateEntityFlagsBodyNotificationsEnum = typeof UpdateEntityFlagsBodyNotificationsEnum[keyof typeof UpdateEntityFlagsBodyNotificationsEnum];

Variables

BASE_PATH

const BASE_PATH: string;

Reflag 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

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

const DefaultConfig: Configuration;

---

EntityFlagUpdateSpecificTargetValueEnum

const EntityFlagUpdateSpecificTargetValueEnum: {
  True: true;
};

Type declaration

Name	Type	Default value
True	true	true

---

EnvironmentHeaderSortByColumn

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

The column to sort by

Type declaration

Name	Type	Default value
Name	"name"	'name'
Order	"order"	'order'

---

ErrorResponseErrorCodeEnum

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

const FlagHeaderCollectionSortByEnum: {
  ArchivingChecks: "archivingChecks";
  AutoFeedbackSurveysEnabled: "autoFeedbackSurveysEnabled";
  CreatedAt: "createdAt";
  EnvironmentStatus: "environmentStatus";
  Key: "key";
  LastCheck: "lastCheck";
  LastTrack: "lastTrack";
  Name: "name";
  Owner: "owner";
  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'
Stage	"stage"	'stage'
Stale	"stale"	'stale'

---

FlagKeyFormat

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

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

The value of the flag served to the audience.

Type declaration

Name	Type	Default value
True	"true"	'true'

---

SegmentType

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

Segment type

Type declaration

Name	Type	Default value
All	"all"	'all'
Custom	"custom"	'custom'

---

SortOrder

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

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

Type declaration

Name	Type	Default value
LinearComment	"linearComment"	'linearComment'
Slack	"slack"	'slack'

Functions

AppFromJSON()

function AppFromJSON(json: any): App

Parameters

Parameter	Type
json	any

Returns

App

---

AppFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

App

---

AppHeaderCollectionFromJSON()

function AppHeaderCollectionFromJSON(json: any): AppHeaderCollection

Parameters

Parameter	Type
json	any

Returns

AppHeaderCollection

---

AppHeaderCollectionFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

AppHeaderCollection

---

AppHeaderCollectionToJSON()

function AppHeaderCollectionToJSON(json: any): AppHeaderCollection

Parameters

Parameter	Type
json	any

Returns

AppHeaderCollection

---

AppHeaderCollectionToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | AppHeaderCollection	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

AppHeaderFromJSON()

function AppHeaderFromJSON(json: any): AppHeader

Parameters

Parameter	Type
json	any

Returns

AppHeader

---

AppHeaderFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

AppHeader

---

AppHeaderToJSON()

function AppHeaderToJSON(json: any): AppHeader

Parameters

Parameter	Type
json	any

Returns

AppHeader

---

AppHeaderToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | AppHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

AppToJSON()

function AppToJSON(json: any): App

Parameters

Parameter	Type
json	any

Returns

App

---

AppToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | App	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

canConsumeForm()

function canConsumeForm(consumes: Consume[]): boolean

Parameters

Parameter	Type
consumes	Consume[]

Returns

boolean

---

createAppClient()

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

Parameters

Parameter	Type
appId	string
config?	ConfigurationParameters

Returns

AppScopedApi<Api>

---

CreateFlag200ResponseFlagFromJSON()

function CreateFlag200ResponseFlagFromJSON(json: any): CreateFlag200ResponseFlag

Parameters

Parameter	Type
json	any

Returns

CreateFlag200ResponseFlag

---

CreateFlag200ResponseFlagFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

CreateFlag200ResponseFlag

---

CreateFlag200ResponseFlagToJSON()

function CreateFlag200ResponseFlagToJSON(json: any): CreateFlag200ResponseFlag

Parameters

Parameter	Type
json	any

Returns

CreateFlag200ResponseFlag

---

CreateFlag200ResponseFlagToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	| null | CreateFlag200ResponseFlag	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

CreateFlag200ResponseFromJSON()

function CreateFlag200ResponseFromJSON(json: any): CreateFlag200Response

Parameters

Parameter	Type
json	any

Returns

CreateFlag200Response

---

CreateFlag200ResponseFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

CreateFlag200Response

---

CreateFlag200ResponseToJSON()

function CreateFlag200ResponseToJSON(json: any): CreateFlag200Response

Parameters

Parameter	Type
json	any

Returns

CreateFlag200Response

---

CreateFlag200ResponseToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | CreateFlag200Response	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

CreateFlagRequestFromJSON()

function CreateFlagRequestFromJSON(json: any): CreateFlagRequest

Parameters

Parameter	Type
json	any

Returns

CreateFlagRequest

---

CreateFlagRequestFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

CreateFlagRequest

---

CreateFlagRequestToJSON()

function CreateFlagRequestToJSON(json: any): CreateFlagRequest

Parameters

Parameter	Type
json	any

Returns

CreateFlagRequest

---

CreateFlagRequestToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | CreateFlagRequest	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EntityFlagFromJSON()

function EntityFlagFromJSON(json: any): EntityFlag

Parameters

Parameter	Type
json	any

Returns

EntityFlag

---

EntityFlagFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EntityFlag

---

EntityFlagsResponseFromJSON()

function EntityFlagsResponseFromJSON(json: any): EntityFlagsResponse

Parameters

Parameter	Type
json	any

Returns

EntityFlagsResponse

---

EntityFlagsResponseFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EntityFlagsResponse

---

EntityFlagsResponseToJSON()

function EntityFlagsResponseToJSON(json: any): EntityFlagsResponse

Parameters

Parameter	Type
json	any

Returns

EntityFlagsResponse

---

EntityFlagsResponseToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | EntityFlagsResponse	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EntityFlagToJSON()

function EntityFlagToJSON(json: any): EntityFlag

Parameters

Parameter	Type
json	any

Returns

EntityFlag

---

EntityFlagToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | EntityFlag	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EntityFlagUpdateFromJSON()

function EntityFlagUpdateFromJSON(json: any): EntityFlagUpdate

Parameters

Parameter	Type
json	any

Returns

EntityFlagUpdate

---

EntityFlagUpdateFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EntityFlagUpdate

---

EntityFlagUpdateToJSON()

function EntityFlagUpdateToJSON(json: any): EntityFlagUpdate

Parameters

Parameter	Type
json	any

Returns

EntityFlagUpdate

---

EntityFlagUpdateToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | EntityFlagUpdate	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EnvironmentFromJSON()

function EnvironmentFromJSON(json: any): Environment

Parameters

Parameter	Type
json	any

Returns

Environment

---

EnvironmentFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

Environment

---

EnvironmentHeaderCollectionFromJSON()

function EnvironmentHeaderCollectionFromJSON(json: any): EnvironmentHeaderCollection

Parameters

Parameter	Type
json	any

Returns

EnvironmentHeaderCollection

---

EnvironmentHeaderCollectionFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EnvironmentHeaderCollection

---

EnvironmentHeaderCollectionToJSON()

function EnvironmentHeaderCollectionToJSON(json: any): EnvironmentHeaderCollection

Parameters

Parameter	Type
json	any

Returns

EnvironmentHeaderCollection

---

EnvironmentHeaderCollectionToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	| null | EnvironmentHeaderCollection	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EnvironmentHeaderFromJSON()

function EnvironmentHeaderFromJSON(json: any): EnvironmentHeader

Parameters

Parameter	Type
json	any

Returns

EnvironmentHeader

---

EnvironmentHeaderFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EnvironmentHeader

---

EnvironmentHeaderSortByColumnFromJSON()

function EnvironmentHeaderSortByColumnFromJSON(json: any): EnvironmentHeaderSortByColumn

Parameters

Parameter	Type
json	any

Returns

EnvironmentHeaderSortByColumn

---

EnvironmentHeaderSortByColumnFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EnvironmentHeaderSortByColumn

---

EnvironmentHeaderSortByColumnToJSON()

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

Parameters

Parameter	Type
value?	| null | EnvironmentHeaderSortByColumn

Returns

any

---

EnvironmentHeaderSortByColumnToJSONTyped()

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

Parameters

Parameter	Type
value	any
ignoreDiscriminator	boolean

Returns

EnvironmentHeaderSortByColumn

---

EnvironmentHeaderToJSON()

function EnvironmentHeaderToJSON(json: any): EnvironmentHeader

Parameters

Parameter	Type
json	any

Returns

EnvironmentHeader

---

EnvironmentHeaderToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | EnvironmentHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EnvironmentSdkAccessFromJSON()

function EnvironmentSdkAccessFromJSON(json: any): EnvironmentSdkAccess

Parameters

Parameter	Type
json	any

Returns

EnvironmentSdkAccess

---

EnvironmentSdkAccessFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

EnvironmentSdkAccess

---

EnvironmentSdkAccessToJSON()

function EnvironmentSdkAccessToJSON(json: any): EnvironmentSdkAccess

Parameters

Parameter	Type
json	any

Returns

EnvironmentSdkAccess

---

EnvironmentSdkAccessToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | EnvironmentSdkAccess	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

EnvironmentToJSON()

function EnvironmentToJSON(json: any): Environment

Parameters

Parameter	Type
json	any

Returns

Environment

---

EnvironmentToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | Environment	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

ErrorResponseErrorFromJSON()

function ErrorResponseErrorFromJSON(json: any): ErrorResponseError

Parameters

Parameter	Type
json	any

Returns

ErrorResponseError

---

ErrorResponseErrorFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

ErrorResponseError

---

ErrorResponseErrorToJSON()

function ErrorResponseErrorToJSON(json: any): ErrorResponseError

Parameters

Parameter	Type
json	any

Returns

ErrorResponseError

---

ErrorResponseErrorToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | ErrorResponseError	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

ErrorResponseFromJSON()

function ErrorResponseFromJSON(json: any): ErrorResponse

Parameters

Parameter	Type
json	any

Returns

ErrorResponse

---

ErrorResponseFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

ErrorResponse

---

ErrorResponseToJSON()

function ErrorResponseToJSON(json: any): ErrorResponse

Parameters

Parameter	Type
json	any

Returns

ErrorResponse

---

ErrorResponseToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | ErrorResponse	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

exists()

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

Parameters

Parameter	Type
json	any
key	string

Returns

boolean

---

FlagHeaderCollectionFromJSON()

function FlagHeaderCollectionFromJSON(json: any): FlagHeaderCollection

Parameters

Parameter	Type
json	any

Returns

FlagHeaderCollection

---

FlagHeaderCollectionFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

FlagHeaderCollection

---

FlagHeaderCollectionToJSON()

function FlagHeaderCollectionToJSON(json: any): FlagHeaderCollection

Parameters

Parameter	Type
json	any

Returns

FlagHeaderCollection

---

FlagHeaderCollectionToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | FlagHeaderCollection	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

FlagHeaderFromJSON()

function FlagHeaderFromJSON(json: any): FlagHeader

Parameters

Parameter	Type
json	any

Returns

FlagHeader

---

FlagHeaderFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

FlagHeader

---

FlagHeaderToJSON()

function FlagHeaderToJSON(json: any): FlagHeader

Parameters

Parameter	Type
json	any

Returns

FlagHeader

---

FlagHeaderToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | FlagHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

FlagKeyFormatFromJSON()

function FlagKeyFormatFromJSON(json: any): FlagKeyFormat

Parameters

Parameter	Type
json	any

Returns

FlagKeyFormat

---

FlagKeyFormatFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

FlagKeyFormat

---

FlagKeyFormatToJSON()

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

Parameters

Parameter	Type
value?	null | FlagKeyFormat

Returns

any

---

FlagKeyFormatToJSONTyped()

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

Parameters

Parameter	Type
value	any
ignoreDiscriminator	boolean

Returns

FlagKeyFormat

---

FlagTargetingFromJSON()

function FlagTargetingFromJSON(json: any): FlagTargeting

Parameters

Parameter	Type
json	any

Returns

FlagTargeting

---

FlagTargetingFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

FlagTargeting

---

FlagTargetingToJSON()

function FlagTargetingToJSON(json: any): FlagTargeting

Parameters

Parameter	Type
json	any

Returns

FlagTargeting

---

FlagTargetingToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | FlagTargeting	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

FlagValueFromJSON()

function FlagValueFromJSON(json: any): FlagValue

Parameters

Parameter	Type
json	any

Returns

FlagValue

---

FlagValueFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

FlagValue

---

FlagValueTargetingFromJSON()

function FlagValueTargetingFromJSON(json: any): FlagValueTargeting

Parameters

Parameter	Type
json	any

Returns

FlagValueTargeting

---

FlagValueTargetingFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

FlagValueTargeting

---

FlagValueTargetingToJSON()

function FlagValueTargetingToJSON(json: any): FlagValueTargeting

Parameters

Parameter	Type
json	any

Returns

FlagValueTargeting

---

FlagValueTargetingToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | FlagValueTargeting	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

FlagValueToJSON()

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

Parameters

Parameter	Type
value?	null | "true"

Returns

any

---

FlagValueToJSONTyped()

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

Parameters

Parameter	Type
value	any
ignoreDiscriminator	boolean

Returns

FlagValue

---

instanceOfApp()

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()

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()

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()

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()

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()

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()

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()

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()

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()

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()

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()

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()

function instanceOfEnvironmentHeaderSortByColumn(value: any): boolean

Parameters

Parameter	Type
value	any

Returns

boolean

---

instanceOfEnvironmentSdkAccess()

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()

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()

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()

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()

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()

function instanceOfFlagKeyFormat(value: any): boolean

Parameters

Parameter	Type
value	any

Returns

boolean

---

instanceOfFlagTargeting()

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()

function instanceOfFlagValue(value: any): boolean

Parameters

Parameter	Type
value	any

Returns

boolean

---

instanceOfFlagValueTargeting()

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()

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()

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()

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()

function instanceOfSegmentType(value: any): boolean

Parameters

Parameter	Type
value	any

Returns

boolean

---

instanceOfSortOrder()

function instanceOfSortOrder(value: any): boolean

Parameters

Parameter	Type
value	any

Returns

boolean

---

instanceOfStageHeader()

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()

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()

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()

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

Parameters

Parameter	Type
data	any
fn	(item: any) => any

Returns

{}

---

OrgHeaderFromJSON()

function OrgHeaderFromJSON(json: any): OrgHeader

Parameters

Parameter	Type
json	any

Returns

OrgHeader

---

OrgHeaderFromJSONTyped()

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

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

OrgHeader

---

OrgHeaderToJSON()

function OrgHeaderToJSON(json: any): OrgHeader

Parameters

Parameter	Type
json	any

Returns

OrgHeader

---

OrgHeaderToJSONTyped()

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

Parameters

Parameter	Type	Default value
value?	null | OrgHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

querystring()

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

Parameters

Parameter	Type	Default value
params	HTTPQuery	undefined
prefix	string	''

Returns

string

---

ReflagUserHeaderFromJSON()

function ReflagUserHeaderFromJSON(json: any): ReflagUserHeader

Parameters

Parameter	Type
json	any

Returns

ReflagUserHeader

---

ReflagUserHeaderFromJSONTyped()

function ReflagUserHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReflagUserHeader

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

ReflagUserHeader

---

ReflagUserHeaderToJSON()

function ReflagUserHeaderToJSON(json: any): ReflagUserHeader

Parameters

Parameter	Type
json	any

Returns

ReflagUserHeader

---

ReflagUserHeaderToJSONTyped()

function ReflagUserHeaderToJSONTyped(value?: null | ReflagUserHeader, ignoreDiscriminator?: boolean): any

Parameters

Parameter	Type	Default value
value?	null | ReflagUserHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

SegmentHeaderFromJSON()

function SegmentHeaderFromJSON(json: any): SegmentHeader

Parameters

Parameter	Type
json	any

Returns

SegmentHeader

---

SegmentHeaderFromJSONTyped()

function SegmentHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentHeader

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

SegmentHeader

---

SegmentHeaderToJSON()

function SegmentHeaderToJSON(json: any): SegmentHeader

Parameters

Parameter	Type
json	any

Returns

SegmentHeader

---

SegmentHeaderToJSONTyped()

function SegmentHeaderToJSONTyped(value?: null | SegmentHeader, ignoreDiscriminator?: boolean): any

Parameters

Parameter	Type	Default value
value?	null | SegmentHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

SegmentTypeFromJSON()

function SegmentTypeFromJSON(json: any): SegmentType

Parameters

Parameter	Type
json	any

Returns

SegmentType

---

SegmentTypeFromJSONTyped()

function SegmentTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentType

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

SegmentType

---

SegmentTypeToJSON()

function SegmentTypeToJSON(value?: null | SegmentType): any

Parameters

Parameter	Type
value?	null | SegmentType

Returns

any

---

SegmentTypeToJSONTyped()

function SegmentTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SegmentType

Parameters

Parameter	Type
value	any
ignoreDiscriminator	boolean

Returns

SegmentType

---

SortOrderFromJSON()

function SortOrderFromJSON(json: any): SortOrder

Parameters

Parameter	Type
json	any

Returns

SortOrder

---

SortOrderFromJSONTyped()

function SortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SortOrder

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

SortOrder

---

SortOrderToJSON()

function SortOrderToJSON(value?: null | SortOrder): any

Parameters

Parameter	Type
value?	null | SortOrder

Returns

any

---

SortOrderToJSONTyped()

function SortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): SortOrder

Parameters

Parameter	Type
value	any
ignoreDiscriminator	boolean

Returns

SortOrder

---

StageHeaderFromJSON()

function StageHeaderFromJSON(json: any): StageHeader

Parameters

Parameter	Type
json	any

Returns

StageHeader

---

StageHeaderFromJSONTyped()

function StageHeaderFromJSONTyped(json: any, ignoreDiscriminator: boolean): StageHeader

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

StageHeader

---

StageHeaderToJSON()

function StageHeaderToJSON(json: any): StageHeader

Parameters

Parameter	Type
json	any

Returns

StageHeader

---

StageHeaderToJSONTyped()

function StageHeaderToJSONTyped(value?: null | StageHeader, ignoreDiscriminator?: boolean): any

Parameters

Parameter	Type	Default value
value?	null | StageHeader	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

UpdateEntityFlagsBodyFromJSON()

function UpdateEntityFlagsBodyFromJSON(json: any): UpdateEntityFlagsBody

Parameters

Parameter	Type
json	any

Returns

UpdateEntityFlagsBody

---

UpdateEntityFlagsBodyFromJSONTyped()

function UpdateEntityFlagsBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateEntityFlagsBody

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

UpdateEntityFlagsBody

---

UpdateEntityFlagsBodyToJSON()

function UpdateEntityFlagsBodyToJSON(json: any): UpdateEntityFlagsBody

Parameters

Parameter	Type
json	any

Returns

UpdateEntityFlagsBody

---

UpdateEntityFlagsBodyToJSONTyped()

function UpdateEntityFlagsBodyToJSONTyped(value?: null | UpdateEntityFlagsBody, ignoreDiscriminator?: boolean): any

Parameters

Parameter	Type	Default value
value?	null | UpdateEntityFlagsBody	undefined
ignoreDiscriminator?	boolean	false

Returns

any

---

UpdateFlagRequestFromJSON()

function UpdateFlagRequestFromJSON(json: any): UpdateFlagRequest

Parameters

Parameter	Type
json	any

Returns

UpdateFlagRequest

---

UpdateFlagRequestFromJSONTyped()

function UpdateFlagRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateFlagRequest

Parameters

Parameter	Type
json	any
ignoreDiscriminator	boolean

Returns

UpdateFlagRequest

---

UpdateFlagRequestToJSON()

function UpdateFlagRequestToJSON(json: any): UpdateFlagRequest

Parameters

Parameter	Type
json	any

Returns

UpdateFlagRequest

---

UpdateFlagRequestToJSONTyped()

function UpdateFlagRequestToJSONTyped(value?: null | UpdateFlagRequest, ignoreDiscriminator?: boolean): any

Parameters

Parameter	Type	Default value
value?	null | UpdateFlagRequest	undefined
ignoreDiscriminator?	boolean	false

Returns

any