Class CompanyApi

Hierarchy

BaseAPI
- CompanyApi

Index

Constructors

Properties

Methods

findCompany findCompanyRaw getCompany getCompanyRaw getDocumentsByName getDocumentsByNameRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

findCompany

findCompany(requestParameters?: FindCompanyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTCompanyInfo>
Retrieve user companies.
Parameters
- requestParameters: FindCompanyRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTCompanyInfo>
- Defined in apis/CompanyApi.ts:87

findCompanyRaw

findCompanyRaw(requestParameters: FindCompanyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTCompanyInfo>>
Retrieve user companies.
Parameters
- requestParameters: FindCompanyRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTCompanyInfo>>
- Defined in apis/CompanyApi.ts:54

getCompany

getCompany(requestParameters: GetCompanyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCompanyInfo>
Retrieve company by company ID.
Parameters
- requestParameters: GetCompanyRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCompanyInfo>
- Defined in apis/CompanyApi.ts:120

getCompanyRaw

getCompanyRaw(requestParameters: GetCompanyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCompanyInfo>>
Retrieve company by company ID.
Parameters
- requestParameters: GetCompanyRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCompanyInfo>>
- Defined in apis/CompanyApi.ts:95

getDocumentsByName

getDocumentsByName(requestParameters: GetDocumentsByNameRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentSummaryInfo[]>
Retrieve a list of company owned documents by document name. Accessible only by company admins.
Parameters
- requestParameters: GetDocumentsByNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentSummaryInfo[]>
- Defined in apis/CompanyApi.ts:166

getDocumentsByNameRaw

getDocumentsByNameRaw(requestParameters: GetDocumentsByNameRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentSummaryInfo[]>>
Retrieve a list of company owned documents by document name. Accessible only by company admins.
Parameters
- requestParameters: GetDocumentsByNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentSummaryInfo[]>>
- Defined in apis/CompanyApi.ts:128

`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 CompanyApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns CompanyApi

Properties

Protected configuration

Methods

findCompany

Parameters

requestParameters: FindCompanyRequest = {}

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTListResponseBTCompanyInfo>

findCompanyRaw

Parameters

requestParameters: FindCompanyRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTListResponseBTCompanyInfo>>

getCompany

Parameters

requestParameters: GetCompanyRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTCompanyInfo>

getCompanyRaw

Parameters

requestParameters: GetCompanyRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTCompanyInfo>>

getDocumentsByName

Parameters

requestParameters: GetDocumentsByNameRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentSummaryInfo[]>

getDocumentsByNameRaw

Parameters

requestParameters: GetDocumentsByNameRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentSummaryInfo[]>>

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

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`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>)[]