Class Bitcapital

The main interface for the Bitcapital SDK, holds credentials, instance options and all internal modules.

Hierarchy

Bitcapital

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new Bitcapital(options: BitcapitalOptions): Bitcapital

- Defined in Bitcapital.ts:37
Construct a new Bitcapital instance, not safe to call directly, use the init() method.

Parameters
- options: BitcapitalOptions
  
  The bitcapital options and credentials
Returns Bitcapital

Properties

Protected _session

_session: Session

Protected options

options: BitcapitalOptions

The bitcapital options and credentials

Static Protected _instance

_instance: Bitcapital

Methods

addresses

addresses(): AddressWebService

- Defined in Bitcapital.ts:134
Interface for the Addresses service.

Returns AddressWebService

assets

assets(): AssetWebService

- Defined in Bitcapital.ts:141
Interface for the Assets service.

Returns AssetWebService

bankings

bankings(): BankingWebService

- Defined in Bitcapital.ts:148
Interface for the Bankings service.

Returns BankingWebService

boletos

boletos(): BoletoWebService

- Defined in Bitcapital.ts:155
Interface for the Boleto service.

Returns BoletoWebService

cards

cards(): CardWebService

- Defined in Bitcapital.ts:169
Interface for the Card service.

Returns CardWebService

consumers

consumers(): ConsumerWebService

- Defined in Bitcapital.ts:162
Interface for the Consumers service.

Returns ConsumerWebService

current

current(): User | undefined

- Defined in Bitcapital.ts:113
Get the currently authenticated user in the SDK, if any.

Returns User | undefined

documents

documents(): DocumentWebService

- Defined in Bitcapital.ts:175
Interface for the Documents service.

Returns DocumentWebService

domains

domains(): DomainWebService

- Defined in Bitcapital.ts:182
Interface for the Domains service.

Returns DomainWebService

mediators

mediators(): MediatorWebService

- Defined in Bitcapital.ts:189
Interface for the Mediators service.

Returns MediatorWebService

oauth

oauth(): OAuthWebService

- Defined in Bitcapital.ts:127
Interface for the OAuth 2.0 service.

Returns OAuthWebService

payments

payments(): PaymentWebService

- Defined in Bitcapital.ts:196
Interface for the Payments service.

Returns PaymentWebService

phones

phones(): PhoneWebService

- Defined in Bitcapital.ts:203
Interface for the Phones service.

Returns PhoneWebService

products

products(): ProductWebService

- Defined in Bitcapital.ts:210
Interface for the Product service.

Returns ProductWebService

session

session(): Session

- Defined in Bitcapital.ts:120
Get the Bitcapital session instance.

Returns Session

sign

sign(request: RequestSigningOptions): RequestSigningHeaders

- Defined in Bitcapital.ts:99
Generate signature headers for the specificed request.

Parameters
- request: RequestSigningOptions
  
  The request object
Returns RequestSigningHeaders

status

status(): Promise<OAuthStatusResponse>

- Defined in Bitcapital.ts:106
Get the API Status.

Returns Promise<OAuthStatusResponse>

transactions

transactions(): TransactionWebService

- Defined in Bitcapital.ts:217
Interface for the Transactions service.

Returns TransactionWebService

users

users(): UserWebService

- Defined in Bitcapital.ts:224
Interface for the Users service.

Returns UserWebService

wallets

wallets(): WalletWebService

- Defined in Bitcapital.ts:231
Interface for the Wallets service.

Returns WalletWebService

Static getInstance

getInstance(): Bitcapital | undefined

- Defined in Bitcapital.ts:81
Gets the singleton instance, if already initialized and available.

Returns Bitcapital | undefined

Static initialize

initialize(options: BitcapitalOptions): Bitcapital

- Defined in Bitcapital.ts:90
Initialize the Bitcapital SDK with credentials.

Parameters
- options: BitcapitalOptions
  
  The bitcapital options and credentials.
Returns Bitcapital

Generated using TypeDoc