Reference / @open-music-sdk/types / tResource

Interface: tResource

Defined in: resource.ts:7

A resource—such as an album, song, or playlist.

Properties

attributes?

optional attributes?: tResourceAttributes;

Defined in: resource.ts:15

Attributes belonging to the resource (can be a subset of the attributes). The members are the names of the attributes defined in the object model.

---

href?

optional href?: string;

Defined in: resource.ts:13

A URL subpath that fetches the resource as the primary object. This member is only present in responses.

---

id

id: string;

Defined in: resource.ts:9

Persistent identifier of the resource.

---

meta?

optional meta?: tResourceMeta;

Defined in: resource.ts:19

Information about the request or response. The members may be any of the endpoint parameters.

---

relationships?

optional relationships?: tResourceRelationships;

Defined in: resource.ts:17

Relationships belonging to the resource (can be a subset of the relationships). The members are the names of the relationships defined in the object model. See object for the values of the members.

---

type

type: string;

Defined in: resource.ts:11

The type of resource.

---

views?

optional views?: tResourceViews;

Defined in: resource.ts:21

The relationship views for the resource.