@collectivtech/alana-sdk-js

---

@collectivtech/alana-sdk-js / resource / ApiResource

Abstract Class: ApiResource

Defined in: src/resource.ts:144

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.

Extended by

• UserAddress
• Notification
• Profile
• Auth
• Brand
• Business
• Businesses
• Coin
• Coins
• CreditEntry
• CreditContract
• Experience
• Experiences
• SecureFile
• SecureFileStore
• Location
• Locations
• Membership
• Memberships
• Plugin
• Plugins
• Product
• Products
• Ticket
• Purchase
• Purchases
• CoinContractClass
• Businesses
• Coins
• Experiences
• Memberships
• Products
• MinimalUser
• Users
• Venue
• Venues

Constructors

Constructor

new ApiResource(context): ApiResource

Defined in: src/resource.ts:155

Create a new API resource.

Parameters

context

ApiContext

The API context to use for this resource

Returns

ApiResource

Properties

_context

protected _context: ApiContext

Defined in: src/resource.ts:148

The API context for this resource.