Skip to content

Resources and fields

Peter Araujo edited this page Jul 28, 2024 · 1 revision

Resources

There is a model for every resource. They might have nested models depending on the resource.
Models are documented with their available official resource description.

Convention

Models have the same original name as their corresponding resource.

{Resource}

Availability

All resources are available.

Fields

Fields are available as model's properties. Model's properties are documented with their available official field description.
Note: Since you can configure what you get using parameters, all model's properties are nullable.

Convention

Fields have camelCase names.

{modelObject}.{fieldName}

For example, to get api_model from an Artwork object:

val apiModel = artworkObject.apiModel

Availability

All fields and subfields from the official documentation are available. Also, there are a few not mentioned on the official documentation that are also available and parsed to the model class.
Unknown fields will be ignored by default. However, you can add your own configuration if needed.

Clone this wiki locally