Class Enterprise

Hierarchy

Enterprise

Index

Constructors

constructor

Properties

id
name

Methods

Constructors

constructor

new Enterprise(bitgo: BitGo, baseCoin: BaseCoin, enterpriseData: object): Enterprise

- Defined in src/v2/enterprise.ts:21
Parameters
- bitgo: BitGo
- baseCoin: BaseCoin
- enterpriseData: object
Returns Enterprise

Properties

id

id: string

name

name: string

Methods

addUser

addUser(params?: any, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/enterprise.ts:101
Add a user to this Enterprise

Parameters
- Default value params: any = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

affirmations

affirmations(): Affirmations

- Defined in src/v2/enterprise.ts:141
Manage affirmations for an enterprise

Returns Affirmations

coinUrl

coinUrl(query?: string): string

- Defined in src/v2/enterprise.ts:51
Enterprise URL for v2 methods, such as getting fee address balances

Parameters
- Default value query: string = ""
Returns string

coinWallets

coinWallets(params?: __type, callback?: NodeCallback<Wallet[]>): Bluebird<Wallet[]>

- Defined in src/v2/enterprise.ts:60
Get the wallets associated with this Enterprise

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<Wallet[]>
Returns Bluebird<Wallet[]>

getFeeAddressBalance

getFeeAddressBalance(params?: __type, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/enterprise.ts:89
Get the fee address balance for this Enterprise

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

getFirstPendingTransaction

getFirstPendingTransaction(params?: __type, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/enterprise.ts:127
Get the first pending transaction for this Enterprise

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

removeUser

removeUser(params?: any, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/enterprise.ts:114
Remove a user from this Enterprise

Parameters
- Default value params: any = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

settlements

settlements(): Settlements

- Defined in src/v2/enterprise.ts:134
Manage settlements for an enterprise

Returns Settlements

url

url(query?: string): string

- Defined in src/v2/enterprise.ts:43
Enterprise URL for v1 methods, such as getting users

Parameters
- Default value query: string = ""
Returns string

users

users(params?: __type, callback?: NodeCallback<any>): Bluebird<any>

- Defined in src/v2/enterprise.ts:77
Get the users associated with this Enterprise

Parameters
- Default value params: __type = {}
- Optional callback: NodeCallback<any>
Returns Bluebird<any>

Generated using TypeDoc