Class GetWallet

Creates a product for the provided tenant to be able to generate and mint NFTs from.

Hierarchy

Executable<WalletPass>
- GetWallet

Index

Constructors

Properties

brandId? email? passId? programId?

Methods

getBody getMethod getResponse getRootPath getURLPath prepareRequest setEmail

Constructors

constructor

new GetWallet(input?): GetWallet
Parameters
- Optional input: GetWalletInput
Returns GetWallet
Overrides Executable.constructor
- Defined in src/get-wallet.ts:90

Properties

`Optional` brandId

brandId?: number

The brand ID the wallet belongs to.

`Optional` email

email?: string

The email of the wallet

`Optional` passId

passId?: number

The pass id of the wallet card.

`Optional` programId

programId?: number

The program ID the wallet belongs to.

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/get-wallet.ts:111

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/get-wallet.ts:35

getResponse

getResponse(apiResponse): WalletPass
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 GetWalletResponse
Returns WalletPass
GetWalletResponse
Overrides Executable.getResponse
- Defined in src/get-wallet.ts:44

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/get-wallet.ts:119

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/get-wallet.ts:53

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): GetWallet
Sets the email of the person
Parameters
- value: string
  
  The email of the person
Returns GetWallet
- Defined in src/get-wallet.ts:102

Generated using TypeDoc