UserPreferencesResponseDto

Endpoints · All schemas

Field	Required	Description
albums	Yes	See definition below
cast	Yes	See definition below
download	Yes	See definition below
emailNotifications	Yes	See definition below
folders	Yes	See definition below
lockedRulesRevealed	Yes	Whether privacy.suppression names the account's Locked people, pets and tags. False when they were blanked (a session that is not unlocked, or an administrator); such rules must never be edited and saved back ()
memories	Yes	See definition below
people	Yes	See definition below
privacy	Yes	See definition below
purchase	Yes	See definition below
ratings	Yes	See definition below
recentlyAdded	Yes	See definition below
revision	Yes	Changes whenever the stored preferences change; send it back as expectedRevision to reject stale saves
savedSearches	No	Saved searches (always present). Empty for an administrator, and without any that names a Locked person, pet or tag while the session is locked
sharedLinks	Yes	See definition below
tags	Yes	See definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AlbumsResponse, CastResponse, DownloadResponse, EmailNotificationsResponse, FoldersResponse, MemoriesResponse, PeopleResponse, PrivacyResponse, PurchaseResponse, RatingsResponse, RecentlyAddedResponse, SavedSearch, SharedLinksResponse, TagsResponse

{
  "properties": {
    "albums": {
      "$ref": "#/components/schemas/AlbumsResponse"
    },
    "cast": {
      "$ref": "#/components/schemas/CastResponse"
    },
    "download": {
      "$ref": "#/components/schemas/DownloadResponse"
    },
    "emailNotifications": {
      "$ref": "#/components/schemas/EmailNotificationsResponse"
    },
    "folders": {
      "$ref": "#/components/schemas/FoldersResponse"
    },
    "lockedRulesRevealed": {
      "description": "Whether privacy.suppression names the account's Locked people, pets and tags. False when they were blanked (a session that is not unlocked, or an administrator); such rules must never be edited and saved back ()",
      "type": "boolean"
    },
    "memories": {
      "$ref": "#/components/schemas/MemoriesResponse"
    },
    "people": {
      "$ref": "#/components/schemas/PeopleResponse"
    },
    "privacy": {
      "$ref": "#/components/schemas/PrivacyResponse"
    },
    "purchase": {
      "$ref": "#/components/schemas/PurchaseResponse"
    },
    "ratings": {
      "$ref": "#/components/schemas/RatingsResponse"
    },
    "recentlyAdded": {
      "$ref": "#/components/schemas/RecentlyAddedResponse"
    },
    "revision": {
      "description": "Changes whenever the stored preferences change; send it back as expectedRevision to reject stale saves",
      "type": "string"
    },
    "savedSearches": {
      "description": "Saved searches (always present). Empty for an administrator, and without any that names a Locked person, pet or tag while the session is locked",
      "items": {
        "$ref": "#/components/schemas/SavedSearch"
      },
      "type": "array"
    },
    "sharedLinks": {
      "$ref": "#/components/schemas/SharedLinksResponse"
    },
    "tags": {
      "$ref": "#/components/schemas/TagsResponse"
    }
  },
  "required": [
    "albums",
    "cast",
    "download",
    "emailNotifications",
    "folders",
    "lockedRulesRevealed",
    "memories",
    "people",
    "privacy",
    "purchase",
    "ratings",
    "recentlyAdded",
    "revision",
    "sharedLinks",
    "tags"
  ],
  "type": "object"
}