Discojs | discojs

Discojs.

Hierarchy

Index

Constructors

constructor

Properties

User Identity Methods

User Profile Methods

User Submissions Methods

User Contributions Methods

User Collection Methods

User Folder Methods

Database Methods

Helpers Methods

Marketplace Methods

User Methods

Constructors

constructor

new Discojs(options?: DiscojsOptions): Discojs

- Defined in src/discojs.ts:59
Parameters
- Optional options: DiscojsOptions
Returns Discojs

Properties

outputFormat

outputFormat: OutputFormat

userAgent

userAgent: string

User Identity Methods

getIdentity

getIdentity(this: Discojs): Promise<{} & {}>

Inherited from UserIdentity.getIdentity
- Defined in src/userIdentity.ts:33
Retrieve basic information about the authenticated user.

remarks

You can use this resource to find out who you’re authenticated as, and it also doubles as a good sanity check to ensure that you’re using OAuth correctly.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-identity

Parameters
- this: Discojs
Returns Promise<{} & {}>

Protected getUsername

getUsername(this: Discojs): Promise<string>

Inherited from UserIdentity.getUsername
- Defined in src/userIdentity.ts:47
Retrieve authenticated user's username.

remarks

Used internally within methods that use username as a param.

Parameters
- this: Discojs
Returns Promise<string>

User Profile Methods

editProfile

editProfile(this: Discojs, options: ProfileOptions): Promise<{} & {} & {}>

Inherited from UserIdentity.editProfile
- Defined in src/userIdentity.ts:86
Edit a user’s profile data.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-profile

Parameters
- this: Discojs
- options: ProfileOptions
Returns Promise<{} & {} & {}>

getProfile

getProfile(this: Discojs): Promise<{} & {} & {}>

Inherited from UserIdentity.getProfile
- Defined in src/userIdentity.ts:74
Retrieve authenticated user's profile.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-profile

Parameters
- this: Discojs
Returns Promise<{} & {} & {}>

getProfileForUser

getProfileForUser(this: Discojs, username: string): Promise<{} & {} & {}>

Inherited from UserIdentity.getProfileForUser
- Defined in src/userIdentity.ts:63
Retrieve user's profile by username.

remarks

If authenticated as the requested user, the email key will be visible, and the num_list count will include the user’s private lists. If authenticated as the requested user or the user’s collection/wantlist is public, the num_collection / num_wantlist keys will be visible.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-profile

Parameters
- this: Discojs
- username: string
Returns Promise<{} & {} & {}>

User Submissions Methods

getSubmissions

getSubmissions(this: Discojs, pagination?: Pagination): Promise<{}>

Inherited from UserIdentity.getSubmissions
- Defined in src/userIdentity.ts:109
Retrieve authenticated user’s submissions.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-user-submissions

Parameters
- this: Discojs
- Optional pagination: Pagination
Returns Promise<{}>

getSubmissionsForUser

getSubmissionsForUser(this: Discojs, username: string, pagination?: Pagination): Promise<{}>

Inherited from UserIdentity.getSubmissionsForUser
- Defined in src/userIdentity.ts:98
Retrieve a user’s submissions by username.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-user-submissions

Parameters
- this: Discojs
- username: string
- Optional pagination: Pagination
Returns Promise<{}>

User Contributions Methods

getContributions

getContributions(this: Discojs, sort?: SortOptions<UserSortEnum>, pagination?: Pagination): Promise<{}>

Inherited from UserIdentity.getContributions
- Defined in src/userIdentity.ts:140
Retrieve authenticated user’s contributions.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-user-contributions

Parameters
- this: Discojs
- Optional sort: SortOptions<UserSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getContributionsForUser

getContributionsForUser(this: Discojs, username: string, sort?: SortOptions<UserSortEnum>, pagination?: Pagination): Promise<{}>

Inherited from UserIdentity.getContributionsForUser
- Defined in src/userIdentity.ts:121
Retrieve a user’s contributions by username.

link

https://www.discogs.com/developers#page:user-identity,header:user-identity-user-contributions

Parameters
- this: Discojs
- username: string
- Optional sort: SortOptions<UserSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

User Collection Methods

createFolder

createFolder(this: Discojs, name: string): Promise<{} & {}>

Inherited from UserCollection.createFolder
- Defined in src/userCollection.ts:51
Create a new folder in authenticated user’s collection.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection

Parameters
- this: Discojs
- name: string
Returns Promise<{} & {}>

listFolders

listFolders(this: Discojs): Promise<{}>

Inherited from UserCollection.listFolders
- Defined in src/userCollection.ts:39
Retrieve a list of folders in authenticated user’s collection.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection

Parameters
- this: Discojs
Returns Promise<{}>

listFoldersForUser

listFoldersForUser(this: Discojs, username: string): Promise<{}>

Inherited from UserCollection.listFoldersForUser
- Defined in src/userCollection.ts:28
Retrieve a list of folders in a user’s collection.

remarks

If the collection has been made private by its owner, authentication as the collection owner is required. If you are not authenticated as the collection owner, only folder ID 0 (the “All” folder) will be visible (if the requested user’s collection is public).

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection

Parameters
- this: Discojs
- username: string
Returns Promise<{}>

User Folder Methods

deleteFolder

deleteFolder(this: Discojs, folderId: FolderIdsEnum | number): Promise<EmptyResponse>

Inherited from UserCollection.deleteFolder
- Defined in src/userCollection.ts:109
Delete a folder from a user’s collection.

remarks

A folder must be empty before it can be deleted.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
Returns Promise<EmptyResponse>

editFolder

editFolder(this: Discojs, folderId: FolderIdsEnum | number, name: string): Promise<{} & {}>

Inherited from UserCollection.editFolder
- Defined in src/userCollection.ts:92
Edit a folder’s metadata.

remarks

Folders 0 and 1 cannot be renamed.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- name: string
Returns Promise<{} & {}>

getFolder

getFolder(this: Discojs, folderId: FolderIdsEnum | number): Promise<{} & {}>

Inherited from UserCollection.getFolder
- Defined in src/userCollection.ts:77
Retrieve metadata about a folder in authenticated user’s collection.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
Returns Promise<{} & {}>

getFolderForUser

getFolderForUser(this: Discojs, username: string, folderId: FolderIdsEnum | number): Promise<{} & {}>

Inherited from UserCollection.getFolderForUser
- Defined in src/userCollection.ts:66
Retrieve metadata about a folder in a user’s collection.

remarks

If folder_id is not 0, authentication as the collection owner is required.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- username: string
- folderId: FolderIdsEnum | number
Returns Promise<{} & {}>

Database Methods

deleteReleaseRating

deleteReleaseRating(this: Discojs, releaseId: number): Promise<EmptyResponse>

Inherited from Database.deleteReleaseRating
- Defined in src/database.ts:103
Deletes the release’s rating for the authenticated user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- releaseId: number
Returns Promise<EmptyResponse>

getArtist

getArtist(this: Discojs, artistId: number): Promise<{} & {} & {} & {}>

Inherited from Database.getArtist
- Defined in src/database.ts:172
Get an artist.

label

Artist

link

https://www.discogs.com/developers#page:database,header:database-artist

Parameters
- this: Discojs
- artistId: number
Returns Promise<{} & {} & {} & {}>

getArtistReleases

getArtistReleases(this: Discojs, artistId: number, sort?: SortOptions<ReleaseSortEnum>, pagination?: Pagination): Promise<{}>

Inherited from Database.getArtistReleases
- Defined in src/database.ts:184
Returns a list of releases and masters associated with an artist.

label

Artist Releases

link

https://www.discogs.com/developers#page:database,header:database-artist-releases

Parameters
- this: Discojs
- artistId: number
- Optional sort: SortOptions<ReleaseSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getCommunityReleaseRating

getCommunityReleaseRating(this: Discojs, releaseId: number): Promise<{}>

Inherited from Database.getCommunityReleaseRating
- Defined in src/database.ts:116
Retrieves the community release rating average and count.

label

Community Release Rating

link

https://www.discogs.com/developers#page:database,header:database-community-release-rating

Parameters
- this: Discojs
- releaseId: number
Returns Promise<{}>

getLabel

getLabel(this: Discojs, labelId: number): Promise<{} & {} & {}>

Inherited from Database.getLabel
- Defined in src/database.ts:204
Get a label.

label

Label

link

https://www.discogs.com/developers#page:database,header:database-label

Parameters
- this: Discojs
- labelId: number
Returns Promise<{} & {} & {}>

getLabelReleases

getLabelReleases(this: Discojs, labelId: number, pagination?: Pagination): Promise<{}>

Inherited from Database.getLabelReleases
- Defined in src/database.ts:216
Returns a list of releases associated with the label.

label

Label Releases

link

https://www.discogs.com/developers#page:database,header:database-all-label-releases

Parameters
- this: Discojs
- labelId: number
- Optional pagination: Pagination
Returns Promise<{}>

getMaster

getMaster(this: Discojs, masterId: number): Promise<{} & {}>

Inherited from Database.getMaster
- Defined in src/database.ts:147
Get a master release.

label

Master Release

link

https://www.discogs.com/developers#page:database,header:database-master-release

Parameters
- this: Discojs
- masterId: number
Returns Promise<{} & {}>

getMasterVersions

getMasterVersions(this: Discojs, masterId: number, pagination?: Pagination): Promise<{}>

Inherited from Database.getMasterVersions
- Defined in src/database.ts:160
Retrieves a list of all releases that are versions of a master.

label

Master Release Versions

link

https://www.discogs.com/developers#page:database,header:database-master-release-versions

Parameters
- this: Discojs
- masterId: number
- Optional pagination: Pagination
Returns Promise<{}>

getRelease

getRelease(this: Discojs, releaseId: number, currency?: CurrenciesEnum): Promise<{} & {} & {}>

Inherited from Database.getRelease
- Defined in src/database.ts:51
Get a release.

label

Release

link

https://www.discogs.com/developers#page:database,header:database-release

Parameters
- this: Discojs
- releaseId: number
- Optional currency: CurrenciesEnum
Returns Promise<{} & {} & {}>

getReleaseRating

getReleaseRating(this: Discojs, releaseId: number): Promise<{}>

Inherited from Database.getReleaseRating
- Defined in src/database.ts:75
Retrieves the release’s rating for the authenticated user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- releaseId: number
Returns Promise<{}>

getReleaseRatingForUser

getReleaseRatingForUser(this: Discojs, username: string, releaseId: number): Promise<{}>

Inherited from Database.getReleaseRatingForUser
- Defined in src/database.ts:63
Retrieves the release’s rating for a given user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- username: string
- releaseId: number
Returns Promise<{}>

getReleaseStats

getReleaseStats(this: Discojs, releaseId: number): Promise<ReleaseStatsResponse>

Inherited from Database.getReleaseStats
- Defined in src/database.ts:131
Retrieves the total number of “haves” (in the community’s collections) and “wants” (in the community’s wantlists) for a given release.

label

Release Stats

link

https://www.discogs.com/developers#page:database,header:database-release-stats

Note: This endpoint is broken, see link below for a workaround.

link

https://www.discogs.com/fr/forum/thread/865093?message_id=8630743

Parameters
- this: Discojs
- releaseId: number
Returns Promise<ReleaseStatsResponse>

searchArtist

searchArtist(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

Inherited from Database.searchArtist
- Defined in src/database.ts:264
Search for an artist.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchDatabase

searchDatabase(this: Discojs, options?: SearchOptions, pagination?: Pagination): Promise<{}>

Inherited from Database.searchDatabase
- Defined in src/database.ts:228
Issue a search query to Discogs database.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchLabel

searchLabel(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

Inherited from Database.searchLabel
- Defined in src/database.ts:276
Search for a label.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchMaster

searchMaster(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

Inherited from Database.searchMaster
- Defined in src/database.ts:252
Search for a master release.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchRelease

searchRelease(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

Inherited from Database.searchRelease
- Defined in src/database.ts:240
Search for a release.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

updateReleaseRating

updateReleaseRating(this: Discojs, releaseId: number, rating: RatingValues): Promise<{}>

Inherited from Database.updateReleaseRating
- Defined in src/database.ts:88
Updates the release’s rating for the authenticated user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- releaseId: number
- rating: RatingValues
Returns Promise<{}>

Helpers Methods

fetchImage

fetchImage(imageUrl: string): Promise<Blob>

- Defined in src/discojs.ts:176
Retrieve an image retrieved in another response.

requires

authentication

link

https://www.discogs.com/developers#page:images

Parameters
- imageUrl: string
Returns Promise<Blob>

Static getReleaseConditions

getReleaseConditions(): (MINT | NEAR_MINT | VERY_GOOD_PLUS | VERY_GOOD | GOOD_PLUS | GOOD | FAIR | POOR)[]

- Defined in src/discojs.ts:111
Return release conditions supported by Discogs.

static

Returns (MINT | NEAR_MINT | VERY_GOOD_PLUS | VERY_GOOD | GOOD_PLUS | GOOD | FAIR | POOR)[]

Static getSleeveConditions

getSleeveConditions(): (MINT | NEAR_MINT | VERY_GOOD_PLUS | VERY_GOOD | GOOD_PLUS | GOOD | FAIR | POOR | GENERIC | NOT_GRADED | NO_COVER)[]

- Defined in src/discojs.ts:122
Return slevve conditions supported by Discogs.

static

Returns (MINT | NEAR_MINT | VERY_GOOD_PLUS | VERY_GOOD | GOOD_PLUS | GOOD | FAIR | POOR | GENERIC | NOT_GRADED | NO_COVER)[]

Static getSupportedCurrencies

getSupportedCurrencies(): (USD | GBP | EUR | CAD | AUD | JPY | CHF | MXN | BRL | NZD | SEK | ZAR)[]

- Defined in src/discojs.ts:100
Return currencies supported by Discogs.

static

Returns (USD | GBP | EUR | CAD | AUD | JPY | CHF | MXN | BRL | NZD | SEK | ZAR)[]

Marketplace Methods

createListing

createListing(this: Discojs, options: ListingOptions): Promise<{} & {}>

Inherited from MarketPlace.createListing
- Defined in src/marketplace.ts:140
Create a Marketplace listing.

label

New Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-new-listing

Parameters
- this: Discojs
- options: ListingOptions
Returns Promise<{} & {}>

deleteListing

deleteListing(this: Discojs, listingId: number): Promise<EmptyResponse>

Inherited from MarketPlace.deleteListing
- Defined in src/marketplace.ts:128
Permanently remove a listing from the Marketplace.

label

Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-listing

Parameters
- this: Discojs
- listingId: number
Returns Promise<EmptyResponse>

editListing

editListing(this: Discojs, listingId: number, options: ListingOptions, currency?: CurrenciesEnum): Promise<EmptyResponse>

Inherited from MarketPlace.editListing
- Defined in src/marketplace.ts:116
Edit the data associated with a listing.

remarks

If the listing’s status is not For Sale, Draft, or Expired, it cannot be modified – only deleted.

label

Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-listing

Parameters
- this: Discojs
- listingId: number
- options: ListingOptions
- Optional currency: CurrenciesEnum
Returns Promise<EmptyResponse>

editOrder

editOrder(this: Discojs, orderId: number, status?: EditOrderStatusesEnum, shipping?: undefined | number): Promise<{} & {}>

Inherited from MarketPlace.editOrder
- Defined in src/marketplace.ts:164
Edit the data associated with an order.

label

Order

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-order

Parameters
- this: Discojs
- orderId: number
- Optional status: EditOrderStatusesEnum
- Optional shipping: undefined | number
Returns Promise<{} & {}>

getInventory

getInventory(this: Discojs, status?: InventoryStatusesEnum, sort?: SortOptions<InventorySortEnum>, pagination?: Pagination): Promise<{}>

Inherited from MarketPlace.getInventory
- Defined in src/marketplace.ts:79
Get authenticated user’s inventory.

label

Inventory

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-inventory

Parameters
- this: Discojs
- Optional status: InventoryStatusesEnum
- Optional sort: SortOptions<InventorySortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getInventoryForUser

getInventoryForUser(this: Discojs, username: string, status?: InventoryStatusesEnum, sort?: SortOptions<InventorySortEnum>, pagination?: Pagination): Promise<{}>

Inherited from MarketPlace.getInventoryForUser
- Defined in src/marketplace.ts:57
Get a seller’s inventory.

remarks

If you are not authenticated as the inventory owner, only items that have a status of For Sale will be visible. If you are authenticated as the inventory owner you will get additional weight, format_quantity, external_id, and location keys. If the user is authorized, the listing will contain a in_cart boolean field indicating whether or not this listing is in their cart.

label

Inventory

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-inventory

Parameters
- this: Discojs
- username: string
- Default value status: InventoryStatusesEnum = InventoryStatusesEnum.ALL
- Optional sort: SortOptions<InventorySortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getListing

getListing(this: Discojs, listingId: number, currency?: CurrenciesEnum): Promise<{} & {} & {}>

Inherited from MarketPlace.getListing
- Defined in src/marketplace.ts:101
View the data associated with a listing.

remarks

If the authorized user is the listing owner the listing will include the weight, format_quantity, external_id, and location keys. If the user is authorized, the listing will contain a in_cart boolean field indicating whether or not this listing is in their cart.

label

Listing

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-listing

Parameters
- this: Discojs
- listingId: number
- Optional currency: CurrenciesEnum
Returns Promise<{} & {} & {}>

getMarketplaceStatistics

getMarketplaceStatistics(this: Discojs, releaseId: number, currency?: CurrenciesEnum): Promise<{}>

Inherited from MarketPlace.getMarketplaceStatistics
- Defined in src/marketplace.ts:268
Retrieve marketplace statistics for the provided Release ID.

remarks

These statistics reflect the state of the release in the marketplace currently, and include the number of items currently for sale, lowest listed price of any item for sale, and whether the item is blocked for sale in the marketplace.

label

Release Statistics

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-release-statistics

Parameters
- this: Discojs
- releaseId: number
- Optional currency: CurrenciesEnum
Returns Promise<{}>

getOrder

getOrder(this: Discojs, orderId: number): Promise<{} & {}>

Inherited from MarketPlace.getOrder
- Defined in src/marketplace.ts:152
View the data associated with an order.

label

Order

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-order

Parameters
- this: Discojs
- orderId: number
Returns Promise<{} & {}>

getPriceSuggestions

getPriceSuggestions(this: Discojs, releaseId: number): Promise<{}>

Inherited from MarketPlace.getPriceSuggestions
- Defined in src/marketplace.ts:251
Retrieve price suggestions for the provided Release ID.

remarks

Suggested prices will be denominated in the user’s selling currency.

label

Price Suggestions

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-price-suggestions

Parameters
- this: Discojs
- releaseId: number
Returns Promise<{}>

listOrderMessages

listOrderMessages(this: Discojs, orderId: number): Promise<{}>

Inherited from MarketPlace.listOrderMessages
- Defined in src/marketplace.ts:199
Returns a list of the order’s messages with the most recent first.

label

Order Messages

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-list-order-messages

Parameters
- this: Discojs
- orderId: number
Returns Promise<{}>

listOrders

listOrders(this: Discojs, status?: OrderStatusesEnum, archived?: undefined | false | true, sort?: SortOptions<OrderSortEnum>, pagination?: Pagination): Promise<OrdersResponse>

Inherited from MarketPlace.listOrders
- Defined in src/marketplace.ts:176
Returns a list of the authenticated user’s orders.

label

List Orders

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-list-orders

Parameters
- this: Discojs
- Optional status: OrderStatusesEnum
- Optional archived: undefined | false | true
- Optional sort: SortOptions<OrderSortEnum>
- Optional pagination: Pagination
Returns Promise<OrdersResponse>

sendOrderMessage

sendOrderMessage(this: Discojs, orderId: number, message?: undefined | string, status?: OrderStatusesEnum): Promise<{} & {} & {} & {} & {}>

Inherited from MarketPlace.sendOrderMessage
- Defined in src/marketplace.ts:216
Adds a new message to the order’s message log.

remarks

When posting a new message, you can simultaneously change the order status. If you do, the message will automatically be prepended with: "Seller changed status from Old Status to New Status" While message and status are each optional, one or both must be present.

label

Order Messages

link

https://www.discogs.com/developers#page:marketplace,header:marketplace-list-order-messages

Parameters
- this: Discojs
- orderId: number
- Optional message: undefined | string
- Optional status: OrderStatusesEnum
Returns Promise<{} & {} & {} & {} & {}>

User Methods

addReleaseToFolder

addReleaseToFolder(this: Discojs, releaseId: number, folderId?: FolderIdsEnum | number): Promise<{} & {}>

Inherited from UserCollection.addReleaseToFolder
- Defined in src/userCollection.ts:200
Add a release to a folder in authenticated user’s collection.

label

Add To Collection Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-add-to-collection-folder

Parameters
- this: Discojs
- releaseId: number
- Default value folderId: FolderIdsEnum | number = FolderIdsEnum.UNCATEGORIZED
Returns Promise<{} & {}>

addToWantlist

addToWantlist(this: Discojs, releaseId: number, notes?: undefined | string, rating?: RatingValues): Promise<{} & {}>

Inherited from UserWantlist.addToWantlist
- Defined in src/userWantlist.ts:48
Add a release to authenticated user’s wantlist.

label

Add to wantlist

link

https://www.discogs.com/developers#page:user-wantlist,header:user-wantlist-add-to-wantlist

Parameters
- this: Discojs
- releaseId: number
- Optional notes: undefined | string
- Optional rating: RatingValues
Returns Promise<{} & {}>

deleteReleaseInstanceFromFolder

deleteReleaseInstanceFromFolder(this: Discojs, folderId: FolderIdsEnum | number, releaseId: number, instanceId: number): Promise<EmptyResponse>

Inherited from UserCollection.deleteReleaseInstanceFromFolder
- Defined in src/userCollection.ts:269
Remove an instance of a release from authenticated user’s collection folder.

label

Delete Instance From Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-delete-instance-from-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
Returns Promise<EmptyResponse>

editCustomFieldForInstance

editCustomFieldForInstance(this: Discojs, folderId: FolderIdsEnum | number, releaseId: number, instanceId: number, fieldId: number, value: string): Promise<EmptyResponse>

Inherited from UserCollection.editCustomFieldForInstance
- Defined in src/userCollection.ts:320
Change the value of a notes field on a particular instance.

label

Edit Fields Instance

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-edit-fields-instance

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
- fieldId: number
- value: string
Returns Promise<EmptyResponse>

editReleaseInstanceRating

editReleaseInstanceRating(this: Discojs, folderId: FolderIdsEnum | number, releaseId: number, instanceId: number, rating: RatingValues): Promise<EmptyResponse>

Inherited from UserCollection.editReleaseInstanceRating
- Defined in src/userCollection.ts:221
Change the rating on a release.

label

Change Rating Of Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-change-rating-of-release

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
- rating: RatingValues
Returns Promise<EmptyResponse>

getCollectionValue

getCollectionValue(this: Discojs): Promise<{}>

Inherited from UserCollection.getCollectionValue
- Defined in src/userCollection.ts:346
Returns the minimum, median, and maximum value of authenticated user’s collection.

requires

authentication

label

Collection Value

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-value

Parameters
- this: Discojs
Returns Promise<{}>

getListItems

getListItems(this: Discojs, listId: number): Promise<{}>

Inherited from UserLists.getListItems
- Defined in src/userLists.ts:45
Returns items from a specified list.

remarks

Private lists will only display when authenticated as the owner.

label

Lists

link

https://www.discogs.com/developers#page:user-lists,header:user-lists-user-lists

Parameters
- this: Discojs
- listId: number
Returns Promise<{}>

getLists

getLists(this: Discojs, pagination?: Pagination): Promise<{}>

Inherited from UserLists.getLists
- Defined in src/userLists.ts:29
Returns authenticated user’s lists.

label

Lists

link

https://www.discogs.com/developers#page:user-lists,header:user-lists-user-lists

Parameters
- this: Discojs
- Optional pagination: Pagination
Returns Promise<{}>

getListsForUser

getListsForUser(this: Discojs, username: string, pagination?: Pagination): Promise<{}>

Inherited from UserLists.getListsForUser
- Defined in src/userLists.ts:17
Returns user’s lists.

remarks

Private lists will only display when authenticated as the owner.

label

Lists

link

https://www.discogs.com/developers#page:user-lists,header:user-lists-user-lists

Parameters
- this: Discojs
- username: string
- Optional pagination: Pagination
Returns Promise<{}>

getWantlist

getWantlist(this: Discojs, pagination?: Pagination): Promise<{}>

Inherited from UserWantlist.getWantlist
- Defined in src/userWantlist.ts:35
Returns the list of releases in authenticated user’s wantlist. Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release.

label

Wantlist

link

https://www.discogs.com/developers#page:user-wantlist,header:user-wantlist-wantlist

Parameters
- this: Discojs
- Optional pagination: Pagination
Returns Promise<{}>

getWantlistForUser

getWantlistForUser(this: Discojs, username: string, pagination?: Pagination): Promise<{}>

Inherited from UserWantlist.getWantlistForUser
- Defined in src/userWantlist.ts:21
Returns the list of releases in a user’s wantlist. Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release.

remarks

If the wantlist has been made private by its owner, you must be authenticated as the owner to view it. The notes field will be visible if you are authenticated as the wantlist owner.

label

Wantlist

link

https://www.discogs.com/developers#page:user-wantlist,header:user-wantlist-wantlist

Parameters
- this: Discojs
- username: string
- Optional pagination: Pagination
Returns Promise<{}>

listCustomFields

listCustomFields(this: Discojs): Promise<{}>

Inherited from UserCollection.listCustomFields
- Defined in src/userCollection.ts:307
Retrieve a list of authenticated user-defined collection notes fields. These fields are available on every release in the collection.

label

List Custom Fields

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-list-custom-fields

Parameters
- this: Discojs
Returns Promise<{}>

listCustomFieldsForUser

listCustomFieldsForUser(this: Discojs, username: string): Promise<{}>

Inherited from UserCollection.listCustomFieldsForUser
- Defined in src/userCollection.ts:295
Retrieve a list of user-defined collection notes fields. These fields are available on every release in the collection.

remarks

If the collection has been made private by its owner, authentication as the collection owner is required. If you are not authenticated as the collection owner, only fields with public set to true will be visible.

label

List Custom Fields

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-list-custom-fields

Parameters
- this: Discojs
- username: string
Returns Promise<{}>

listItemsByRelease

listItemsByRelease(this: Discojs, release_id: number, pagination?: Pagination): Promise<{}>

Inherited from UserCollection.listItemsByRelease
- Defined in src/userCollection.ts:140
View authenticated user’s collection folders which contain a specified release. This will also show information about each release instance.

label

Items By Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-release

Parameters
- this: Discojs
- release_id: number
- Optional pagination: Pagination
Returns Promise<{}>

listItemsByReleaseForUser

listItemsByReleaseForUser(this: Discojs, username: string, release_id: number, pagination?: Pagination): Promise<{}>

Inherited from UserCollection.listItemsByReleaseForUser
- Defined in src/userCollection.ts:125
View the user’s collection folders which contain a specified release. This will also show information about each release instance.

remarks

Authentication as the collection owner is required if the owner’s collection is private.

label

Items By Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-release

Parameters
- this: Discojs
- username: string
- release_id: number
- Optional pagination: Pagination
Returns Promise<{}>

listItemsInFolder

listItemsInFolder(this: Discojs, folderId: FolderIdsEnum | number, sort?: SortOptions<UserSortEnum>, pagination?: Pagination): Promise<{}>

Inherited from UserCollection.listItemsInFolder
- Defined in src/userCollection.ts:182
Returns the list of item in a folder in authenticated user’s collection.

remarks

Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release.

label

Collection Items By Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- Optional sort: SortOptions<UserSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

listItemsInFolderForUser

listItemsInFolderForUser(this: Discojs, username: string, folderId: FolderIdsEnum | number, sort?: SortOptions<UserSortEnum>, pagination?: Pagination): Promise<{}>

Inherited from UserCollection.listItemsInFolderForUser
- Defined in src/userCollection.ts:158
Returns the list of item in a folder in a user’s collection.

remarks

Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release. If folder_id is not 0, or the collection has been made private by its owner, authentication as the collection owner is required. If you are not authenticated as the collection owner, only public notes fields will be visible.

label

Collection Items By Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-folder

Parameters
- this: Discojs
- username: string
- folderId: FolderIdsEnum | number
- Optional sort: SortOptions<UserSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

moveReleaseInstanceToFolder

moveReleaseInstanceToFolder(this: Discojs, oldFolderId: FolderIdsEnum | number, releaseId: number, instanceId: number, newFolderId: FolderIdsEnum | number): Promise<EmptyResponse>

Inherited from UserCollection.moveReleaseInstanceToFolder
- Defined in src/userCollection.ts:245
Move the instance of a release to another folder.

label

Change Rating Of Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-change-rating-of-release

Parameters
- this: Discojs
- oldFolderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
- newFolderId: FolderIdsEnum | number
Returns Promise<EmptyResponse>

removeFromWantlist

removeFromWantlist(this: Discojs, releaseId: number): Promise<EmptyResponse>

Inherited from UserWantlist.removeFromWantlist
- Defined in src/userWantlist.ts:65
Remove a release to authenticated user’s wantlist.

label

Add to wantlist

link

https://www.discogs.com/developers#page:user-wantlist,header:user-wantlist-add-to-wantlist

Parameters
- this: Discojs
- releaseId: number
Returns Promise<EmptyResponse>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

User Identity Methods

User Profile Methods

User Submissions Methods

User Contributions Methods

User Collection Methods

User Folder Methods

Database Methods

Helpers Methods

Marketplace Methods

User Methods

Constructors

constructor

Parameters

Optional options: DiscojsOptions

Returns Discojs

Properties

outputFormat

userAgent

User Identity Methods

getIdentity

Parameters

this: Discojs

Returns Promise<{} & {}>

Protected getUsername

Parameters

this: Discojs

Returns Promise<string>

User Profile Methods

editProfile

Parameters

this: Discojs

options: ProfileOptions

Returns Promise<{} & {} & {}>

getProfile

Parameters

this: Discojs

Returns Promise<{} & {} & {}>

getProfileForUser

Parameters

this: Discojs

username: string

Returns Promise<{} & {} & {}>

User Submissions Methods

getSubmissions

Parameters

this: Discojs

Optional pagination: Pagination

Returns Promise<{}>

getSubmissionsForUser

Parameters

this: Discojs

username: string

Optional pagination: Pagination

Returns Promise<{}>

User Contributions Methods

getContributions

Parameters

this: Discojs

Optional sort: SortOptions<UserSortEnum>

Optional pagination: Pagination

Returns Promise<{}>

getContributionsForUser

Parameters

this: Discojs

username: string

Optional sort: SortOptions<UserSortEnum>

Optional pagination: Pagination

Returns Promise<{}>

User Collection Methods

createFolder

Parameters

this: Discojs

name: string

Returns Promise<{} & {}>

listFolders

Parameters