Class ExportRuleApi

Hierarchy

BaseAPI
- ExportRuleApi

Index

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getValidRuleOptions

getValidRuleOptions(requestParameters: GetValidRuleOptionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTExportRuleValidOptionsInfo>
Retrieve a list of the valid export rule options by object type and owner ID.
Parameters
- requestParameters: GetValidRuleOptionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTExportRuleValidOptionsInfo>
- Defined in apis/ExportRuleApi.ts:72

getValidRuleOptionsRaw

getValidRuleOptionsRaw(requestParameters: GetValidRuleOptionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTExportRuleValidOptionsInfo>>
Retrieve a list of the valid export rule options by object type and owner ID.
Parameters
- requestParameters: GetValidRuleOptionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTExportRuleValidOptionsInfo>>
- Defined in apis/ExportRuleApi.ts:38

`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

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 ExportRuleApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns ExportRuleApi

Properties

Protected configuration

Methods

getValidRuleOptions

Parameters

requestParameters: GetValidRuleOptionsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTExportRuleValidOptionsInfo>

getValidRuleOptionsRaw

Parameters

requestParameters: GetValidRuleOptionsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTExportRuleValidOptionsInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

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

Settings

Member Visibility

Theme

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

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

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