Class UpdateWallet

Updates an existing wallet pass either by the pass identifier or the email address used on the pass and the program identifier.

Hierarchy

Executable<WalletPass>
- UpdateWallet

Implements

Partial<WalletPassInput>

Index

Constructors

constructor

new UpdateWallet(input?): UpdateWallet
Parameters
- Optional input: Partial<WalletPassInput> & {
  brandId: number;
  }
Returns UpdateWallet
Overrides Executable.constructor
- Defined in src/update-wallet.ts:76

Properties

`Optional` brandId

brandId?: number

`Optional` currentMessage

currentMessage?: string

The current message that is displayed on the wallet pass.

`Optional` email

email?: string

`Optional` geoLocation

geoLocation?: GeoLocation

The location from which the card is being issued.

`Optional` ipAddress

ipAddress?: string

The ipaddress which is requesting the card to be issued.

`Optional` passId

passId?: number

`Optional` passdata

passdata?: WalletPassData

`Optional` person

person?: WalletPerson

The person record.

`Optional` programId

programId?: number

`Optional` templateId

templateId?: number

The templateId from which the card is being issued. If a program is provided, this is not required.

`Optional` templateTierId

templateTierId?: number

The tier to put the card in during creation, if not provided will use the default tier.

Methods

getBody

getBody(): Partial<WalletPassInput>
getBody is used by the BambuClient to properly construct the request object body.

Returns Partial<WalletPassInput>
Returns the expected body of the request utilizing the defined request attributes.
Overrides Executable.getBody
- Defined in src/update-wallet.ts:87

getMethod

getMethod(): Method
The rest function method to invoke the api with.

Returns Method
Overrides Executable.getMethod
- Defined in src/update-wallet.ts:55

getResponse

getResponse(apiResponse): WalletPass
This returns the proper response type for the execute function.
Parameters
- apiResponse: any
  
  The response from the API request.
Returns WalletPass
Overrides Executable.getResponse
- Defined in src/update-wallet.ts:59

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.ts:103

getURLPath

getURLPath(tenantId?): string
The URL path to invoke.
Parameters
- Optional tenantId: string
  
  The tenantId provided by the BambuMeta client.
Returns string
Overrides Executable.getURLPath
- Defined in src/update-wallet.ts:63

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

Class UpdateWallet

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional input: Partial<WalletPassInput> & { brandId: number; }

Returns UpdateWallet

Properties

Optional brandId

Optional currentMessage

Optional email

Optional geoLocation

Optional ipAddress

Optional passId

Optional passdata

Optional person

Optional programId

Optional templateId

Optional templateTierId

Methods

getBody

Returns Partial<WalletPassInput>

getMethod

Returns Method

getResponse

Parameters

apiResponse: any

Returns WalletPass

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>

Settings

Member Visibility

Theme

On This Page

`Optional` input: Partial<WalletPassInput> & {
brandId: number;
}

`Optional` brandId

`Optional` currentMessage

`Optional` email

`Optional` geoLocation

`Optional` ipAddress

`Optional` passId

`Optional` passdata

`Optional` person

`Optional` programId

`Optional` templateId

`Optional` templateTierId

`Optional` tenantId: string

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