Interface: iBalanceDocWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:795

Extends#

• iBalanceDoc<T>

Extended by#

• iGetBalanceByAddressSuccessResponse

Type Parameters#

T#

T extends NumberType

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from#

iBalanceDoc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from#

iBalanceDoc._id

---

autoApproveAllIncomingTransfers#

autoApproveAllIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/userBalances.ts:27

Whether the user's all incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Inherited from#

iBalanceDoc.autoApproveAllIncomingTransfers

---

autoApproveSelfInitiatedIncomingTransfers#

autoApproveSelfInitiatedIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/userBalances.ts:25

Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Inherited from#

iBalanceDoc.autoApproveSelfInitiatedIncomingTransfers

---

autoApproveSelfInitiatedOutgoingTransfers#

autoApproveSelfInitiatedOutgoingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/userBalances.ts:23

Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals.

Inherited from#

iBalanceDoc.autoApproveSelfInitiatedOutgoingTransfers

---

balances#

balances: iBalance<T>[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/userBalances.ts:15

The user's balances.

Inherited from#

iBalanceDoc.balances

---

bitbadgesAddress#

bitbadgesAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:765

The BitBadges address of the user

Inherited from#

iBalanceDoc.bitbadgesAddress

---

collectionId#

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:762

The collection ID

Inherited from#

iBalanceDoc.collectionId

---

incomingApprovals#

incomingApprovals: iUserIncomingApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:799

The incoming approvals with details like metadata and address lists.

Overrides#

iBalanceDoc.incomingApprovals

---

outgoingApprovals#

outgoingApprovals: iUserOutgoingApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:797

The outgoing approvals with details like metadata and address lists.

Overrides#

iBalanceDoc.outgoingApprovals

---

tags?#

optional tags?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:771

Optional tags for this balance

Inherited from#

iBalanceDoc.tags

---

updateHistory#

updateHistory: iUpdateHistory<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:768

The update history of this balance

Inherited from#

iBalanceDoc.updateHistory

---

userPermissions#

userPermissions: iUserPermissionsWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:801

The user permissions with details like metadata and address lists.

Overrides#

iBalanceDoc.userPermissions