Class BricksetApiClient

Index

Constructors

Methods

checkKey checkUserHash getAdditionalImages getInstructions getInstructionsBySetNumber getKeyUsageStats getMinifigCollection getReviews getSet getSets getSubthemes getThemes getUserMinifigNotes getUserNotes getYears login setCollection setMinifigCollection

Constructors

constructor

new BricksetApiClient(apiKey): BricksetApiClient
Parameters
- apiKey: string
Returns BricksetApiClient
- Defined in brickset-api.client.ts:39

Methods

checkKey

checkKey(): Promise<boolean>
Check if API key is valid.

Returns Promise<boolean>
- Defined in brickset-api.client.ts:44

checkUserHash

checkUserHash(userHash): Promise<boolean>
Check if a userHash key is valid.
Parameters
- userHash: string
Returns Promise<boolean>
- Defined in brickset-api.client.ts:52

getAdditionalImages

getAdditionalImages(setID): Promise<BricksetImage[]>
Get a list of URLs of additional set images for the specified set.
Parameters
- setID: number
Returns Promise<BricksetImage[]>
- Defined in brickset-api.client.ts:180

getInstructions

getInstructions(setID): Promise<instruction[]>
Get a list of instructions for the specified set.
Parameters
- setID: number
Returns Promise<instruction[]>
- Defined in brickset-api.client.ts:191

getInstructionsBySetNumber

getInstructionsBySetNumber(setNumber): Promise<instruction[]>
Get a list of instructions for the specified set without the need to look up the set ID first.
Parameters
- setNumber: string
Returns Promise<instruction[]>
- Defined in brickset-api.client.ts:202

getKeyUsageStats

getKeyUsageStats(): Promise<apiKeyUsage[]>
Get key usage stats for the last 30 days. Note that only calls to the getSets method count against key usage.

Returns Promise<apiKeyUsage[]>
- Defined in brickset-api.client.ts:60

getMinifigCollection

getMinifigCollection(params, userHash): Promise<minifigCollection[]>
Get a list of minifigs owned/wanted by a user.
Parameters
- params: getMinifigCollectionParams
- userHash: string
Returns Promise<minifigCollection[]>
- Defined in brickset-api.client.ts:285

getReviews

getReviews(setID): Promise<review[]>
Get user reviews for the specified set.
Parameters
- setID: number
Returns Promise<review[]>
- Defined in brickset-api.client.ts:213

getSet

getSet(setNumber): Promise<undefined | BricksetSet>
Get a set by setNumber
Parameters
- setNumber: string
  12345-1
Returns Promise<undefined | BricksetSet>
BricksetSet | undefined
- Defined in brickset-api.client.ts:172

getSets

getSets(params, userHash?): Promise<BricksetSet[]>
Retrieve a list of sets, or more information about a particular one. This endpoint is limited to 100 calls a day per key
Parameters
- params: getSetParams
  getSetParams
- userHash: string = ""
Returns Promise<BricksetSet[]>
- Defined in brickset-api.client.ts:89

getSubthemes

getSubthemes(theme): Promise<subtheme[]>
Get a list of subthemes for a given theme, with the total number of sets in each.
Parameters
- theme: string
Returns Promise<subtheme[]>
- Defined in brickset-api.client.ts:234

getThemes

getThemes(): Promise<theme[]>
Get a list of themes, with the total number of sets in each.

Returns Promise<theme[]>
- Defined in brickset-api.client.ts:226

getUserMinifigNotes

getUserMinifigNotes(userHash): Promise<userMinifigNote[]>
Get all of a user's minifigure notes.
Parameters
- userHash: string
Returns Promise<userMinifigNote[]>
- Defined in brickset-api.client.ts:342

getUserNotes

getUserNotes(userHash): Promise<userNote[]>
Get all of a user's set notes.
Parameters
- userHash: string
Returns Promise<userNote[]>
- Defined in brickset-api.client.ts:331

getYears

getYears(theme?): Promise<year[]>
Get a list of years for a given theme, with the total number of sets in each.
Parameters
- theme: string = ""
Returns Promise<year[]>
- Defined in brickset-api.client.ts:247

login

login(username, password): Promise<string>
Log in as a user and retrieve a token that can be used in subsequent API calls.
Parameters
- username: string
- password: string
Returns Promise<string>
- Defined in brickset-api.client.ts:73

setCollection

setCollection(setID, params, userHash): Promise<boolean>
Set a user's collection details.
Parameters
- setID: number
- params: setCollectionParams
- userHash: string
Returns Promise<boolean>
- Defined in brickset-api.client.ts:257

setMinifigCollection

setMinifigCollection(minifigNumber, params, userHash): Promise<boolean>
Add/change a user's 'loose' minifig collection. Note: due to the way this method works pass either own/want/qtyowned OR notes
Parameters
- minifigNumber: string
- params: setMinifigCollectionParams
- userHash: string
Returns Promise<boolean>
- Defined in brickset-api.client.ts:307