EndpointTypes/Albums
Type definitions supporting the Albums endpoint.
Interfaces
| Interface | Description |
|---|---|
| AlbumRelationships | - |
| AlbumViews | - |
| AlbumRequestOptions | Query params for fetching a single catalog album. GET /v1/catalog/{storefront}/albums/{id} |
| AlbumParams | Identifier and query options accepted by AlbumsEndpoint#get. |
| AlbumViewOptions | - |
| AlbumViewParams | Parameters accepted by AlbumsEndpoint#getView. |
| AlbumRelationshipOptions | - |
| AlbumRelationshipParams | Parameters accepted by AlbumsEndpoint#getRelationship. |
| AlbumResource | - |
| AlbumAttributes | - |
| AlbumsViewResponse | - |
| AlbumsResponse | - |
| AlbumsRelationshipResponse | - |
| RelationshipWithRefs | - |
| RelationshipWithResources | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AlbumRelationshipName | - |
| AlbumViewName | - |
| AlbumTrackResource | - |
| AlbumSummaryResource | - |
| AlbumRelationshipResourceMap | - |
| AlbumViewResourceMap | - |
Enumerations
| Enumeration | Description |
|---|---|
| ExtendOption | - |
| IncludeOption | - |
| WithOption | - |
Variables
| Variable | Description |
|---|---|
| AlbumParamsDefaults | - |
| AlbumViewParamsDefaults | - |
| AlbumRelationshipParamsDefaults | - |