Class UpdateWalletNotification

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<UpdateWalletNotificationResponse>
- UpdateWalletNotification

Index

Constructors

constructor

new UpdateWalletNotification(input?): UpdateWalletNotification
Parameters
- Optional input: UpdateWalletNotificationInput
Returns UpdateWalletNotification
Overrides Executable.constructor
- Defined in src/update-wallet-notification.ts:79

Properties

`Private` `Optional` _passId

_passId?: number

`Private` `Optional` _personId

_personId?: string

`Private` `Optional` _serialNo

_serialNo?: 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-notification.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-notification.ts:48

getResponse

getResponse(apiResponse): UpdateWalletNotificationResponse
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 UpdateWalletNotificationResponse
Returns UpdateWalletNotificationResponse
UpdateWalletNotificationResponse
Overrides Executable.getResponse
- Defined in src/update-wallet-notification.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-notification.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-notification.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

setPassId

setPassId(value): UpdateWalletNotification
Sets the card passId
Parameters
- value: number
  
  wallet card id.
Returns UpdateWalletNotification
- Defined in src/update-wallet-notification.ts:113

setPersonId

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

setSerialNo

setSerialNo(value): UpdateWalletNotification
Sets the serial number card.
Parameters
- value: string
  
  email
Returns UpdateWalletNotification
- Defined in src/update-wallet-notification.ts:103

Class UpdateWalletNotification

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional input: UpdateWalletNotificationInput

Returns UpdateWalletNotification

Properties

Private Optional _passId

Private Optional _personId

Private Optional _serialNo

Methods

getBody

Returns any

getMethod

Returns Method

getResponse

Parameters

apiResponse: any

Returns UpdateWalletNotificationResponse

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>

setPassId

Parameters

value: number

Returns UpdateWalletNotification

setPersonId

Parameters

value: string

Returns UpdateWalletNotification

setSerialNo

Parameters

value: string

Returns UpdateWalletNotification

Settings

Member Visibility

Theme

On This Page

`Optional` input: UpdateWalletNotificationInput

`Private` `Optional` _passId

`Private` `Optional` _personId

`Private` `Optional` _serialNo

`Optional` tenantId: string

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