Class AlbumsService

Index

Constructors

constructor

Methods

addImage create delete get listForUser listImages removeImage update

Constructors

constructor

new AlbumsService(client: WaifuClient): AlbumsService
Parameters
- client: WaifuClient
Returns AlbumsService
- Defined in src/services/albums.ts:43

Methods

addImage

addImage(
    userId: number | "me",
    albumId: number | "favorites",
    imageId: number,
): Promise<void>
Add an image to an album.

Add an image to one of your albums. Use "favorites" as albumId to add to your favorites.
Parameters
- userId: number | "me"
  The user ID or "me".
- albumId: number | "favorites"
  The album ID or "favorites".
- imageId: number
  The ID of the image to add.
Returns Promise<void>
Throws
AuthenticationRequired if authentication is missing.

Throws
ApiError with status 401 if authentication is invalid.

Throws
ApiError with status 404 if album or image not found.
- Defined in src/services/albums.ts:174

create

create(userId: number | "me", options: CreateAlbumOptions): Promise<Album>
Create a new album.

Create a new album to organize images. You can only create albums for yourself.
Parameters
- userId: number | "me"
  The user ID or "me" (must be your own account).
- options: CreateAlbumOptions
  The album details.
Returns Promise<Album>
The created album.

Throws
AuthenticationRequired if authentication is missing.

Throws
ApiError with status 400 if invalid album data.

Throws
ApiError with status 401 if authentication is invalid.
- Defined in src/services/albums.ts:71

delete

delete(userId: number | "me", albumId: number): Promise<void>
Delete an album.

Permanently delete an album. The default "Favorites" album cannot be deleted. Images in the album are NOT deleted, only removed from the album.
Parameters
- userId: number | "me"
- albumId: number
Returns Promise<void>
Throws
AuthenticationRequired if authentication is missing.

Throws
ApiError with status 400 if trying to delete the default album.

Throws
ApiError with status 401 if authentication is invalid.

Throws
ApiError with status 404 if album not found.
- Defined in src/services/albums.ts:129

get

get(userId: number | "me", albumId: number | "favorites"): Promise<Album>
Get album details.

Returns details for a specific album including image count.
Parameters
- userId: number | "me"
  The user ID or "me".
- albumId: number | "favorites"
  The album ID or "favorites" for the default album.
Returns Promise<Album>
Throws
ApiError with status 404 if album or user not found.
- Defined in src/services/albums.ts:90

listForUser

listForUser(
userId: number | "me",
query?: ListAlbumsForUserOptions,
): Promise<PaginatedResponse<Album>>
List albums for a user.

Returns all albums for the specified user. The default "Favorites" album is always listed first.
Parameters
- userId: number | "me"
  The user ID or "me" for the current user.
- Optionalquery: ListAlbumsForUserOptions
Returns Promise<PaginatedResponse<Album>>
Throws
ApiError with status 404 if user not found.
- Defined in src/services/albums.ts:55

listImages

listImages(
    userId: number | "me",
    albumId: number | "favorites",
    query?: SearchImagesOptions,
): Promise<PaginatedResponse<WaifuImage>>
List images in an album.

Returns images in the album with full filtering support. Supports the same filters as the main images endpoint.
Parameters
- userId: number | "me"
  The user ID or "me".
- albumId: number | "favorites"
  The album ID or "favorites".
- Optionalquery: SearchImagesOptions
Returns Promise<PaginatedResponse<WaifuImage>>
Throws
ApiError with status 400 if invalid filter parameters.

Throws
ApiError with status 403 if forbidden.

Throws
ApiError with status 404 if album not found.
- Defined in src/services/albums.ts:150

removeImage

removeImage(
    userId: number | "me",
    albumId: number | "favorites",
    imageId: number,
): Promise<void>
Remove an image from an album.

Remove an image from one of your albums. The image is not deleted, only unlinked from the album.
Parameters
- userId: number | "me"
  The user ID or "me".
- albumId: number | "favorites"
  The album ID or "favorites".
- imageId: number
  The image ID to remove.
Returns Promise<void>
Throws
AuthenticationRequired if authentication is missing.

Throws
ApiError with status 401 if authentication is invalid.

Throws
ApiError with status 404 if album or image not found in album.
- Defined in src/services/albums.ts:198

update

update(
    userId: number | "me",
    albumId: number | "favorites",
    options: UpdateAlbumOptions,
): Promise<Album>
Update an album.

Update album name or description. You can only update your own albums.
Parameters
- userId: number | "me"
  The user ID or "me".
- albumId: number | "favorites"
  The album ID or "favorites".
- options: UpdateAlbumOptions
  The fields to update.
Returns Promise<Album>
The updated album.

Throws
AuthenticationRequired if authentication is missing.

Throws
ApiError with status 400 if invalid album data.

Throws
ApiError with status 401 if authentication is invalid.

Throws
ApiError with status 404 if album not found.
- Defined in src/services/albums.ts:108

Class AlbumsService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AlbumsService

Methods

addImage

Parameters

Returns Promise<void>

Throws

Throws

Throws

create

Parameters

Returns Promise<Album>

Throws

Throws

Throws

delete

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

get

Parameters

Returns Promise<Album>

Throws

listForUser

Parameters

Returns Promise<PaginatedResponse<Album>>

Throws

listImages

Parameters

Returns Promise<PaginatedResponse<WaifuImage>>

Throws

Throws

Throws

removeImage

Parameters

Returns Promise<void>

Throws

Throws

Throws

update

Parameters

Returns Promise<Album>

Throws

Throws

Throws

Throws

Settings

On This Page