Class FeatureStudioApi

Hierarchy

BaseAPI
- FeatureStudioApi

Index

Constructors

Properties

Methods

createFeatureStudio createFeatureStudioRaw getFeatureStudioContents getFeatureStudioContentsRaw getFeatureStudioSpecs getFeatureStudioSpecsRaw request updateFeatureStudioContents updateFeatureStudioContentsRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new FeatureStudioApi(configuration?: Configuration): FeatureStudioApi
Parameters
- configuration: Configuration = DefaultConfig
Returns FeatureStudioApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createFeatureStudio

createFeatureStudio(requestParameters: CreateFeatureStudioRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementInfo>
Create Feature Studio by document ID and workspace ID.
Parameters
- requestParameters: CreateFeatureStudioRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementInfo>
- Defined in apis/FeatureStudioApi.ts:111

createFeatureStudioRaw

createFeatureStudioRaw(requestParameters: CreateFeatureStudioRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementInfo>>
Create Feature Studio by document ID and workspace ID.
Parameters
- requestParameters: CreateFeatureStudioRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementInfo>>
- Defined in apis/FeatureStudioApi.ts:70

getFeatureStudioContents

getFeatureStudioContents(requestParameters: GetFeatureStudioContentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureStudioContents2239>
Parameters
- requestParameters: GetFeatureStudioContentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureStudioContents2239>
- Defined in apis/FeatureStudioApi.ts:159

getFeatureStudioContentsRaw

getFeatureStudioContentsRaw(requestParameters: GetFeatureStudioContentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureStudioContents2239>>
Parameters
- requestParameters: GetFeatureStudioContentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureStudioContents2239>>
- Defined in apis/FeatureStudioApi.ts:118

getFeatureStudioSpecs

getFeatureStudioSpecs(requestParameters: GetFeatureStudioSpecsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureSpecsResponse664>
Retrieve Feature Studio specs by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetFeatureStudioSpecsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureSpecsResponse664>
- Defined in apis/FeatureStudioApi.ts:209

getFeatureStudioSpecsRaw

getFeatureStudioSpecsRaw(requestParameters: GetFeatureStudioSpecsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureSpecsResponse664>>
Retrieve Feature Studio specs by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetFeatureStudioSpecsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureSpecsResponse664>>
- Defined in apis/FeatureStudioApi.ts:167

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

updateFeatureStudioContents

updateFeatureStudioContents(requestParameters: UpdateFeatureStudioContentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureStudioContents2239>
Update Feature Studio contents by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateFeatureStudioContentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureStudioContents2239>
- Defined in apis/FeatureStudioApi.ts:262

updateFeatureStudioContentsRaw

updateFeatureStudioContentsRaw(requestParameters: UpdateFeatureStudioContentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureStudioContents2239>>
Update Feature Studio contents by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateFeatureStudioContentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureStudioContents2239>>
- Defined in apis/FeatureStudioApi.ts:217

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class FeatureStudioApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns FeatureStudioApi

Properties

Protected configuration

Methods

createFeatureStudio

Parameters

requestParameters: CreateFeatureStudioRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementInfo>

createFeatureStudioRaw

Parameters

requestParameters: CreateFeatureStudioRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementInfo>>

getFeatureStudioContents

Parameters

requestParameters: GetFeatureStudioContentsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTFeatureStudioContents2239>

getFeatureStudioContentsRaw

Parameters

requestParameters: GetFeatureStudioContentsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTFeatureStudioContents2239>>

getFeatureStudioSpecs

Parameters

requestParameters: GetFeatureStudioSpecsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTFeatureSpecsResponse664>

getFeatureStudioSpecsRaw

Parameters

requestParameters: GetFeatureStudioSpecsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTFeatureSpecsResponse664>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

updateFeatureStudioContents

Parameters

requestParameters: UpdateFeatureStudioContentsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTFeatureStudioContents2239>

updateFeatureStudioContentsRaw

Parameters

requestParameters: UpdateFeatureStudioContentsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTFeatureStudioContents2239>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

Returns T

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]