@collectivtech/alana-sdk-js / resources/coin / Coin
Class: Coin
Defined in: src/resources/coin.ts:4
Base class for an API resource object.
This is an abstract class. You shouldn't create objects from it directly, but instead use one of the defined subclasses, which handle the needed conversion to and from raw JSON.
All resource classes hold a reference to a context object, and this may be a shared object to allow for state tracking.
Extends
Extended by
Constructors
Constructor
new Coin(
apiResponse,context):Coin
Defined in: src/resources/coin.ts:53
Parameters
apiResponse
any
context
Returns
Coin
Overrides
Properties
_context
protected_context:ApiContext
Defined in: src/resource.ts:148
The API context for this resource.
Inherited from
children?
optionalchildren?:Coin[]
Defined in: src/resources/coin.ts:51
A list of this credit's child credits, if any.
description?
optionaldescription?:string
Defined in: src/resources/coin.ts:18
A short description of this credit, provided by the issuer.
id
id:
number
Defined in: src/resources/coin.ts:8
A unique and opaque ID for this credit.
issuer
issuer:
Business
Defined in: src/resources/coin.ts:24
The issuer of this credit. This will be an ALANA partner or brand. Note: The ALANA Platform itself does not issue credits or coins.
logo?
optionallogo?:string
Defined in: src/resources/coin.ts:41
An optional URL for this credit's logo. Most credits won't have logos, but partners may choose to provide a logo for their coins.
maxQuantity
maxQuantity:
number
Defined in: src/resources/coin.ts:35
The maximum number of this Coin that can be issued in total.
name
name:
string
Defined in: src/resources/coin.ts:13
The name of this credit.
parentId?
optionalparentId?:number
Defined in: src/resources/coin.ts:46
The internal ID of this credit's parent credit, if any.
rewardsValue
rewardsValue:
number
Defined in: src/resources/coin.ts:30
The base value of this credit in ALANA Rewards, aka ALANA Coins. Rewards serve as the base "currency" of the ALANA Platform.