Class UpdateWalletMessage

The Update Wallet message takes a personId or email address and a message and uses that information to identify an existing wallet card within the tenant. Then the message field on the card is udpated.

Hierarchy

Executable<UpdateWalletMessageResponse>
- UpdateWalletMessage

Index

Constructors

constructor

new UpdateWalletMessage(input?): UpdateWalletMessage
Parameters
- Optional input: UpdateWalletMessageInput
Returns UpdateWalletMessage
Overrides Executable.constructor
- Defined in src/update-wallet-message.ts:79

Properties

`Private` `Optional` _email

_email?: string

`Private` `Optional` _message

_message?: string

`Private` `Optional` _personId

_personId?: 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/update-wallet-message.ts:122

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/update-wallet-message.ts:48

getResponse

getResponse(apiResponse): UpdateWalletMessageResponse
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 UpdateWalletMessageResponse
Returns UpdateWalletMessageResponse
UpdateWalletMessageResponse
Overrides Executable.getResponse
- Defined in src/update-wallet-message.ts:57

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/update-wallet-message.ts:140

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/update-wallet-message.ts:69

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): UpdateWalletMessage
Sets the email address on the person.
Parameters
- value: string
  
  email
Returns UpdateWalletMessage
- Defined in src/update-wallet-message.ts:103

setMessage

setMessage(value): UpdateWalletMessage
Sets the message on the wallet card
Parameters
- value: string
  
  message to be updated.
Returns UpdateWalletMessage
- Defined in src/update-wallet-message.ts:113

setPersonId

setPersonId(value): UpdateWalletMessage
Sets the personId on the person.
Parameters
- value: string
  
  person id
Returns UpdateWalletMessage
- Defined in src/update-wallet-message.ts:93

Class UpdateWalletMessage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional input: UpdateWalletMessageInput

Returns UpdateWalletMessage

Properties

Private Optional _email

Private Optional _message

Private Optional _personId

Methods

getBody

Returns any

getMethod

Returns Method

getResponse

Parameters

apiResponse: any

Returns UpdateWalletMessageResponse

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 UpdateWalletMessage

setMessage

Parameters

value: string

Returns UpdateWalletMessage

setPersonId

Parameters

value: string

Returns UpdateWalletMessage

Settings

Member Visibility

Theme

On This Page

`Optional` input: UpdateWalletMessageInput

`Private` `Optional` _email

`Private` `Optional` _message

`Private` `Optional` _personId

`Optional` tenantId: string

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