import Member from 'token-io/src/main/Member.js'

public class | source

Member

Member object. Allows member-wide actions. Some calls return a promise, and some return objects

Constructor Summary

Public Constructor
public	constructor(options: object) Represents a Member

Member Summary

Private Members
private	_client: AuthHttpClient
private	_id: string
private	_options: Object
private	_unauthenticatedClient: HttpClient

Method Summary

Public Methods
public	addAddress(name: string, address: Address): Promise<AddressRecord> Creates an address for this member, and saves it
public	addAlias(alias: Alias): Promise<void> Adds an alias to this member
public	addAliases(aliases: Array<Alias>): Promise<void> Adds aliases to this member
public	addTrustedBeneficiary(memberId: string): Promise<void> Adds a Token member to this member's list of trusted beneficiaries.
public	aliases(): Promise<Array<Alias>> Gets all of the member's aliases
public	approveKey(key: Key): Promise<void> Approves a new key for this member
public	approveKeys(keys: Array<Key>): Promise<void> Approves new keys for this member
public	cancelToken(token: Token \| string): Promise<TokenOperationResult> Cancels a token.
public	clearAccessToken(): void this method was deprecated. use forAccessToken instead Clears the access token id used with this client.
public	clearSecurityMetadata(): void Clears the security metadata.
public	createAccessToken(alias: Alias, resources: Array<Resource>): Promise<Token> Creates a new unendorsed access token.
public	createAccessTokenBuilder(): AccessTokenBuilder Creates a new access token builder, that must be executed.
public	createBlob(ownerId: string, type: string, name: string, data: Uint8Array \| Array<number>): Promise<object> Uploads a blob to the server.
public	createCustomization(logo: object, colors: object, consentText: string, name: string, appName: string): Promise<string> Creates a customization.
public	createTestBankAccount(balance: number, currency: string): Promise<OauthBankAuthorization> Creates a test bank account in a fake bank
public	createTestBankAccountOauth(balance: number, currency: string): Promise<OauthBankAuthorization> this method was deprecated. - use createTestBankAccount Creates a test bank account in a fake bank
public	createTransferToken(lifetimeAmount: number, currency: string): TransferTokenBuilder this method was deprecated. - use createTransferTokenBuilder instead Creates a transfer token builder, that when executed, will create a transfer token by performing an API call.
public	createTransferTokenBuilder(lifetimeAmount: number, currency: string): TransferTokenBuilder Creates a transfer token builder, that when executed, will create a transfer token by performing an API call.
public	deleteAddress(addressId: string): Promise<void> Deletes a member's address by id
public	deleteMember(): Promise<void> Deletes the member.
public	endorseToken(token: Token \| string): Promise<TokenOperationResult> Endorses a token.
public	firstAlias(): Promise<Alias\|undefined> Gets the member's first alias
public	forAccessToken(accessTokenId: string): * Creates a representable that acts as another member via an access token.
public	getAccessTokens(offset: string, limit: number): Promise<object> Looks up all access tokens
public	getAccount(accountId: string): Promise<Account> Looks up a member's account by Id
public	getAccounts(): Promise<Array<Account>> Looks up the member's accounts
public	getActiveAccessToken(toMemberId: string): Promise<Token> Looks up a existing access token where the calling member is the grantor and given member is the grantee.
public	getAddress(addressId: string): Promise<AddressRecord> Gets the member's address
public	getAddresses(): Promise<Array<AddressRecord>> Gets the member's addresses
public	getBalance(accountId: string, keyLevel: string): Promise<object> Looks up the balance of an account
public	getBalances(accountIds: Array<string>, keyLevel: string): Promise<Array<object>> Looks up the balances of an array of accounts
public	getBankInfo(bankId: string): Promise<BankInfo> Gets the info of a bank, including a link for pairing accounts at this bank
public	getBlob(blobId: string): Promise<Blob> Downloads a blob from the server.
public	getBlockingCancelTokenFunction(token: Token \| string): Promise<function\|undefined> Generates a blocking function to cancel a token.
public	getDefaultAccount(): Promise<Account> Gets the default bank account.
public	getNotification(notificationId: string): Promise<Notification> Gets a specific notification by Id
public	getNotifications(offset: string, limit: number): Promise<object> Gets all notifications for this member
public	getProfile(id: string): Promise<Profile> Gets a member's public profile.
public	getProfilePicture(id: string, size: stringliteral \| stringliteral \| stringliteral \| stringliteral): Promise<Blob> Gets a member's public profile picture.
public	getReceiptContact(): Promise<ReceiptContact> Get member's receipt contact.
public	getSubscriber(subscriberId: string): Promise<Subscriber> Gets a specific subscriber by Id
public	getSubscribers(): Promise<Array<Subscriber>> Gets all subscribers for this member
public	getTestBankNotification(subscriberId: string, notificationId: string): Promise<Notification> Gets test bank notification.
public	getTestBankNotifications(subscriberId: string): Promise<Array<Notification>> Gets test bank notifications.
public	getToken(tokenId: string): Promise<Token> Looks up a token by its Id
public	getTokenBlob(tokenId: string, blobId: string): Promise<Blob> Downloads a blob from the server, that is attached to a token.
public	getTransaction(accountId: string, transactionId: string, keyLevel: string): Promise<Transaction> Looks up a transaction
public	getTransactions(accountId: string, offset: string, limit: number, keyLevel: string): Promise<object> Looks up all of the member's transactions for an account
public	getTransfer(transferId: string): Promise<Transfer> Looks up a transfer
public	getTransferTokens(offset: string, limit: number): Promise<object> Looks up all transfer tokens
public	getTransfers(tokenId: string, offset: string, limit: number): Promise<object> Looks up all of the member's transfers
public	getTrustedBeneficiaries(): Promise<Array<TrustedBeneficiary>> Get the member's list of trusted beneficiaries.
public	isDefaultAccount(accountId: string): Promise<boolean> Looks up if this account is default.
public	keys(): Promise<Array<Key>> Gets the member's public keys
public	linkAccounts(authorization: OauthBankAuthorization \| any): Promise<Array<Account>> Links bank accounts to the member
public	memberId(): string Gets the memberId
public	redeemToken(token: Token \| string, amount: number, currency: string, description: string, destinations: Array<TransferEndpoint>, refId: string): Promise<Transfer> Redeems a token.
public	removeAlias(alias: Alias): Promise<void> Removes an alias from the memberId
public	removeAliases(aliases: Array<Alias>): Promise<void> Removes aliases from the memberId
public	removeKey(keyId: string): Promise<void> Removes a key from this member
public	removeKeys(keyIds: Array<string>): Promise<void> Removes keys from this member
public	removeTrustedBeneficiary(memberId: string): Promise<void> Removes a Token member from this member's list of trusted beneficiaries.
public	replaceAccessToken(tokenToCancel: Token \| string, newResources: Array<Resource>): Promise<TokenOperationResult> Cancels the existing token and creates a replacement for it.
public	replaceAndEndorseAccessToken(tokenToCancel: Token \| string, newResources: Array<Resource>): Promise<TokenOperationResult> this method was deprecated. use replaceAccessToken and endorseToken instead Cancels the existing token, creates a replacement and endorses it.
public	resolveTransferDestinations(accountId: string): Promise<TransferEndpoint[]> Resolves transfer destinations for the given account ID.
public	setCustomerInitiated(): void Sets the customer initiated request flag to true.
public	setDefaultAccount(accountId: string): Promise<void> Sets the member's default bank account.
public	setProfile(profile: Profile): Promise<Profile> Replaces the authenticated member's public profile.
public	setProfilePicture(type: string, data: Uint8Array \| Array<number>): Promise<void> Uploads the authenticated member's public profile.
public	setReceiptContact(type: stringliteral, value: string): Promise<void> Replaces member's receipt contact.
public	setSecurityMetadata(securityMetadata: SecurityMetadata): void Sets the security metadata to be sent with each request.
public	signTokenRequestState(tokenRequestId: string, tokenId: string, state: string): Promise<Signature> Sign with a Token signature a token request state payload.
public	storeTokenRequest(tokenRequest: TokenRequest): Promise<TokenRequest> Stores a request for a token.
public	subscribeToNotifications(handler: string, handlerInstructions: object): Promise<Subscriber> Creates a subscriber to receive notifications of member events, such as step up auth, new device requests, linking account requests, or transfer notifications
public	triggerBalanceStepUpNotification(accountIds: Array<string>): Promise<NotifyStatusEnum> Triggers a balance step up notification on the user's app
public	triggerStepUpNotification(tokenId: string): Promise<NotifyStatusEnum> Triggers a token step up notification on the user's app
public	triggerTransactionStepUpNotification(accountId: string, transactionId: string): Promise<NotifyStatusEnum> Triggers a transaction step up notification on the user's app
public	unlinkAccounts(accountIds: Array<string>): Promise<void> Unlinks bank accounts previously linked by the linkAccounts call.
public	unsubscribeFromNotifications(subscriberId: string): Promise<void> Unsubscribes from notifications (removes a subscriber)
public	useAccessToken(accessTokenId: string): void this method was deprecated. use forAccessToken instead Sets the access token id to be used with this client.
public	useDefaultRecoveryRule(): Promise<RecoveryRule> Set the 'normal consumer' rule as member's recovery rule. (As of Nov 2017, this rule was: To recover, verify an alias.)
public	verifyAffiliate(memberId: string): Promise<void> Verifies and affiliated TPP.

Private Methods
private	_getMember(): *
private	_getPreviousHash(): *
private	_normalizeAlias(alias: Alias, partnerId: string): Promise<Alias>
private	_resolveToken(token: string \| Token): Promise<any>

Public Constructors

public constructor(options: object) source

Represents a Member

Params:

Name	Type	Attribute	Description
options	object

Private Members

private _client: AuthHttpClient source

private _id: string source

private _options: Object source

private _unauthenticatedClient: HttpClient source

Public Methods

public addAddress(name: string, address: Address): Promise<AddressRecord> source

Creates an address for this member, and saves it

Params:

Name	Type	Attribute	Description
name	string		name of the address (e.g 'Home')
address	Address		address

Return:

Promise<AddressRecord>

promise of AddressRecord structure

public addAlias(alias: Alias): Promise<void> source

Adds an alias to this member

Params:

Name	Type	Attribute	Description
alias	Alias		alias to add

Return:

Promise<void>

empty promise

public addAliases(aliases: Array<Alias>): Promise<void> source

Adds aliases to this member

Params:

Name	Type	Attribute	Description
aliases	Array<Alias>		aliases to add

Return:

Promise<void>

empty promise

public addTrustedBeneficiary(memberId: string): Promise<void> source

Adds a Token member to this member's list of trusted beneficiaries.

Params:

Name	Type	Attribute	Description
memberId	string		member ID of the trusted beneficiary to add

Return:

Promise<void>

empty promise

public aliases(): Promise<Array<Alias>> source

Gets all of the member's aliases

Return:

Promise<Array<Alias>>

public approveKey(key: Key): Promise<void> source

Approves a new key for this member

Params:

Name	Type	Attribute	Description
key	Key		key to add

Return:

Promise<void>

empty promise

public approveKeys(keys: Array<Key>): Promise<void> source

Approves new keys for this member

Params:

Name	Type	Attribute	Description
keys	Array<Key>		keys to add

Return:

Promise<void>

empty promise

public cancelToken(token: Token | string): Promise<TokenOperationResult> source

Cancels a token. (Called by the payer or the redeemer)

Params:

Name	Type	Attribute	Description
token	Token \| string		token to cancel. Can also be a tokenId

Return:

Promise<TokenOperationResult>

cancelled token

public clearAccessToken(): void source

this method was deprecated. use forAccessToken instead

Clears the access token id used with this client.

Return:

void

public clearSecurityMetadata(): void source

Clears the security metadata.

Return:

void

public createAccessToken(alias: Alias, resources: Array<Resource>): Promise<Token> source

Creates a new unendorsed access token.

Params:

Name	Type	Attribute	Description
alias	Alias		the alias of the grantee of the Access Token
resources	Array<Resource>		a list of resources to give access to

Return:

Promise<Token>

promise of a created Access Token

public createAccessTokenBuilder(): AccessTokenBuilder source

Creates a new access token builder, that must be executed.

Return:

AccessTokenBuilder

promise of a created Access Token

public createBlob(ownerId: string, type: string, name: string, data: Uint8Array | Array<number>): Promise<object> source

Uploads a blob to the server.

Params:

Name	Type	Attribute	Description
ownerId	string		owner of the blob
type	string		MIME type
name	string		name of the file
data	Uint8Array \| Array<number>		data in bytes

Return:

Promise<object>

attachment

public createCustomization(logo: object, colors: object, consentText: string, name: string, appName: string): Promise<string> source

Creates a customization.

Params:

Name	Type	Attribute	Description
logo	object		logo
colors	object	nullable: true	map of ARGB colors #AARRGGBB
consentText	string		consent text
name	string		display name
appName	string		corresponding app name

Return:

Promise<string>

customization id

public createTestBankAccount(balance: number, currency: string): Promise<OauthBankAuthorization> source

Creates a test bank account in a fake bank

Params:

Name	Type	Attribute	Description
balance	number		balance of the account
currency	string		currency of the account

Return:

Promise<OauthBankAuthorization>

bank authorization to use with linkAccounts

public createTestBankAccountOauth(balance: number, currency: string): Promise<OauthBankAuthorization> source

this method was deprecated. - use createTestBankAccount

Creates a test bank account in a fake bank

Params:

Name	Type	Attribute	Description
balance	number		balance of the account
currency	string		currency of the account

Return:

Promise<OauthBankAuthorization>

bank authorization to use with linkAccounts

public createTransferToken(lifetimeAmount: number, currency: string): TransferTokenBuilder source

this method was deprecated. - use createTransferTokenBuilder instead Creates a transfer token builder, that when executed, will create a transfer token by performing an API call.

Params:

Name	Type	Attribute	Description
lifetimeAmount	number		amount limit on the token
currency	string		3 letter currency code ('EUR', 'USD', etc)

Return:

TransferTokenBuilder

builder for the token

public createTransferTokenBuilder(lifetimeAmount: number, currency: string): TransferTokenBuilder source

Creates a transfer token builder, that when executed, will create a transfer token by performing an API call.

Params:

Name	Type	Attribute	Description
lifetimeAmount	number		amount limit on the token
currency	string		3 letter currency code ('EUR', 'USD', etc)

Return:

TransferTokenBuilder

builder for the token

public deleteAddress(addressId: string): Promise<void> source

Deletes a member's address by id

Params:

Name	Type	Attribute	Description
addressId	string		the address id

Return:

Promise<void>

empty promise

public deleteMember(): Promise<void> source

Deletes the member.

Return:

Promise<void>

response to the api call

public endorseToken(token: Token | string): Promise<TokenOperationResult> source

Endorses a token. If this SDK client doesn't have a sufficiently privileged key to endorse the token, this will return MORE_SIGNATURES_NEEDED and the system pushes a notification to the member prompting them to use a higher-privilege key.

Params:

Name	Type	Attribute	Description
token	Token \| string		Transfer token to endorse. Can also be a tokenId

Return:

Promise<TokenOperationResult>

endorsed token

public firstAlias(): Promise<Alias|undefined> source

Gets the member's first alias

Return:

Promise<Alias|undefined>

member's alias

public forAccessToken(accessTokenId: string): * source

Creates a representable that acts as another member via an access token.

Params:

Name	Type	Attribute	Description
accessTokenId	string		Id of the access token

Return:

*	new member that acts as another member

public getAccessTokens(offset: string, limit: number): Promise<object> source

Looks up all access tokens

Params:

Name	Type	Attribute	Description
offset	string		where to start looking
limit	number		how many to look for

Return:

Promise<object>

access tokens - returns a list of access tokens

public getAccount(accountId: string): Promise<Account> source

Looks up a member's account by Id

Params:

Name	Type	Attribute	Description
accountId	string		accountId

Return:

Promise<Account>

Promise resolving to the account

Throw:

*	error if account not found

public getAccounts(): Promise<Array<Account>> source

Looks up the member's accounts

Return:

Promise<Array<Account>>

Promise resolving to the accounts

public getActiveAccessToken(toMemberId: string): Promise<Token> source

Looks up a existing access token where the calling member is the grantor and given member is the grantee.

Params:

Name	Type	Attribute	Description
toMemberId	string		beneficiary of the active access token

Return:

Promise<Token>

access token returned by the server

public getAddress(addressId: string): Promise<AddressRecord> source

Gets the member's address

Params:

Name	Type	Attribute	Description
addressId	string		the address id

Return:

Promise<AddressRecord>

AddressRecord structure

Throw:

*	error if address not found

public getAddresses(): Promise<Array<AddressRecord>> source

Gets the member's addresses

Return:

Promise<Array<AddressRecord>>

list of AddressRecord structures

public getBalance(accountId: string, keyLevel: string): Promise<object> source

Looks up the balance of an account

Params:

Name	Type	Attribute	Description
accountId	string		id of the account
keyLevel	string		key level

Return:

Promise<object>

Promise of get balance response object

public getBalances(accountIds: Array<string>, keyLevel: string): Promise<Array<object>> source

Looks up the balances of an array of accounts

Params:

Name	Type	Attribute	Description
accountIds	Array<string>		array of account ids
keyLevel	string		key level

Return:

Promise<Array<object>>

Promise of get balances response object

public getBankInfo(bankId: string): Promise<BankInfo> source

Gets the info of a bank, including a link for pairing accounts at this bank

Params:

Name	Type	Attribute	Description
bankId	string		id of the bank

Return:

Promise<BankInfo>

info

Throw:

*	error if bank not found

public getBlob(blobId: string): Promise<Blob> source

Downloads a blob from the server.

Params:

Name	Type	Attribute	Description
blobId	string		id of the blob

Return:

Promise<Blob>

downloaded blob

Throw:

*	error if blob not found

public getBlockingCancelTokenFunction(token: Token | string): Promise<function|undefined> source

Generates a blocking function to cancel a token. (Called by the payer or the redeemer)

Params:

Name	Type	Attribute	Description
token	Token \| string		token to cancel. Can also be a tokenId

Return:

Promise<function|undefined>

blocking function to cancel the token

public getDefaultAccount(): Promise<Account> source

Gets the default bank account.

Return:

Promise<Account>

the default bank account

Throw:

*	error if default account not found

public getNotification(notificationId: string): Promise<Notification> source

Gets a specific notification by Id

Params:

Name	Type	Attribute	Description
notificationId	string		id of the notification

Return:

Promise<Notification>

notification

Throw:

*	error if notification not found

public getNotifications(offset: string, limit: number): Promise<object> source

Gets all notifications for this member

Params:

Name	Type	Attribute	Description
offset	string		where to start looking
limit	number		how many to look for

Return:

Promise<object>

notifications

public getProfile(id: string): Promise<Profile> source

Gets a member's public profile.

Params:

Name	Type	Attribute	Description
id	string		member id whose profile to get

Return:

Promise<Profile>

profile

Throw:

*	error if profile not found

public getProfilePicture(id: string, size: stringliteral | stringliteral | stringliteral | stringliteral): Promise<Blob> source

Gets a member's public profile picture.

Params:

Name	Type	Attribute	Description
id	string		member id whose picture to get
size	stringliteral \| stringliteral \| stringliteral \| stringliteral		desired size category SMALL/MEDIUM/LARGE/ORIGINAL

Return:

Promise<Blob>

downloaded blob

Throw:

*	error if profile picture not found

public getReceiptContact(): Promise<ReceiptContact> source

Get member's receipt contact.

Return:

Promise<ReceiptContact>

receipt contact: value + type

Throw:

*	error if receipt contact not found

public getSubscriber(subscriberId: string): Promise<Subscriber> source

Gets a specific subscriber by Id

Params:

Name	Type	Attribute	Description
subscriberId	string		id of the subscriber

Return:

Promise<Subscriber>

subscriber

Throw:

*	error if subscriber not found

public getSubscribers(): Promise<Array<Subscriber>> source

Gets all subscribers for this member

Return:

Promise<Array<Subscriber>>

subscribers

public getTestBankNotification(subscriberId: string, notificationId: string): Promise<Notification> source

Gets test bank notification.

Params:

Name	Type	Attribute	Description
subscriberId	string		id of subscriber
notificationId	string		id of notification

Return:

Promise<Notification>

response to the API call

public getTestBankNotifications(subscriberId: string): Promise<Array<Notification>> source

Gets test bank notifications.

Params:

Name	Type	Attribute	Description
subscriberId	string		id of subscriber

Return:

Promise<Array<Notification>>

response to the API call

public getToken(tokenId: string): Promise<Token> source

Looks up a token by its Id

Params:

Name	Type	Attribute	Description
tokenId	string		id of the token

Return:

Promise<Token>

token

Throw:

*	error if token not found

public getTokenBlob(tokenId: string, blobId: string): Promise<Blob> source

Downloads a blob from the server, that is attached to a token.

Params:

Name	Type	Attribute	Description
tokenId	string		id of the token
blobId	string		id of the blob

Return:

Promise<Blob>

downloaded blob

Throw:

*	error if token blob not found

public getTransaction(accountId: string, transactionId: string, keyLevel: string): Promise<Transaction> source

Looks up a transaction

Params:

Name	Type	Attribute	Description
accountId	string		id of the account
transactionId	string		which transaction to look up
keyLevel	string		key level

Return:

Promise<Transaction>

the Transaction

Throw:

*	error if transaction not found

public getTransactions(accountId: string, offset: string, limit: number, keyLevel: string): Promise<object> source

Looks up all of the member's transactions for an account

Params:

Name	Type	Attribute	Description
accountId	string		id of the account
offset	string		where to start looking
limit	number		how many to retrieve
keyLevel	string		key level

Return:

Promise<object>

Transactions

public getTransfer(transferId: string): Promise<Transfer> source

Looks up a transfer

Params:

Name	Type	Attribute	Description
transferId	string		id to look up

Return:

Promise<Transfer>

transfer if found

Throw:

*	error if transfer not found

public getTransferTokens(offset: string, limit: number): Promise<object> source

Looks up all transfer tokens

Params:

Name	Type	Attribute	Description
offset	string		where to start looking
limit	number		how many to look for

Return:

Promise<object>

returns a list of Transfer Tokens

public getTransfers(tokenId: string, offset: string, limit: number): Promise<object> source

Looks up all of the member's transfers

Params:

Name	Type	Attribute	Description
tokenId	string		token to use for lookup
offset	string		where to start looking
limit	number		how many to retrieve

Return:

Promise<object>

Transfers

public getTrustedBeneficiaries(): Promise<Array<TrustedBeneficiary>> source

Get the member's list of trusted beneficiaries.

Return:

Promise<Array<TrustedBeneficiary>>

trusted beneficiaries - list of TrustedBeneficiary objects

public isDefaultAccount(accountId: string): Promise<boolean> source

Looks up if this account is default.

Params:

Name	Type	Attribute	Description
accountId	string		the bank account id

Return:

Promise<boolean>

true if the account is default; false otherwise

public keys(): Promise<Array<Key>> source

Gets the member's public keys

Return:

Promise<Array<Key>>

keys objects

public linkAccounts(authorization: OauthBankAuthorization | any): Promise<Array<Account>> source

Links bank accounts to the member

Params:

Name	Type	Attribute	Description
authorization	OauthBankAuthorization \| any		bankAuthorization obtained from bank, or oauthBankAuthorization

Return:

Promise<Array<Account>>

Promise resolving the the Accounts linked

public memberId(): string source

Gets the memberId

Return:

string

public redeemToken(token: Token | string, amount: number, currency: string, description: string, destinations: Array<TransferEndpoint>, refId: string): Promise<Transfer> source

Redeems a token. (Called by the payee or redeemer)

Params:

Name	Type	Attribute	Description
token	Token \| string		token to redeem. Can also be a tokenId
amount	number	nullable: true	amount to redeemer
currency	string	nullable: true	currency to redeem
description	string	nullable: true	optional transfer description
destinations	Array<TransferEndpoint>	optional default: undefined	transfer destinations
refId	string		Id that will be set on created Transfer. Token uses this to detect duplicates. Caller might use this to recognize the transfer. If param empty, transfer will have random refId.

Return:

Promise<Transfer>

Transfer created as a result of this redeem call

public removeAlias(alias: Alias): Promise<void> source

Removes an alias from the memberId

Params:

Name	Type	Attribute	Description
alias	Alias		alias to remove

Return:

Promise<void>

empty promise

public removeAliases(aliases: Array<Alias>): Promise<void> source

Removes aliases from the memberId

Params:

Name	Type	Attribute	Description
aliases	Array<Alias>		aliases to remove

Return:

Promise<void>

empty promise

public removeKey(keyId: string): Promise<void> source

Removes a key from this member

Params:

Name	Type	Attribute	Description
keyId	string		keyId to remove. Note, keyId is the hash of the pk

Return:

Promise<void>

empty promise

public removeKeys(keyIds: Array<string>): Promise<void> source

Removes keys from this member

Params:

Name	Type	Attribute	Description
keyIds	Array<string>		keyIds to remove. Note, keyId is the hash of the pk

Return:

Promise<void>

empty promise

public removeTrustedBeneficiary(memberId: string): Promise<void> source

Removes a Token member from this member's list of trusted beneficiaries.

Params:

Name	Type	Attribute	Description
memberId	string		member ID of the trusted beneficiary to remove

Return:

Promise<void>

empty promise

public replaceAccessToken(tokenToCancel: Token | string, newResources: Array<Resource>): Promise<TokenOperationResult> source

Cancels the existing token and creates a replacement for it.

Params:

Name	Type	Attribute	Description
tokenToCancel	Token \| string		the old token to cancel
newResources	Array<Resource>		the new resources for this token to grant access to

Return:

Promise<TokenOperationResult>

the result of the operation

public replaceAndEndorseAccessToken(tokenToCancel: Token | string, newResources: Array<Resource>): Promise<TokenOperationResult> source

this method was deprecated. use replaceAccessToken and endorseToken instead Cancels the existing token, creates a replacement and endorses it.

Params:

Name	Type	Attribute	Description
tokenToCancel	Token \| string		the old token to cancel
newResources	Array<Resource>		the new resources for this token to grant access to

Return:

Promise<TokenOperationResult>

the result of the operation

public resolveTransferDestinations(accountId: string): Promise<TransferEndpoint[]> source

Resolves transfer destinations for the given account ID.

Params:

Name	Type	Attribute	Description
accountId	string		id of account to resolve destinations for

Return:

Promise<TransferEndpoint[]>

resolved transfer endpoints

public setCustomerInitiated(): void source

Sets the customer initiated request flag to true.

Return:

void

public setDefaultAccount(accountId: string): Promise<void> source

Sets the member's default bank account.

Params:

Name	Type	Attribute	Description
accountId	string		the bank account id

Return:

Promise<void>

empty promise

public setProfile(profile: Profile): Promise<Profile> source

Replaces the authenticated member's public profile.

Params:

Name	Type	Attribute	Description
profile	Profile		profile to set

Return:

Promise<Profile>

newly-set profile

public setProfilePicture(type: string, data: Uint8Array | Array<number>): Promise<void> source

Uploads the authenticated member's public profile.

Params:

Name	Type	Attribute	Description
type	string		MIME type
data	Uint8Array \| Array<number>		data in bytes

Return:

Promise<void>

empty promise

public setReceiptContact(type: stringliteral, value: string): Promise<void> source

Replaces member's receipt contact.

Params:

Name	Type	Attribute	Description
type	stringliteral	optional default: EMAIL	receipt contact type, can only be EMAIL currently
value	string		receipt contact value for corresponding type

Return:

Promise<void>

empty promise

public setSecurityMetadata(securityMetadata: SecurityMetadata): void source

Sets the security metadata to be sent with each request.

Params:

Name	Type	Attribute	Description
securityMetadata	SecurityMetadata		securityMetadata

Return:

void

public signTokenRequestState(tokenRequestId: string, tokenId: string, state: string): Promise<Signature> source

Sign with a Token signature a token request state payload.

Params:

Name	Type	Attribute	Description
tokenRequestId	string		token request id
tokenId	string		token id
state	string		url state

Return:

Promise<Signature>

response to the api call

public storeTokenRequest(tokenRequest: TokenRequest): Promise<TokenRequest> source

Stores a request for a token. Called by a merchant or a TPP that wants access from a user.

Params:

Name	Type	Attribute	Description
tokenRequest	TokenRequest		token request to store

Return:

Promise<TokenRequest>

the stored TokenRequest

public subscribeToNotifications(handler: string, handlerInstructions: object): Promise<Subscriber> source

Creates a subscriber to receive notifications of member events, such as step up auth, new device requests, linking account requests, or transfer notifications

Params:

Name	Type	Attribute	Description
handler	string	optional default: token	who is handling the notifications
handlerInstructions	object	optional default: {}	map of strings with delivery options

Return:

Promise<Subscriber>

Subscriber

public triggerBalanceStepUpNotification(accountIds: Array<string>): Promise<NotifyStatusEnum> source

Triggers a balance step up notification on the user's app

Params:

Name	Type	Attribute	Description
accountIds	Array<string>		array of account ids

Return:

Promise<NotifyStatusEnum>

notification status

public triggerStepUpNotification(tokenId: string): Promise<NotifyStatusEnum> source

Triggers a token step up notification on the user's app

Params:

Name	Type	Attribute	Description
tokenId	string		token ID

Return:

Promise<NotifyStatusEnum>

notification status

public triggerTransactionStepUpNotification(accountId: string, transactionId: string): Promise<NotifyStatusEnum> source

Triggers a transaction step up notification on the user's app

Params:

Name	Type	Attribute	Description
accountId	string		account id
transactionId	string		transaction id

Return:

Promise<NotifyStatusEnum>

notification status

public unlinkAccounts(accountIds: Array<string>): Promise<void> source

Unlinks bank accounts previously linked by the linkAccounts call.

Params:

Name	Type	Attribute	Description
accountIds	Array<string>		account ids to unlink

Return:

Promise<void>

empty promise

public unsubscribeFromNotifications(subscriberId: string): Promise<void> source

Unsubscribes from notifications (removes a subscriber)

Params:

Name	Type	Attribute	Description
subscriberId	string		subscriber to remove

Return:

Promise<void>

empty promise

public useAccessToken(accessTokenId: string): void source

this method was deprecated. use forAccessToken instead

Sets the access token id to be used with this client.

Params:

Name	Type	Attribute	Description
accessTokenId	string		the access token id

Return:

void

public useDefaultRecoveryRule(): Promise<RecoveryRule> source

Set the 'normal consumer' rule as member's recovery rule. (As of Nov 2017, this rule was: To recover, verify an alias.)

Return:

Promise<RecoveryRule>

promise containing RecoveryRule proto buffer.

public verifyAffiliate(memberId: string): Promise<void> source

Verifies and affiliated TPP.

Params:

Name	Type	Attribute	Description
memberId	string		id of the member to verify

Return:

Promise<void>

empty promise

Private Methods

private _getMember(): * source

Return:

private _getPreviousHash(): * source

Return:

private _normalizeAlias(alias: Alias, partnerId: string): Promise<Alias> source

Params:

Name	Type	Attribute	Description
alias	Alias
partnerId	string

Return:

Promise<Alias>

private _resolveToken(token: string | Token): Promise<any> source

Params:

Name	Type	Attribute	Description
token	string \| Token

Return:

Promise<any>