Class CreateAccount

The create account api is an asyncronous request to BambuMeta to issue the provided user an account. This request will not guarentee an account is created. But checks if there is already an existing account. If so, the account id is returned. If no account already exists, the request will be added to the processor for consumption and a success message should be returned.

Hierarchy

Executable<CreateAccountResponse>
- CreateAccount

Index

Constructors

constructor

new CreateAccount(input?): CreateAccount
Parameters
- Optional input: CreateAccountInput
Returns CreateAccount
Overrides Executable.constructor
- Defined in src/create-account.ts:102

Properties

`Private` `Optional` _email

_email?: string

`Private` `Optional` _firstName

_firstName?: string

`Private` `Optional` _lastName

_lastName?: string

`Private` _ledgerType

_ledgerType: string = 'hedera'

`Private` `Optional` _metadata

_metadata?: any

`Private` `Optional` _phone

_phone?: string

Methods

getBody

getBody(): any
getBody is used by the BambuClient to properly construct the request object body.

Returns any
Returns the expected body of the request utilizing the defined request attributes.
Overrides Executable.getBody
- Defined in src/create-account.ts:184

getMethod

getMethod(): Method
getMethod is used by the BambuClient to properly construct the request call.

Returns Method
request method
Overrides Executable.getMethod
- Defined in src/create-account.ts:68

getResponse

getResponse(apiResponse): CreateAccountResponse
getResponse is used by the BambuClient to propery return the response object type.
Parameters
- apiResponse: any
  
  the api response object returned by the BambuMeta client before being converted to the CreateAccountResponse
Returns CreateAccountResponse
CreateAccountResponse
Overrides Executable.getResponse
- Defined in src/create-account.ts:77

getRootPath

getRootPath(): undefined | string
getRootPath is used by the BambuClient to properly construct the request call.

Returns undefined | string
The root path of the request
Overrides Executable.getRootPath
- Defined in src/create-account.ts:208

getURLPath

getURLPath(tenantId?): string
getURLPath is used by the BambuClient to properly construct the request call.
Parameters
- Optional tenantId: string
  
  the tenant id defined in the BambuClient
Returns string
request url
Overrides Executable.getURLPath
- Defined in src/create-account.ts:86

prepareRequest

prepareRequest(options): Promise<any>
Parameters
- options: {
  execute: ((executable) => Promise<any>);
  }
  - execute: ((executable) => Promise<any>)
    - (executable): Promise<any>
      
      Parameters
      
      executable: Executable<any>
      
      Returns Promise<any>
Returns Promise<any>
Inherited from Executable.prepareRequest
- Defined in src/executable.ts:9

setEmail

setEmail(value): CreateAccount
Sets the email address on the account.
Parameters
- value: string
  
  email
Returns CreateAccount
- Defined in src/create-account.ts:141

setFirstName

setFirstName(value): CreateAccount
Sets the first name on the account.
Parameters
- value: string
  
  first name
Returns CreateAccount
- Defined in src/create-account.ts:121

setLastName

setLastName(value): CreateAccount
Sets the last name on the account.
Parameters
- value: string
  
  last name
Returns CreateAccount
- Defined in src/create-account.ts:131

setLedgerType

setLedgerType(value): CreateAccount
Sets the ledger type on the account.
Parameters
- value: string
  
  ledger type
Returns CreateAccount
- Defined in src/create-account.ts:161

setMetaData

setMetaData(key, value): CreateAccount
Sets any additional metadata to be stored against the account record
Parameters
- key: string
  
  the metadata attribute key
- value: string
  
  the metadata attribute value
Returns CreateAccount
- Defined in src/create-account.ts:172

setPhone

setPhone(value): CreateAccount
Sets the phone number on the account.
Parameters
- value: string
  
  phone number, should start with +{country code}
Returns CreateAccount
- Defined in src/create-account.ts:151

Class CreateAccount

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional input: CreateAccountInput

Returns CreateAccount

Properties

Private Optional _email

Private Optional _firstName

Private Optional _lastName

Private _ledgerType

Private Optional _metadata

Private Optional _phone

Methods

getBody

Returns any

getMethod

Returns Method

getResponse

Parameters

apiResponse: any

Returns CreateAccountResponse

getRootPath

Returns undefined | string

getURLPath

Parameters

Optional tenantId: string

Returns string

prepareRequest

Parameters

options: { execute: ((executable) => Promise<any>); }

execute: ((executable) => Promise<any>)

Parameters

executable: Executable<any>

Returns Promise<any>

Returns Promise<any>

setEmail

Parameters

value: string

Returns CreateAccount

setFirstName

Parameters

value: string

Returns CreateAccount

setLastName

Parameters

value: string

Returns CreateAccount

setLedgerType

Parameters

value: string

Returns CreateAccount

setMetaData

Parameters

key: string

value: string

Returns CreateAccount

setPhone

Parameters

value: string

Returns CreateAccount

Settings

Member Visibility

Theme

On This Page

`Optional` input: CreateAccountInput

`Private` `Optional` _email

`Private` `Optional` _firstName

`Private` `Optional` _lastName

`Private` _ledgerType

`Private` `Optional` _metadata

`Private` `Optional` _phone

`Optional` tenantId: string

options: {
execute: ((executable) => Promise<any>);
}