diff --git a/srcgen/entities_masto.json b/srcgen/entities_masto.json index 58070b1..adcb909 100644 --- a/srcgen/entities_masto.json +++ b/srcgen/entities_masto.json @@ -1,7 +1,1037 @@ { - "ExtendedDescription": { + "V1Filter": { + "doc_link": "https://docs.joinmastodon.org/entities/V1_Filter.md", + "id": { + "description": "The ID of the filter in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.4.3": "added" + } + }, + "phrase": { + "description": "The text to be filtered.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.4.3": "added" + } + }, + "context": { + "description": "The contexts in which the filter should be applied.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of String (Enumerable anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", + "type": "Array of String (Enumerable anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", + "version_history": { + "2.4.3": "added", + "3.1.0": "added `account`" + } + }, + "expires_at": { + "description": "When the filter should no longer be applied.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime), or null if the filter does not expire", + "type": "String (ISO 8601 Datetime), or null if the filter does not expire", + "version_history": { + "2.4.3": "added" + } + }, + "irreversible": { + "description": "Should matching entities in home and notifications be dropped by the server? See implementation guidelines for filters().", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.3": "added" + } + }, + "whole_word": { + "description": "Should the filter consider word boundaries? See implementation guidelines for filters().", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.3": "added" + } + } + }, + "DomainBlock": { + "doc_link": "https://docs.joinmastodon.org/entities/DomainBlock.md", + "domain": { + "description": "The domain which is blocked. This may be obfuscated or partially censored.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "digest": { + "description": "The SHA256 hash digest of the domain string.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (SHA256)", + "type": "String (SHA256)", + "version_history": { + "4.0.0": "added" + } + }, + "severity": { + "description": "The level to which the domain is blocked.", + "nullable": false, + "optional": false, + "enum": { + "silence": "Users from this domain will be hidden from timelines, threads, and notifications (unless you follow the user).", + "suspend": "Incoming messages from this domain will be rejected and dropped entirely." + }, + "type_key": "String (Enumerable, oneOf) `silence` = Users from this domain will be hidden from timelines, threads, and notifications (unless you follow the user). `suspend` = Incoming messages from this domain will be rejected and dropped entirely.", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "comment": { + "description": "An optional reason for the domain block.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + } + }, + "Search": { + "doc_link": "https://docs.joinmastodon.org/entities/Search.md", + "accounts": { + "description": "Accounts which match the given query", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Account()", + "type": "Array of Account()", + "version_history": { + "1.1.0": "added" + } + }, + "statuses": { + "description": "Statuses which match the given query", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Status()", + "type": "Array of Status()", + "version_history": { + "1.1.0": "added" + } + }, + "hashtags": { + "description": "Hashtags which match the given query", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Tag()", + "type": "Array of Tag()", + "version_history": { + "1.1.0": "added", + "2.4.1": "v1/search deprecated because it returns Array of String. v2/search added which returns Array of Tag.", + "3.0.0": "v1 removed" + } + } + }, + "Application": { + "doc_link": "https://docs.joinmastodon.org/entities/Application.md", + "name": { + "description": "The name of your application.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.9.9": "added" + } + }, + "website": { + "description": "The website associated with your application.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (URL)", + "type": "String (URL)", + "version_history": { + "0.9.9": "added", + "3.5.1": "this property is now nullable" + } + }, + "vapid_key": { + "description": "Used for Push Streaming API. Returned with POST /api/v1/apps(). Equivalent to WebPushSubscription#server_key()", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.8.0": "added" + } + }, + "client_id": { + "description": "Client ID key, to be used for obtaining OAuth tokens", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.9.9": "added" + } + }, + "client_secret": { + "description": "Client secret key, to be used for obtaining OAuth tokens", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.9.9": "added" + } + } + }, + "Reaction": { + "doc_link": "https://docs.joinmastodon.org/entities/Reaction.md", + "name": { + "description": "The emoji used for the reaction. Either a unicode emoji, or a custom emoji's shortcode.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.1.0": "added" + } + }, + "count": { + "description": "The total number of users who have added this reaction.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "3.1.0": "added" + } + }, + "me": { + "description": "If there is a currently authorized user: Have you added this reaction?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "url": { + "description": "If the reaction is a custom emoji: A link to the custom emoji.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "3.1.0": "added" + } + }, + "static_url": { + "description": "If the reaction is a custom emoji: A link to a non-animated version of the custom emoji.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "3.1.0": "added" + } + } + }, + "FilterKeyword": { + "doc_link": "https://docs.joinmastodon.org/entities/FilterKeyword.md", + "id": { + "description": "The ID of the FilterKeyword in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "keyword": { + "description": "The phrase to be matched against.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "whole_word": { + "description": "Should the filter consider word boundaries? See implementation guidelines for filters().", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "4.0.0": "added" + } + } + }, + "Account": { + "doc_link": "https://docs.joinmastodon.org/entities/Account.md", + "id": { + "description": "The account id.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "0.1.0": "added" + } + }, + "username": { + "description": "The username of the account, not including domain.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.1.0": "added" + } + }, + "acct": { + "description": "The Webfinger account URI. Equal to `username` for local users, or `username@domain` for remote users.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.1.0": "added" + } + }, + "url": { + "description": "The location of the user's profile page.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.1.0": "added" + } + }, + "display_name": { + "description": "The profile's display name.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.1.0": "added" + } + }, + "note": { + "description": "The profile's bio or description.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "0.1.0": "added" + } + }, + "avatar": { + "description": "An image icon that is shown next to statuses and in the profile.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.1.0": "added" + } + }, + "avatar_static": { + "description": "A static version of the avatar. Equal to `avatar` if its value is a static image; different if `avatar` is an animated GIF.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "1.1.2": "added" + } + }, + "header": { + "description": "An image banner that is shown above the profile and in profile cards.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.1.0": "added" + } + }, + "header_static": { + "description": "A static version of the header. Equal to `header` if its value is a static image; different if `header` is an animated GIF.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "1.1.2": "added" + } + }, + "locked": { + "description": "Whether the account manually approves follow requests.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "0.1.0": "added" + } + }, + "fields": { + "description": "Additional metadata attached to a profile as name-value pairs.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Field(#Field)", + "type": "Array of Field(#Field)", + "version_history": { + "2.4.0": "added" + } + }, + "emojis": { + "description": "Custom emoji entities to be used when rendering the profile.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of CustomEmoji()", + "type": "Array of CustomEmoji()", + "version_history": { + "2.4.0": "added" + } + }, + "bot": { + "description": "Indicates that the account may perform automated actions, may not be monitored, or identifies as a robot.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.0": "added" + } + }, + "group": { + "description": "Indicates that the account represents a Group actor.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "discoverable": { + "description": "Whether the account has opted into discovery features such as the profile directory.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "noindex": { + "description": "Whether the local user has opted out of being indexed by search engines.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Boolean", + "type": "Boolean", + "version_history": { + "4.0.0": "added" + } + }, + "moved": { + "description": "Indicates that the profile is currently inactive and that its user has moved to a new account.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Account(), or null if the profile is suspended.", + "type": "Account(), or null if the profile is suspended.", + "version_history": { + "2.1.0": "added" + } + }, + "suspended": { + "description": "An extra attribute returned only when an account is suspended.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.3.0": "added" + } + }, + "limited": { + "description": "An extra attribute returned only when an account is silenced. If true, indicates that the account should be hidden behind a warning screen.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.3": "added" + } + }, + "created_at": { + "description": "When the account was created.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "0.1.0": "added", + "3.4.0": "now resolves to midnight instead of an exact time" + } + }, + "last_status_at": { + "description": "When the most recent status was posted.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Date), or null if no statuses", + "type": "String (ISO 8601 Date), or null if no statuses", + "version_history": { + "3.0.0": "added", + "3.1.0": "now returns date only, no time" + } + }, + "statuses_count": { + "description": "How many statuses are attached to this account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "0.1.0": "added" + } + }, + "followers_count": { + "description": "The reported followers of this profile.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "0.1.0": "added" + } + }, + "following_count": { + "description": "The reported follows of this profile.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "0.1.0": "added" + } + } + }, + "CredentialAccount": { + "doc_link": "https://docs.joinmastodon.org/entities/Account.md", + "source": { + "description": "An extra attribute that contains source values to be used with API methods that verify credentials() and update credentials().", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Hash", + "type": "Hash", + "version_history": { + "2.4.0": "added" + } + } + }, + "CredentialAccountSource": { + "doc_link": "https://docs.joinmastodon.org/entities/Account.md", + "note": { + "description": "Profile bio, in plain-text instead of in HTML.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "1.5.0": "added" + } + }, + "fields": { + "description": "Metadata about the account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Field(#Field)", + "type": "Array of Field(#Field)", + "version_history": { + "2.4.0": "added" + } + }, + "privacy": { + "description": "The default post privacy to be used for new statuses.", + "nullable": false, + "optional": false, + "enum": { + "public": "Public post", + "unlisted": "Unlisted post", + "private": "Followers-only post", + "direct": "Direct post" + }, + "type_key": "String (Enumerable, oneOf) `public` = Public post `unlisted` = Unlisted post `private` = Followers-only post `direct` = Direct post", + "type": "String", + "version_history": { + "1.5.0": "added" + } + }, + "sensitive": { + "description": "Whether new statuses should be marked sensitive by default.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "1.5.0": "added" + } + }, + "language": { + "description": "The default posting language for new statuses.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 639-1 language two-letter code) or empty string", + "type": "String (ISO 639-1 language two-letter code) or empty string", + "version_history": { + "2.4.2": "added" + } + }, + "follow_requests_count": { + "description": "The number of pending follow requests.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "3.0.0": "added" + } + }, + "role": { + "description": "The role assigned to the currently authorized user.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Role()", + "type": "Role()", + "version_history": { + "4.0.0": "added" + } + } + }, + "MutedAccount": { + "doc_link": "https://docs.joinmastodon.org/entities/Account.md", + "mute_expires_at": { + "description": "When a timed mute will expire, if applicable.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime), or null if the mute is indefinite", + "type": "String (ISO 8601 Datetime), or null if the mute is indefinite", + "version_history": { + "3.3.0": "added" + } + } + }, + "Field": { + "doc_link": "https://docs.joinmastodon.org/entities/Account.md", + "name": { + "description": "The key of a given field's key-value pair.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.4.0": "added" + } + }, + "value": { + "description": "The value associated with the `name` key.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "2.4.0": "added" + } + }, + "verified_at": { + "description": "Timestamp of when the server verified a URL value for a rel=\"me\" link.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime) if `value` is a verified URL. Otherwise, null.", + "type": "String (ISO 8601 Datetime) if `value` is a verified URL. Otherwise, null.", + "version_history": { + "2.6.0": "added" + } + } + }, + "Conversation": { + "doc_link": "https://docs.joinmastodon.org/entities/Conversation.md", + "id": { + "description": "The ID of the conversation in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.6.0": "added" + } + }, + "unread": { + "description": "Is the conversation currently marked as unread?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.6.0": "added" + } + }, + "accounts": { + "description": "Participants in the conversation.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Account()", + "type": "Array of Account()", + "version_history": { + "2.6.0": "added" + } + }, + "last_status": { + "description": "The last status in the conversation.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Status()", + "type": "Status()", + "version_history": { + "2.6.0": "added" + } + } + }, + "Marker": { + "doc_link": "https://docs.joinmastodon.org/entities/Marker.md", + "last_read_id": { + "description": "The ID of the most recently viewed entity.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer but not guaranteed to be a number) 3.0.0 - added", + "type": "String (cast from integer but not guaranteed to be a number) 3.0.0 - added" + }, + "version": { + "description": "An incrementing counter, used for locking to prevent write conflicts.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "3.0.0": "added" + } + }, "updated_at": { - "description": "A timestamp of when the extended description was last updated.", + "description": "The timestamp of when the marker was set.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime) 3.0.0 - added", + "type": "String (ISO 8601 Datetime) 3.0.0 - added" + } + }, + "AdminCohort": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort.md", + "period": { + "description": "The timestamp for the start of the period, at midnight.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.5.0": "added" + } + }, + "frequency": { + "description": "The size of the bucket for the returned data.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (Enumerable oneOf) `day` = Daily buckets `month` = Monthly buckets", + "type": "String (Enumerable oneOf) `day` = Daily buckets `month` = Monthly buckets", + "version_history": { + "3.5.0": "added" + } + }, + "data": { + "description": "Retention data for users who registered during the given period.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of CohortData(#CohortData)", + "type": "Array of CohortData(#CohortData)", + "version_history": { + "3.5.0": "added" + } + } + }, + "CohortData": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort.md", + "date": { + "description": "The timestamp for the start of the bucket, at midnight.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.5.0": "added" + } + }, + "rate": { + "description": "The percentage rate of users who registered in the specified `period` and were active for the given `date` bucket.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Number", + "type": "Number", + "version_history": { + "3.5.0": "added" + } + }, + "value": { + "description": "How many users registered in the specified `period` and were active for the given `date` bucket.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "3.5.0": "added" + } + } + }, + "Preferences": { + "doc_link": "https://docs.joinmastodon.org/entities/Preferences.md", + "posting:default:visibility": { + "description": "Default visibility for new posts. Equivalent to CredentialAccount#source\\[privacy\\]().", + "nullable": false, + "optional": false, + "enum": { + "public": "Public post", + "unlisted": "Unlisted post", + "private": "Followers-only post", + "direct": "Direct post" + }, + "type_key": "String (Enumerable, oneOf) `public` = Public post `unlisted` = Unlisted post `private` = Followers-only post `direct` = Direct post", + "type": "String", + "version_history": { + "2.8.0": "added" + } + }, + "posting:default:sensitive": { + "description": "Default sensitivity flag for new posts. Equivalent to CredentialAccount#source\\[sensitive\\]().", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "posting:default:language": { + "description": "Default language for new posts. Equivalent to CredentialAccount#source\\[language\\]()", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 639-1 language two-letter code), or null", + "type": "String (ISO 639-1 language two-letter code), or null", + "version_history": { + "2.8.0": "added" + } + }, + "reading:expand:media": { + "description": "Whether media attachments should be automatically displayed or blurred/hidden.", + "nullable": false, + "optional": false, + "enum": { + "default": "Hide media marked as sensitive", + "show_all": "Always show all media by default, regardless of sensitivity", + "hide_all": "Always hide all media by default, regardless of sensitivity" + }, + "type_key": "String (Enumerable, oneOf) `default` = Hide media marked as sensitive `show_all` = Always show all media by default, regardless of sensitivity `hide_all` = Always hide all media by default, regardless of sensitivity", + "type": "String", + "version_history": { + "2.8.0": "added" + } + }, + "reading:expand:spoilers": { + "description": "Whether CWs should be expanded by default.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + } + }, + "FamiliarFollowers": { + "doc_link": "https://docs.joinmastodon.org/entities/FamiliarFollowers.md", + "id": { + "description": "The ID of the Account in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "3.5.0": "added" + } + }, + "accounts": { + "description": "Accounts you follow that also follow this account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Account()", + "type": "Array of Account()", + "version_history": { + "3.5.0": "added" + } + } + }, + "AdminIpBlock": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_IpBlock.md", + "id": { + "description": "The ID of the DomainBlock in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "ip": { + "description": "The IP address range that is not allowed to federate.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (IP address and prefix)", + "type": "String (IP address and prefix)", + "version_history": { + "4.0.0": "added" + } + }, + "severity": { + "description": "The associated policy with this IP block.", + "nullable": false, + "optional": false, + "enum": { + "sign_up_requires_approval": "Any signup from this IP range will create a pending account", + "sign_up_block": "Any signup from this IP range will be rejected", + "no_access": "Any activity from this IP range will be rejected entirely" + }, + "type_key": "String (Enumerable, oneOf) `sign_up_requires_approval` = Any signup from this IP range will create a pending account `sign_up_block` = Any signup from this IP range will be rejected `no_access` = Any activity from this IP range will be rejected entirely", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "comment": { + "description": "The recorded reason for this IP block.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "created_at": { + "description": "When the IP block was created.", "nullable": false, "optional": false, "enum": null, @@ -11,19 +1041,796 @@ "4.0.0": "added" } }, + "expires_at": { + "description": "When the IP block will expire.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "4.0.0": "added" + } + } + }, + "CustomEmoji": { + "doc_link": "https://docs.joinmastodon.org/entities/CustomEmoji.md", + "shortcode": { + "description": "The name of the custom emoji.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.0.0": "added" + } + }, + "url": { + "description": "A link to the custom emoji.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "2.0.0": "added" + } + }, + "static_url": { + "description": "A link to a static copy of the custom emoji.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "2.0.0": "added" + } + }, + "visible_in_picker": { + "description": "Whether this Emoji should be visible in the picker or unlisted.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.0.0": "added" + } + }, + "category": { + "description": "Used for sorting custom emoji in the picker.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.0.0": "added" + } + } + }, + "MediaAttachment": { + "doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment.md", + "id": { + "description": "The ID of the attachment in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer but not guaranteed to be a number)", + "type": "String (cast from an integer but not guaranteed to be a number)", + "version_history": { + "0.6.0": "added" + } + }, + "type": { + "description": "The type of the attachment.", + "nullable": false, + "optional": false, + "enum": { + "unknown": "unsupported or unrecognized file type", + "image": "Static image", + "gifv": "Looping, soundless animation", + "video": "Video clip", + "audio": "Audio track" + }, + "type_key": "String (Enumerable, oneOf) `unknown` = unsupported or unrecognized file type `image` = Static image `gifv` = Looping, soundless animation `video` = Video clip `audio` = Audio track", + "type": "String", + "version_history": { + "0.6.0": "added", + "2.9.1": "added `audio`" + } + }, + "url": { + "description": "The location of the original full-size attachment.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.6.0": "added" + } + }, + "preview_url": { + "description": "The location of a scaled-down preview of the attachment.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.6.0": "added" + } + }, + "remote_url": { + "description": "The location of the full-size original attachment on the remote website.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (URL), or null if the attachment is local", + "type": "String (URL), or null if the attachment is local", + "version_history": { + "0.6.0": "added" + } + }, + "meta": { + "description": "Metadata returned by Paperclip.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Hash", + "type": "Hash", + "version_history": { + "1.5.0": "added", + "2.3.0": "added `meta.focus` May contain subtrees `small` and `original`, as well as various other top-level properties. More importantly, there may be another topl-level `focus` Hash object on images as of 2.3.0, with coordinates can be used for smart thumbnail cropping -- see [Focal points for cropped media thumbnails]({{< relref \"api/guidelines#focal-points\" >}}) for more." + } + }, + "description": { + "description": "Alternate text that describes what is in the media attachment, to be used for the visually impaired or when media attachments do not load.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.0.0": "added" + } + }, + "blurhash": { + "description": "A hash computed by the BlurHash algorithm(https://github.com/woltapp/blurhash), for generating colorful preview thumbnails when media has not been downloaded yet.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (Blurhash)", + "type": "String (Blurhash)", + "version_history": { + "2.8.1": "added" + } + } + }, + "Deprecated": { + "doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment.md", + "text_url": { + "description": "A shorter URL for the attachment.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.6.0": "added", + "3.5.0": "removed" + } + } + }, + "WebPushSubscription": { + "doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription.md", + "id": { + "description": "The ID of the Web Push subscription in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.4.0": "added" + } + }, + "endpoint": { + "description": "Where push alerts will be sent to.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "2.4.0": "added" + } + }, + "server_key": { + "description": "The streaming server's VAPID key.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.4.0": "added" + } + }, + "alerts": { + "description": "Which alerts should be delivered to the `endpoint`.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Hash", + "type": "Hash", + "version_history": { + "2.4.0": "added", + "2.8.0": "added `alerts[poll]`", + "3.1.0": "added `alerts[follow_request]`", + "3.3.0": "added `alerts[status]`", + "3.5.0": "added `alerts[update]` and `alerts[admin.sign_up]`", + "4.0.0": "added `alerts[admin.report]`" + } + } + }, + "WebPushSubscriptionAlerts": { + "doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription.md", + "mention": { + "description": "Receive a push notification when someone else has mentioned you in a status?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.0": "added" + } + }, + "status": { + "description": "Receive a push notification when a subscribed account posts a status?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.3.0": "added" + } + }, + "reblog": { + "description": "Receive a push notification when a status you created has been boosted by someone else?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.0": "added" + } + }, + "follow": { + "description": "Receive a push notification when someone has followed you?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.0": "added" + } + }, + "follow_request": { + "description": "Receive a push notification when someone has requested to followed you?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "favourite": { + "description": "Receive a push notification when a status you created has been favourited by someone else?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.4.0": "added" + } + }, + "poll": { + "description": "Receive a push notification when a poll you voted in or created has ended?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "update": { + "description": "Receive a push notification when a status you interacted with has been edited?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.0": "added" + } + }, + "admin.sign_up": { + "description": "Receive a push notification when a new user has signed up?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.0": "added" + } + }, + "admin.report": { + "description": "Receive a push notification when a new report has been filed?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "4.0.0": "added" + } + } + }, + "StatusEdit": { + "doc_link": "https://docs.joinmastodon.org/entities/StatusEdit.md", "content": { - "description": "The rendered HTML content of the extended description.", + "description": "The content of the status at this revision.", "nullable": false, "optional": false, "enum": null, "type_key": "String (HTML)", "type": "String (HTML)", "version_history": { - "4.0.0": "added" + "3.5.0": "added" + } + }, + "spoiler_text": { + "description": "The content of the subject or content warning at this revision.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "3.5.0": "added" + } + }, + "sensitive": { + "description": "Whether the status was marked sensitive at this revision.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.0": "added" + } + }, + "created_at": { + "description": "The timestamp of when the revision was published.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.5.0": "added" + } + }, + "account": { + "description": "The account that published this revision.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Account", + "type": "Account", + "version_history": { + "3.5.0": "added" + } + }, + "poll": { + "description": "The current state of the poll options at this revision. Note that edits changing the poll options will be collapsed together into one edit, since this action resets the poll.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Hash", + "type": "Hash", + "version_history": { + "3.5.0": "added" + } + } + }, + "StatusEditPoll.Options": { + "doc_link": "https://docs.joinmastodon.org/entities/StatusEdit.md", + "": { + "description": "The poll options at this revision.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Hash", + "type": "Array of Hash", + "version_history": { + "3.5.0": "added" + } + }, + "].titl": { + "description": "The text for a poll option.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "media_attachments": { + "description": "The current state of the poll options at this revision. Note that edits changing the poll options will be collapsed together into one edit, since this action resets the poll.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of MediaAttachment()", + "type": "Array of MediaAttachment()", + "version_history": { + "3.5.0": "added" + } + }, + "emojis": { + "description": "Any custom emoji that are used in the current revision.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of CustomEmoji()", + "type": "Array of CustomEmoji()", + "version_history": { + "3.5.0": "added" + } + } + }, + "AdminAccount": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Account.md", + "id": { + "description": "The ID of the account in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.9.1": "added" + } + }, + "username": { + "description": "The username of the account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.9.1": "added" + } + }, + "domain": { + "description": "The domain of the account, if it is remote.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String, or null for local accounts", + "type": "String, or null for local accounts", + "version_history": { + "2.9.1": "added" + } + }, + "created_at": { + "description": "When the account was first discovered.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "2.9.1": "added" + } + }, + "email": { + "description": "The email address associated with the account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.9.1": "added" + } + }, + "ip": { + "description": "The IP address last used to login to this account.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String", + "type": "String", + "version_history": { + "2.9.1": "added", + "3.5.0": "return type changed from String to [AdminIp]({{< relref \"entities/Admin_Ip\" >}}) due to a bug", + "4.0.0": "bug fixed, return type is now a String again" + } + }, + "ips": { + "description": "All known IP addresses associated with this account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of AdminIp()", + "type": "Array of AdminIp()", + "version_history": { + "3.5.0": "added" + } + }, + "locale": { + "description": "The locale of the account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 639 Part 1 two-letter language code)", + "type": "String (ISO 639 Part 1 two-letter language code)", + "version_history": { + "2.9.1": "added" + } + }, + "invite_request": { + "description": "The reason given when requesting an invite (for instances that require manual approval of registrations)", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String", + "type": "String", + "version_history": { + "2.9.1": "added" + } + }, + "role": { + "description": "The current role of the account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Role()", + "type": "Role()", + "version_history": { + "2.9.1": "added, returns a String (enumerable, oneOf `user` `moderator` `admin`)", + "4.0.0": "now uses Role entity" + } + }, + "confirmed": { + "description": "Whether the account has confirmed their email address.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.9.1": "added" + } + }, + "approved": { + "description": "Whether the account is currently approved.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.9.1": "added" + } + }, + "disabled": { + "description": "Whether the account is currently disabled.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.9.1": "added" + } + }, + "silenced": { + "description": "Whether the account is currently silenced.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.9.1": "added" + } + }, + "suspended": { + "description": "Whether the account is currently suspended.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.9.1": "added" + } + }, + "account": { + "description": "User-level information about the account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Account()", + "type": "Account()", + "version_history": { + "2.9.1": "added" + } + }, + "created_by_application_id": { + "description": "The ID of the Application() that created this account, if applicable.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.9.1": "added" + } + }, + "invited_by_account_id": { + "description": "The ID of the Account() that invited this user, if applicable.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.9.1": "added" + } + } + }, + "Rule": { + "doc_link": "https://docs.joinmastodon.org/entities/Rule.md", + "id": { + "description": "An identifier for the rule.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer, but not guaranteed to be a number)", + "type": "String (cast from integer, but not guaranteed to be a number)", + "version_history": { + "3.4.0": "added" + } + }, + "text": { + "description": "The rule to be followed.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.4.0": "added" + } + } + }, + "AdminMeasure": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure.md", + "key": { + "description": "The unique keystring for the requested measure.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "unit": { + "description": "The units associated with this data item's value, if applicable.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String or null", + "type": "String or null", + "version_history": { + "3.5.0": "added" + } + }, + "total": { + "description": "The numeric total associated with the requested measure.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer)", + "type": "String (cast from integer)", + "version_history": { + "3.5.0": "added" + } + }, + "human_value": { + "description": "A human-readable formatted value for this data item.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "previous_total": { + "description": "The numeric total associated with the requested measure, in the previous period. Previous period is calculated by subtracting the start_at and end_at dates, then offsetting both start and end dates backwards by the length of the time period.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer)", + "type": "String (cast from integer)", + "version_history": { + "3.5.0": "added" + } + }, + "data": { + "description": "The data available for the requested measure, split into daily buckets.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Hash", + "type": "Array of Hash", + "version_history": { + "3.5.0": "added" + } + } + }, + "AdminMeasureData": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure.md", + "date": { + "description": "Midnight on the requested day in the time period.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.5.0": "added" + } + }, + "value": { + "description": "The numeric value for the requested measure.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer)", + "type": "String (cast from integer)", + "version_history": { + "3.5.0": "added" } } }, "AdminDomainBlock": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainBlock.md", "id": { "description": "The ID of the DomainBlock in the database.", "nullable": false, @@ -124,1782 +1931,33 @@ } } }, - "AdminDimension": { - "key": { - "description": "The unique keystring for the requested dimension.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "data": { - "description": "The data available for the requested dimension.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Hash", - "type": "Array of Hash", - "version_history": { - "3.5.0": "added" - } - } - }, - "Data": { - "key": { - "description": "The unique keystring for this data item.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "human_key": { - "description": "A human-readable key for this data item.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "value": { - "description": "The value for this data item.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "unit": { - "description": "The units associated with this data item's value, if applicable.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "human_value": { - "description": "A human-readable formatted value for this data item.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - } - }, - "FilterResult": { - "filter": { - "description": "The filter that was matched.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Filter()", - "type": "Filter()", - "version_history": { - "4.0.0": "added" - } - }, - "keyword_matches": { - "description": "The keyword within the filter that was matched.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Array of String, or null", - "type": "Array of String, or null", - "version_history": { - "4.0.0": "added" - } - }, - "status_matches": { - "description": "The status ID within the filter that was matched.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String, or null", - "type": "String, or null", - "version_history": { - "4.0.0": "added" - } - } - }, - "Announcement": { - "id": { - "description": "The ID of the announcement in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "3.1.0": "added" - } - }, - "content": { - "description": "The text of the announcement.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "3.1.0": "added" - } - }, - "starts_at": { - "description": "When the announcement will start.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime) or null", - "type": "String (ISO 8601 Datetime) or null", - "version_history": { - "3.1.0": "added" - } - }, - "ends_at": { - "description": "When the announcement will end.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime) or null", - "type": "String (ISO 8601 Datetime) or null", - "version_history": { - "3.1.0": "added" - } - }, - "published": { - "description": "Whether the announcement is currently active.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "all_day": { - "description": "Whether the announcement should start and end on dates only instead of datetimes. Will be false if there is no `starts_at` or `ends_at` time.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "published_at": { - "description": "When the announcement was published.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.1.0": "added" - } - }, - "updated_at": { - "description": "When the announcement was last updated.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.1.0": "added" - } - }, - "read": { - "description": "Whether the announcement has been read by the current user.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "mentions": { - "description": "Accounts mentioned in the announcement text.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of AnnouncementAccount(#Account)", - "type": "Array of AnnouncementAccount(#Account)", - "version_history": { - "3.1.0": "added" - } - }, - "statuses": { - "description": "Statuses linked in the announcement text.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of AnnouncementStatus(#Status)", - "type": "Array of AnnouncementStatus(#Status)", - "version_history": { - "3.1.0": "added" - } - }, - "tags": { - "description": "Tags linked in the announcement text.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of StatusTag()", - "type": "Array of StatusTag()", - "version_history": { - "3.1.0": "added" - } - }, - "emojis": { - "description": "Custom emoji used in the announcement text.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of CustomEmoji()", - "type": "Array of CustomEmoji()", - "version_history": { - "3.1.0": "added" - } - }, - "reactions": { - "description": "Emoji reactions attached to the announcement.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Reaction()", - "type": "Array of Reaction()", - "version_history": { - "3.1.0": "added" - } - } - }, - "AnnouncementAccount": { - "id": { - "description": "The account ID of the mentioned user.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "3.1.0": "added" - } - }, - "username": { - "description": "The username of the mentioned user.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.1.0": "added" - } - }, - "url": { - "description": "The location of the mentioned user's profile.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "3.1.0": "added" - } - }, - "acct": { - "description": "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.1.0": "added" - } - } - }, - "AnnouncementStatus": { - "id": { - "description": "The ID of an attached Status in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "3.1.0": "added" - } - }, - "url": { - "description": "The URL of an attached Status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "3.1.0": "added" - } - } - }, - "DomainBlock": { - "domain": { - "description": "The domain which is blocked. This may be obfuscated or partially censored.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "digest": { - "description": "The SHA256 hash digest of the domain string.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (SHA256)", - "type": "String (SHA256)", - "version_history": { - "4.0.0": "added" - } - }, - "severity": { - "description": "The level to which the domain is blocked.", - "nullable": false, - "optional": false, - "enum": { - "silence": "Users from this domain will be hidden from timelines, threads, and notifications (unless you follow the user).", - "suspend": "Incoming messages from this domain will be rejected and dropped entirely." - }, - "type_key": "String (Enumerable, oneOf) `silence` = Users from this domain will be hidden from timelines, threads, and notifications (unless you follow the user). `suspend` = Incoming messages from this domain will be rejected and dropped entirely.", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "comment": { - "description": "An optional reason for the domain block.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - } - }, - "Status": { - "id": { - "description": "ID of the status in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer but not guaranteed to be a number)", - "type": "String (cast from an integer but not guaranteed to be a number)", - "version_history": { - "0.1.0": "added" - } - }, - "uri": { - "description": "URI of the status used for federation.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.1.0": "added" - } - }, - "created_at": { - "description": "The date when this status was created.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "0.1.0": "added" - } - }, - "account": { - "description": "The account that authored this status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Account()", - "type": "Account()", - "version_history": { - "0.1.0": "added" - } - }, - "content": { - "description": "HTML-encoded status content.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "0.1.0": "added" - } - }, - "visibility": { - "description": "Visibility of this status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", - "type": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", - "version_history": { - "0.9.9": "added" - } - }, - "sensitive": { - "description": "Is this status marked as sensitive content?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.9.9": "added" - } - }, - "spoiler_text": { - "description": "Subject or summary line, below which status content is collapsed until expanded.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "1.0.0": "added" - } - }, - "media_attachments": { - "description": "Media that is attached to this status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of MediaAttachment()", - "type": "Array of MediaAttachment()", - "version_history": { - "0.6.0": "added" - } - }, - "application": { - "description": "The application used to post this status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Hash", - "type": "Hash", - "version_history": { - "0.9.9": "added" - } - } - }, - "StatusApplication": { - "name": { - "description": "The name of the application that posted this status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.9.9": "added" - } - }, - "website": { - "description": "The website associated with the application that posted this status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (URL) or null", - "type": "String (URL) or null", - "version_history": { - "0.9.9": "added", - "3.5.1": "this property is now nullable" - } - }, - "mentions": { - "description": "Mentions of users within the status content.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of StatusMention(#Mention)", - "type": "Array of StatusMention(#Mention)", - "version_history": { - "0.6.0": "added" - } - }, - "tags": { - "description": "Hashtags used within the status content.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of StatusTag(#Tag)", - "type": "Array of StatusTag(#Tag)", - "version_history": { - "0.6.0": "added" - } - }, - "emojis": { - "description": "Custom emoji to be used when rendering status content.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of CustomEmoji()", - "type": "Array of CustomEmoji()", - "version_history": { - "2.0.0": "added" - } - }, - "reblogs_count": { - "description": "How many boosts this status has received.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "0.1.0": "added" - } - }, - "favourites_count": { - "description": "How many favourites this status has received.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "0.1.0": "added" - } - }, - "replies_count": { - "description": "How many replies this status has received.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "2.5.0": "added" - } - }, - "url": { - "description": "A link to the status's HTML representation.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (URL) or null", - "type": "String (URL) or null", - "version_history": { - "0.1.0": "added" - } - }, - "in_reply_to_id": { - "description": "ID of the status being replied to.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (cast from an integer but not guaranteed to be a number) or null", - "type": "String (cast from an integer but not guaranteed to be a number) or null", - "version_history": { - "0.1.0": "added" - } - }, - "in_reply_to_account_id": { - "description": "ID of the account that authored the status being replied to.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (cast from an integer but not guaranteed to be a number) or null", - "type": "String (cast from an integer but not guaranteed to be a number) or null", - "version_history": { - "0.1.0": "added" - } - }, - "reblog": { - "description": "The status being reblogged.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Status(#) or null", - "type": "Status(#) or null", - "version_history": { - "0.1.0": "added" - } - }, - "poll": { - "description": "The poll attached to the status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Poll() or null", - "type": "Poll() or null", - "version_history": { - "2.8.0": "added" - } - }, - "card": { - "description": "Preview card for links included within status content.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " PreviewCard() or null", - "type": "PreviewCard() or null", - "version_history": { - "2.6.0": "added" - } - }, - "language": { - "description": "Primary language of this status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 639 Part 1 two-letter language code) or null", - "type": "String (ISO 639 Part 1 two-letter language code) or null", - "version_history": { - "1.4.0": "added" - } - }, - "text": { - "description": "Plain-text source of a status. Returned instead of `content` when status is deleted, so the user may redraft from the source text without the client having to reverse-engineer the original text from the HTML content.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String or null", - "type": "String or null", - "version_history": { - "2.9.0": "added" - } - }, - "edited_at": { - "description": "Timestamp of when the status was last edited.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.5.0": "added" - } - }, - "favourited": { - "description": "If the current token has an authorized user: Have you favourited this status?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.1.0": "added" - } - }, - "reblogged": { - "description": "If the current token has an authorized user: Have you boosted this status?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.1.0": "added" - } - }, - "muted": { - "description": "If the current token has an authorized user: Have you muted notifications for this status's conversation?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "1.4.0": "added" - } - }, - "bookmarked": { - "description": "If the current token has an authorized user: Have you bookmarked this status?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "pinned": { - "description": "If the current token has an authorized user: Have you pinned this status? Only appears if the status is pinnable.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "1.6.0": "added" - } - }, - "filtered": { - "description": "If the current token has an authorized user: The filter and keywords that matched this status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of FilterResult()", - "type": "Array of FilterResult()", - "version_history": { - "4.0.0": "added" - } - } - }, - "StatusMention": { - "id": { - "description": "The account ID of the mentioned user.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "0.6.0": "added" - } - }, - "username": { - "description": "The username of the mentioned user.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.6.0": "added" - } - }, - "url": { - "description": "The location of the mentioned user's profile.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.6.0": "added" - } - }, - "acct": { - "description": "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.6.0": "added" - } - } - }, - "StatusTag": { - "name": { - "description": "The value of the hashtag after the # sign.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.9.0": "added" - } - }, - "url": { - "description": "A link to the hashtag on the instance.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.9.0": "added" - } - } - }, - "StatusEdit": { - "content": { - "description": "The content of the status at this revision.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "3.5.0": "added" - } - }, - "spoiler_text": { - "description": "The content of the subject or content warning at this revision.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "3.5.0": "added" - } - }, - "sensitive": { - "description": "Whether the status was marked sensitive at this revision.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.0": "added" - } - }, - "created_at": { - "description": "The timestamp of when the revision was published.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.5.0": "added" - } - }, - "account": { - "description": "The account that published this revision.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Account", - "type": "Account", - "version_history": { - "3.5.0": "added" - } - }, - "poll": { - "description": "The current state of the poll options at this revision. Note that edits changing the poll options will be collapsed together into one edit, since this action resets the poll.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Hash", - "type": "Hash", - "version_history": { - "3.5.0": "added" - } - } - }, - "StatusEditPoll.Options": { - "": { - "description": "The poll options at this revision.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Hash", - "type": "Array of Hash", - "version_history": { - "3.5.0": "added" - } - }, - "].titl": { - "description": "The text for a poll option.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "media_attachments": { - "description": "The current state of the poll options at this revision. Note that edits changing the poll options will be collapsed together into one edit, since this action resets the poll.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of MediaAttachment()", - "type": "Array of MediaAttachment()", - "version_history": { - "3.5.0": "added" - } - }, - "emojis": { - "description": "Any custom emoji that are used in the current revision.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of CustomEmoji()", - "type": "Array of CustomEmoji()", - "version_history": { - "3.5.0": "added" - } - } - }, - "Reaction": { - "name": { - "description": "The emoji used for the reaction. Either a unicode emoji, or a custom emoji's shortcode.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.1.0": "added" - } - }, - "count": { - "description": "The total number of users who have added this reaction.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "3.1.0": "added" - } - }, - "me": { - "description": "If there is a currently authorized user: Have you added this reaction?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "url": { - "description": "If the reaction is a custom emoji: A link to the custom emoji.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "3.1.0": "added" - } - }, - "static_url": { - "description": "If the reaction is a custom emoji: A link to a non-animated version of the custom emoji.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "3.1.0": "added" - } - } - }, - "List": { - "id": { - "description": "The internal database ID of the list.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.1.0": "added" - } - }, - "title": { - "description": "The user-defined title of the list.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.1.0": "added" - } - }, - "replies_policy": { - "description": "Which replies should be shown in the list.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (Enumerable oneOf) `followed` = Show replies to any followed user `list` = Show replies to members of the list `none` = Show replies to no one", - "type": "String (Enumerable oneOf) `followed` = Show replies to any followed user `list` = Show replies to members of the list `none` = Show replies to no one", - "version_history": { - "3.3.0": "added" - } - } - }, - "Translation": { - "content": { - "description": "The translated text of the status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "4.0.0": "added" - } - }, - "detected_source_language": { - "description": "The language of the source text, as auto-detected by the machine translation provider.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 639 language code)", - "type": "String (ISO 639 language code)", - "version_history": { - "4.0.0": "added" - } - }, - "provider": { - "description": "The service that provided the machine translation.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - } - }, - "Preferences": { - "posting:default:visibility": { - "description": "Default visibility for new posts. Equivalent to CredentialAccount#source\\[privacy\\]().", - "nullable": false, - "optional": false, - "enum": { - "public": "Public post", - "unlisted": "Unlisted post", - "private": "Followers-only post", - "direct": "Direct post" - }, - "type_key": "String (Enumerable, oneOf) `public` = Public post `unlisted` = Unlisted post `private` = Followers-only post `direct` = Direct post", - "type": "String", - "version_history": { - "2.8.0": "added" - } - }, - "posting:default:sensitive": { - "description": "Default sensitivity flag for new posts. Equivalent to CredentialAccount#source\\[sensitive\\]().", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "posting:default:language": { - "description": "Default language for new posts. Equivalent to CredentialAccount#source\\[language\\]()", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 639-1 language two-letter code), or null", - "type": "String (ISO 639-1 language two-letter code), or null", - "version_history": { - "2.8.0": "added" - } - }, - "reading:expand:media": { - "description": "Whether media attachments should be automatically displayed or blurred/hidden.", - "nullable": false, - "optional": false, - "enum": { - "default": "Hide media marked as sensitive", - "show_all": "Always show all media by default, regardless of sensitivity", - "hide_all": "Always hide all media by default, regardless of sensitivity" - }, - "type_key": "String (Enumerable, oneOf) `default` = Hide media marked as sensitive `show_all` = Always show all media by default, regardless of sensitivity `hide_all` = Always hide all media by default, regardless of sensitivity", - "type": "String", - "version_history": { - "2.8.0": "added" - } - }, - "reading:expand:spoilers": { - "description": "Whether CWs should be expanded by default.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - } - }, - "Filter": { - "id": { - "description": "The ID of the Filter in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "title": { - "description": "A title given by the user to name the filter.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "context": { - "description": "The contexts in which the filter should be applied.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of String (Enumerable, anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", - "type": "Array of String (Enumerable, anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", - "version_history": { - "4.0.0": "added" - } - }, - "expires_at": { - "description": "When the filter should no longer be applied.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime), or null if the filter does not expire", - "type": "String (ISO 8601 Datetime), or null if the filter does not expire", - "version_history": { - "4.0.0": "added" - } - }, - "filter_action": { - "description": "The action to be taken when a status matches this filter.", - "nullable": false, - "optional": false, - "enum": { - "warn": "show a warning that identifies the matching filter by `title`, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to `warn`).", - "hide": "do not show this status if it is received" - }, - "type_key": "String (Enumerable, oneOf) `warn` = show a warning that identifies the matching filter by `title`, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to `warn`). `hide` = do not show this status if it is received", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "keywords": { - "description": "The keywords grouped under this filter.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of FilterKeyword()", - "type": "Array of FilterKeyword()", - "version_history": { - "4.0.0": "added" - } - }, - "statuses": { - "description": "The statuses grouped under this filter.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of FilterStatus()", - "type": "Array of FilterStatus()", - "version_history": { - "4.0.0": "added" - } - } - }, - "AdminReport": { - "id": { - "description": "The ID of the report in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.9.1": "added" - } - }, - "action_taken": { - "description": "Whether an action was taken to resolve this report.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.9.1": "added" - } - }, - "action_taken_at": { - "description": "When an action was taken, if this report is currently resolved.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime) or null", - "type": "String (ISO 8601 Datetime) or null", - "version_history": { - "2.9.1": "added" - } - }, - "category": { - "description": "The category under which the report is classified.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (Enumerable oneOf) `spam` = Malicious, fake, or repetitive content `violation` = Violates one or more specific `rules`(#rules) `other` = The default (catch-all) category", - "type": "String (Enumerable oneOf) `spam` = Malicious, fake, or repetitive content `violation` = Violates one or more specific `rules`(#rules) `other` = The default (catch-all) category", - "version_history": { - "3.5.0": "added" - } - }, - "comment": { - "description": "An optional reason for reporting.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.9.1": "added" - } - }, - "forwarded": { - "description": "Whether a report was forwarded to a remote instance.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "4.0.0": "added" - } - }, - "created_at": { - "description": "The time the report was filed.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "2.9.1": "added" - } - }, - "updated_at": { - "description": "The time of last action on this report.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "2.9.1": "added" - } - }, - "account": { - "description": "The account which filed the report.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "AdminAccount()", - "type": "AdminAccount()", - "version_history": { - "2.9.1": "added" - } - }, - "target_account": { - "description": "The account being reported.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "AdminAccount()", - "type": "AdminAccount()", - "version_history": { - "2.9.1": "added" - } - }, - "assigned_account": { - "description": "The account of the moderator assigned to this report.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " AdminAccount() or null", - "type": "AdminAccount() or null", - "version_history": { - "2.9.1": "added" - } - }, - "action_taken_by_account": { - "description": "The account of the moderator who handled the report.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " AdminAccount() or null", - "type": "AdminAccount() or null", - "version_history": { - "2.9.1": "added" - } - }, - "statuses": { - "description": "Statuses attached to the report, for context.", + "Context": { + "doc_link": "https://docs.joinmastodon.org/entities/Context.md", + "ancestors": { + "description": "Parents in the thread.", "nullable": false, "optional": false, "enum": null, "type_key": "Array of Status()", "type": "Array of Status()", "version_history": { - "2.9.1": "added" + "0.6.0": "added" } }, - "rules": { - "description": "Rules attached to the report, for context.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Rule()", - "type": "Array of Rule()", - "version_history": { - "3.5.0": "added" - } - } - }, - "IdentityProof": { - "provider": { - "description": "The name of the identity provider.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.8.0": "added" - } - }, - "provider_username": { - "description": "The account owner's username on the identity provider's service.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.8.0": "added" - } - }, - "updated_at": { - "description": "When the identity proof was last updated.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "2.8.0": "added" - } - }, - "proof_url": { - "description": "A link to a statement of identity proof, hosted by the identity provider.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "2.8.0": "added" - } - }, - "profile_url": { - "description": "The account owner's profile URL on the identity provider.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "2.8.0": "added" - } - } - }, - "Search": { - "accounts": { - "description": "Accounts which match the given query", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Account()", - "type": "Array of Account()", - "version_history": { - "1.1.0": "added" - } - }, - "statuses": { - "description": "Statuses which match the given query", + "descendants": { + "description": "Children in the thread.", "nullable": false, "optional": false, "enum": null, "type_key": "Array of Status()", "type": "Array of Status()", "version_history": { - "1.1.0": "added" - } - }, - "hashtags": { - "description": "Hashtags which match the given query", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Tag()", - "type": "Array of Tag()", - "version_history": { - "1.1.0": "added", - "2.4.1": "v1/search deprecated because it returns Array of String. v2/search added which returns Array of Tag.", - "3.0.0": "v1 removed" - } - } - }, - "FilterStatus": { - "id": { - "description": "The ID of the FilterStatus in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "status_id": { - "description": "The ID of the Status that will be filtered.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - } - }, - "AdminDomainAllow": { - "id": { - "description": "The ID of the DomainAllow in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "domain": { - "description": "The domain that is allowed to federate.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "created_at": { - "description": "When the domain was allowed to federate.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "4.0.0": "added" - } - } - }, - "AdminIp": { - "ip": { - "description": "The IP address.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (IP address)", - "type": "String (IP address)", - "version_history": { - "3.5.0": "added" - } - }, - "used_at": { - "description": "The timestamp of when the IP address was last used for this account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.5.0": "added" - } - } - }, - "ScheduledStatus": { - "id": { - "description": "ID of the scheduled status in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer but not guaranteed to be a number)", - "type": "String (cast from an integer but not guaranteed to be a number)", - "version_history": { - "2.7.0": "added" - } - }, - "scheduled_at": { - "description": "The timestamp for when the status will be posted.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "2.7.0": "added" - } - }, - "params": { - "description": "The parameters that were used when scheduling the status, to be used when the status is posted.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Hash", - "type": "Hash", - "version_history": { - "2.7.0": "added" - } - } - }, - "ScheduledStatusParams": { - "text": { - "description": "Text to be used as status content.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.7.0": "added" - } - }, - "poll": { - "description": "Poll to be attached to the status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Hash", - "type": "Hash", - "version_history": { - "2.8.0": "added" - } - }, - "]": { - "description": "The poll options to be used.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of String", - "type": "Array of String", - "version_history": { - "2.8.0": "added" - } - }, - "expires_in": { - "description": "How many seconds the poll should last before closing.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer)", - "type": "String (cast from integer)", - "version_history": { - "2.8.0": "added" - } - }, - "multiple": { - "description": "Whether the poll allows multiple choices.", - "nullable": false, - "optional": true, - "enum": null, - "type_key": " Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "hide_totals": { - "description": "Whether the poll should hide total votes until after voting has ended.", - "nullable": false, - "optional": true, - "enum": null, - "type_key": " Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "media_ids": { - "description": "IDs of the MediaAttachments that will be attached to the status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Array of String", - "type": "Array of String", - "version_history": { - "2.7.0": "added" - } - }, - "sensitive": { - "description": "Whether the status will be marked as sensitive.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Boolean", - "type": "Boolean", - "version_history": { - "2.7.0": "added" - } - }, - "spoiler_text": { - "description": "The text of the content warning or summary for the status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String", - "type": "String", - "version_history": { - "2.7.0": "added" - } - }, - "visibility": { - "description": "The visibility that the status will have once it is posted.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", - "type": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", - "version_history": { - "2.7.0": "added" - } - }, - "in_reply_to_id": { - "description": "ID of the Status that will be replied to.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Integer", - "type": "Integer", - "version_history": { - "2.7.0": "added" - } - }, - "language": { - "description": "The language that will be used for the status.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 639-1 two-letter language code)", - "type": "String (ISO 639-1 two-letter language code)", - "version_history": { - "2.7.0": "added" - } - }, - "application_id": { - "description": "ID of the Application that posted the status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "2.7.0": "added" - } - }, - "scheduled_at": { - "description": "When the status will be scheduled. This will be null because the status is only scheduled once.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Null", - "type": "Null", - "version_history": { - "2.7.0": "added" - } - }, - "idempotency": { - "description": "Idempotency key to prevent duplicate statuses.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String", - "type": "String", - "version_history": { - "2.7.0": "added" - } - }, - "with_rate_limit": { - "description": "Whether the status should be rate limited .", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.7.0": "added" - } - }, - "media_attachments": { - "description": "Media that will be attached when the status is posted.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of MediaAttachment()", - "type": "Array of MediaAttachment()", - "version_history": { - "2.7.0": "added" + "0.6.0": "added" } } }, "Notification": { + "doc_link": "https://docs.joinmastodon.org/entities/Notification.md", "id": { "description": "The id of the notification in the database.", "nullable": false, @@ -1972,7 +2030,188 @@ } } }, + "Filter": { + "doc_link": "https://docs.joinmastodon.org/entities/Filter.md", + "id": { + "description": "The ID of the Filter in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "title": { + "description": "A title given by the user to name the filter.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "context": { + "description": "The contexts in which the filter should be applied.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of String (Enumerable, anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", + "type": "Array of String (Enumerable, anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", + "version_history": { + "4.0.0": "added" + } + }, + "expires_at": { + "description": "When the filter should no longer be applied.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime), or null if the filter does not expire", + "type": "String (ISO 8601 Datetime), or null if the filter does not expire", + "version_history": { + "4.0.0": "added" + } + }, + "filter_action": { + "description": "The action to be taken when a status matches this filter.", + "nullable": false, + "optional": false, + "enum": { + "warn": "show a warning that identifies the matching filter by `title`, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to `warn`).", + "hide": "do not show this status if it is received" + }, + "type_key": "String (Enumerable, oneOf) `warn` = show a warning that identifies the matching filter by `title`, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to `warn`). `hide` = do not show this status if it is received", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "keywords": { + "description": "The keywords grouped under this filter.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of FilterKeyword()", + "type": "Array of FilterKeyword()", + "version_history": { + "4.0.0": "added" + } + }, + "statuses": { + "description": "The statuses grouped under this filter.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of FilterStatus()", + "type": "Array of FilterStatus()", + "version_history": { + "4.0.0": "added" + } + } + }, + "FilterStatus": { + "doc_link": "https://docs.joinmastodon.org/entities/FilterStatus.md", + "id": { + "description": "The ID of the FilterStatus in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "status_id": { + "description": "The ID of the Status that will be filtered.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + } + }, + "FilterResult": { + "doc_link": "https://docs.joinmastodon.org/entities/FilterResult.md", + "filter": { + "description": "The filter that was matched.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Filter()", + "type": "Filter()", + "version_history": { + "4.0.0": "added" + } + }, + "keyword_matches": { + "description": "The keyword within the filter that was matched.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Array of String, or null", + "type": "Array of String, or null", + "version_history": { + "4.0.0": "added" + } + }, + "status_matches": { + "description": "The status ID within the filter that was matched.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String, or null", + "type": "String, or null", + "version_history": { + "4.0.0": "added" + } + } + }, + "Translation": { + "doc_link": "https://docs.joinmastodon.org/entities/Translation.md", + "content": { + "description": "The translated text of the status.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "4.0.0": "added" + } + }, + "detected_source_language": { + "description": "The language of the source text, as auto-detected by the machine translation provider.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 639 language code)", + "type": "String (ISO 639 language code)", + "version_history": { + "4.0.0": "added" + } + }, + "provider": { + "description": "The service that provided the machine translation.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + } + }, "V1Instance": { + "doc_link": "https://docs.joinmastodon.org/entities/V1_Instance.md", "uri": { "description": "The domain name of the instance.", "nullable": false, @@ -2052,6 +2291,7 @@ } }, "V1InstanceUrls": { + "doc_link": "https://docs.joinmastodon.org/entities/V1_Instance.md", "streaming_api": { "description": "The Websockets URL for connecting to the streaming API.", "nullable": false, @@ -2394,106 +2634,54 @@ } } }, - "Marker": { - "last_read_id": { - "description": "The ID of the most recently viewed entity.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer but not guaranteed to be a number) 3.0.0 - added", - "type": "String (cast from integer but not guaranteed to be a number) 3.0.0 - added" - }, - "version": { - "description": "An incrementing counter, used for locking to prevent write conflicts.", + "Role": { + "doc_link": "https://docs.joinmastodon.org/entities/Role.md", + "id": { + "description": "The ID of the Role in the database.", "nullable": false, "optional": false, "enum": null, "type_key": "Integer", "type": "Integer", "version_history": { - "3.0.0": "added" + "4.0.0": "added" } }, - "updated_at": { - "description": "The timestamp of when the marker was set.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime) 3.0.0 - added", - "type": "String (ISO 8601 Datetime) 3.0.0 - added" - } - }, - "Tag": { "name": { - "description": "The value of the hashtag after the # sign.", + "description": "The name of the role.", "nullable": false, "optional": false, "enum": null, "type_key": "String", "type": "String", "version_history": { - "0.9.0": "added" + "4.0.0": "added" } }, - "url": { - "description": "A link to the hashtag on the instance.", + "color": { + "description": "The hex code assigned to this role. If no hex code is assigned, the string will be empty.", "nullable": false, "optional": false, "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", + "type_key": "String", + "type": "String", "version_history": { - "0.9.0": "added" + "4.0.0": "added" } }, - "history": { - "description": "Usage statistics for given days (typically the past week).", + "permissions": { + "description": "A bitmask that represents the sum of all permissions granted to the role.", "nullable": false, "optional": false, "enum": null, - "type_key": "Array of Hash", - "type": "Array of Hash", + "type_key": "Integer", + "type": "Integer", "version_history": { - "2.4.1": "added" - } - } - }, - "TagHistory": { - "day": { - "description": "UNIX timestamp on midnight of the given day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (UNIX timestamp)", - "type": "String (UNIX timestamp)", - "version_history": { - "2.4.1": "added" + "4.0.0": "added" } }, - "uses": { - "description": "The counted usage of the tag within that day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer)", - "type": "String (cast from an integer)", - "version_history": { - "2.4.1": "added" - } - }, - "accounts": { - "description": "The total of accounts using the tag within that day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer)", - "type": "String (cast from an integer)", - "version_history": { - "2.4.1": "added" - } - }, - "following": { - "description": "Whether the current token's authorized user is following this tag.", + "highlighted": { + "description": "Whether the role is publicly visible as a badge on user profiles.", "nullable": false, "optional": false, "enum": null, @@ -2504,110 +2692,1559 @@ } } }, - "AdminTag": { + "ScheduledStatus": { + "doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus.md", "id": { - "description": "The ID of the Tag in the database.", + "description": "ID of the scheduled status in the database.", "nullable": false, "optional": false, "enum": null, - "type_key": "String (cast from integer, but not guaranteed to be a number)", - "type": "String (cast from integer, but not guaranteed to be a number)", + "type_key": "String (cast from an integer but not guaranteed to be a number)", + "type": "String (cast from an integer but not guaranteed to be a number)", "version_history": { - "3.5.0": "added" + "2.7.0": "added" } }, - "trendable": { - "description": "Whether the hashtag has been approved to trend.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.0": "added" - } - }, - "usable": { - "description": "Whether the hashtag has not been disabled from auto-linking.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.0": "added" - } - }, - "requires_review": { - "description": "Whether the hashtag has not been reviewed yet to approve or deny its trending.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.0": "added" - } - } - }, - "FeaturedTag": { - "id": { - "description": "The internal ID of the featured tag in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer but not guaranteed to be a number)", - "type": "String (cast from integer but not guaranteed to be a number)", - "version_history": { - "3.0.0": "added" - } - }, - "name": { - "description": "The name of the hashtag being featured.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.0.0": "added" - } - }, - "url": { - "description": "A link to all statuses by a user that contain this hashtag.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "3.3.0": "added" - } - }, - "statuses_count": { - "description": "The number of authored statuses containing this hashtag.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Number", - "type": "Number", - "version_history": { - "3.0.0": "added" - } - }, - "last_status_at": { - "description": "The timestamp of the last authored status containing this hashtag.", + "scheduled_at": { + "description": "The timestamp for when the status will be posted.", "nullable": false, "optional": false, "enum": null, "type_key": "String (ISO 8601 Datetime)", "type": "String (ISO 8601 Datetime)", "version_history": { - "3.0.0": "added" + "2.7.0": "added" + } + }, + "params": { + "description": "The parameters that were used when scheduling the status, to be used when the status is posted.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Hash", + "type": "Hash", + "version_history": { + "2.7.0": "added" + } + } + }, + "ScheduledStatusParams": { + "doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus.md", + "text": { + "description": "Text to be used as status content.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.7.0": "added" + } + }, + "poll": { + "description": "Poll to be attached to the status.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Hash", + "type": "Hash", + "version_history": { + "2.8.0": "added" + } + }, + "]": { + "description": "The poll options to be used.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of String", + "type": "Array of String", + "version_history": { + "2.8.0": "added" + } + }, + "expires_in": { + "description": "How many seconds the poll should last before closing.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer)", + "type": "String (cast from integer)", + "version_history": { + "2.8.0": "added" + } + }, + "multiple": { + "description": "Whether the poll allows multiple choices.", + "nullable": false, + "optional": true, + "enum": null, + "type_key": " Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "hide_totals": { + "description": "Whether the poll should hide total votes until after voting has ended.", + "nullable": false, + "optional": true, + "enum": null, + "type_key": " Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "media_ids": { + "description": "IDs of the MediaAttachments that will be attached to the status.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Array of String", + "type": "Array of String", + "version_history": { + "2.7.0": "added" + } + }, + "sensitive": { + "description": "Whether the status will be marked as sensitive.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Boolean", + "type": "Boolean", + "version_history": { + "2.7.0": "added" + } + }, + "spoiler_text": { + "description": "The text of the content warning or summary for the status.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String", + "type": "String", + "version_history": { + "2.7.0": "added" + } + }, + "visibility": { + "description": "The visibility that the status will have once it is posted.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", + "type": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", + "version_history": { + "2.7.0": "added" + } + }, + "in_reply_to_id": { + "description": "ID of the Status that will be replied to.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Integer", + "type": "Integer", + "version_history": { + "2.7.0": "added" + } + }, + "language": { + "description": "The language that will be used for the status.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 639-1 two-letter language code)", + "type": "String (ISO 639-1 two-letter language code)", + "version_history": { + "2.7.0": "added" + } + }, + "application_id": { + "description": "ID of the Application that posted the status.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "2.7.0": "added" + } + }, + "scheduled_at": { + "description": "When the status will be scheduled. This will be null because the status is only scheduled once.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Null", + "type": "Null", + "version_history": { + "2.7.0": "added" + } + }, + "idempotency": { + "description": "Idempotency key to prevent duplicate statuses.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String", + "type": "String", + "version_history": { + "2.7.0": "added" + } + }, + "with_rate_limit": { + "description": "Whether the status should be rate limited .", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.7.0": "added" + } + }, + "media_attachments": { + "description": "Media that will be attached when the status is posted.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of MediaAttachment()", + "type": "Array of MediaAttachment()", + "version_history": { + "2.7.0": "added" + } + } + }, + "AdminDimension": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension.md", + "key": { + "description": "The unique keystring for the requested dimension.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "data": { + "description": "The data available for the requested dimension.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Hash", + "type": "Array of Hash", + "version_history": { + "3.5.0": "added" + } + } + }, + "Data": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension.md", + "key": { + "description": "The unique keystring for this data item.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "human_key": { + "description": "A human-readable key for this data item.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "value": { + "description": "The value for this data item.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "unit": { + "description": "The units associated with this data item's value, if applicable.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "human_value": { + "description": "A human-readable formatted value for this data item.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + } + }, + "List": { + "doc_link": "https://docs.joinmastodon.org/entities/List.md", + "id": { + "description": "The internal database ID of the list.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.1.0": "added" + } + }, + "title": { + "description": "The user-defined title of the list.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.1.0": "added" + } + }, + "replies_policy": { + "description": "Which replies should be shown in the list.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (Enumerable oneOf) `followed` = Show replies to any followed user `list` = Show replies to members of the list `none` = Show replies to no one", + "type": "String (Enumerable oneOf) `followed` = Show replies to any followed user `list` = Show replies to members of the list `none` = Show replies to no one", + "version_history": { + "3.3.0": "added" + } + } + }, + "IdentityProof": { + "doc_link": "https://docs.joinmastodon.org/entities/IdentityProof.md", + "provider": { + "description": "The name of the identity provider.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.8.0": "added" + } + }, + "provider_username": { + "description": "The account owner's username on the identity provider's service.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.8.0": "added" + } + }, + "updated_at": { + "description": "When the identity proof was last updated.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "2.8.0": "added" + } + }, + "proof_url": { + "description": "A link to a statement of identity proof, hosted by the identity provider.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "2.8.0": "added" + } + }, + "profile_url": { + "description": "The account owner's profile URL on the identity provider.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "2.8.0": "added" + } + } + }, + "AdminEmailDomainBlock": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_EmailDomainBlock.md", + "id": { + "description": "The ID of the EmailDomainBlock in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "domain": { + "description": "The email domain that is not allowed to be used for signups.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "created_at": { + "description": "When the email domain was disallowed from signups.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "4.0.0": "added" + } + }, + "history": { + "description": "Usage statistics for given days (typically the past week).", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Hash", + "type": "Array of Hash", + "version_history": { + "4.0.0": "added" + } + } + }, + "AdminEmailDomainBlockHistory": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_EmailDomainBlock.md", + "day": { + "description": "UNIX timestamp on midnight of the given day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (UNIX timestamp)", + "type": "String (UNIX timestamp)", + "version_history": { + "4.0.0": "added" + } + }, + "accounts": { + "description": "The counted accounts signup attempts using that email domain within that day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer)", + "type": "String (cast from an integer)", + "version_history": { + "4.0.0": "added" + } + }, + "uses": { + "description": "The counted IP signup attempts of that email domain within that day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer)", + "type": "String (cast from an integer)", + "version_history": { + "4.0.0": "added" + } + } + }, + "PreviewCard": { + "doc_link": "https://docs.joinmastodon.org/entities/PreviewCard.md", + "url": { + "description": "Location of linked resource.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "1.0.0": "added" + } + }, + "title": { + "description": "Title of linked resource.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "1.0.0": "added" + } + }, + "description": { + "description": "Description of preview.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "1.0.0": "added" + } + }, + "type": { + "description": "The type of the preview card.", + "nullable": false, + "optional": false, + "enum": { + "link": "Link OEmbed", + "photo": "Photo OEmbed", + "video": "Video OEmbed", + "rich": "iframe OEmbed. Not currently accepted, so won't show up in practice." + }, + "type_key": "String (Enumerable, oneOf) `link` = Link OEmbed `photo` = Photo OEmbed `video` = Video OEmbed `rich` = iframe OEmbed. Not currently accepted, so won't show up in practice.", + "type": "String", + "version_history": { + "1.3.0": "added" + } + }, + "author_name": { + "description": "The author of the original resource.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "1.3.0": "added" + } + }, + "author_url": { + "description": "A link to the author of the original resource.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "1.3.0": "added" + } + }, + "provider_name": { + "description": "The provider of the original resource.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "1.3.0": "added" + } + }, + "provider_url": { + "description": "A link to the provider of the original resource.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "1.3.0": "added" + } + }, + "html": { + "description": "HTML to be used for generating the preview card.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "1.3.0": "added" + } + }, + "width": { + "description": "Width of preview, in pixels.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "1.3.0": "added" + } + }, + "height": { + "description": "Height of preview, in pixels.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "1.3.0": "added" + } + }, + "image": { + "description": "Preview thumbnail.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (URL)", + "type": "String (URL)", + "version_history": { + "1.0.0": "added" + } + }, + "embed_url": { + "description": "Used for photo embeds, instead of custom `html`.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "2.1.0": "added" + } + }, + "blurhash": { + "description": "A hash computed by the BlurHash algorithm(https://github.com/woltapp/blurhash), for generating colorful preview thumbnails when media has not been downloaded yet.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String", + "type": "String", + "version_history": { + "3.2.0": "added" + } + } + }, + "TrendsLink": { + "doc_link": "https://docs.joinmastodon.org/entities/PreviewCard.md", + "history": { + "description": "Usage statistics for given days (typically the past week).", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Hash", + "type": "Array of Hash", + "version_history": { + "3.5.0": "added" + } + } + }, + "TrendsLinkHistory": { + "doc_link": "https://docs.joinmastodon.org/entities/PreviewCard.md", + "day": { + "description": "UNIX timestamp on midnight of the given day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (UNIX timestamp)", + "type": "String (UNIX timestamp)", + "version_history": { + "3.5.0": "added" + } + }, + "accounts": { + "description": "The counted accounts using the link within that day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer)", + "type": "String (cast from an integer)", + "version_history": { + "3.5.0": "added" + } + }, + "uses": { + "description": "The counted statuses using the link within that day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer)", + "type": "String (cast from an integer)", + "version_history": { + "3.5.0": "added" + } + } + }, + "Relationship": { + "doc_link": "https://docs.joinmastodon.org/entities/Relationship.md", + "id": { + "description": "The account ID.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "0.6.0": "added" + } + }, + "following": { + "description": "Are you following this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "0.6.0": "added" + } + }, + "showing_reblogs": { + "description": "Are you receiving this user's boosts in your home timeline?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.1.0": "added" + } + }, + "notifying": { + "description": "Have you enabled notifications for this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.3.0": "added" + } + }, + "languages": { + "description": "Which languages are you following from this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of String (ISO 639-1 language two-letter code)", + "type": "Array of String (ISO 639-1 language two-letter code)", + "version_history": { + "4.0.0": "added" + } + }, + "followed_by": { + "description": "Are you followed by this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "0.6.0": "added" + } + }, + "blocking": { + "description": "Are you blocking this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "0.6.0": "added" + } + }, + "blocked_by": { + "description": "Is this user blocking you?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "muting": { + "description": "Are you muting this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "1.1.0": "added" + } + }, + "muting_notifications": { + "description": "Are you muting notifications from this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.1.0": "added" + } + }, + "requested": { + "description": "Do you have a pending follow request for this user?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "0.9.9": "added" + } + }, + "domain_blocking": { + "description": "Are you blocking this user's domain?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "1.4.0": "added" + } + }, + "endorsed": { + "description": "Are you featuring this user on your profile?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.5.0": "added" + } + }, + "note": { + "description": "This user's profile bio", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.2.0": "added" + } + } + }, + "Poll": { + "doc_link": "https://docs.joinmastodon.org/entities/Poll.md", + "id": { + "description": "The ID of the poll in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.8.0": "added" + } + }, + "expires_at": { + "description": "When the poll ends.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime), or null if the poll does not end", + "type": "String (ISO 8601 Datetime), or null if the poll does not end", + "version_history": { + "2.8.0": "added" + } + }, + "expired": { + "description": "Is the poll currently expired?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "multiple": { + "description": "Does the poll allow multiple-choice answers?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "votes_count": { + "description": "How many votes have been received.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "2.8.0": "added" + } + }, + "voters_count": { + "description": "How many unique accounts have voted on a multiple-choice poll.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Integer, or null if `multiple` is false.", + "type": "Integer, or null if `multiple` is false.", + "version_history": { + "2.8.0": "added" + } + }, + "options": { + "description": "Possible answers for the poll.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of PollOption(#Option)", + "type": "Array of PollOption(#Option)", + "version_history": { + "2.8.0": "added" + } + }, + "emojis": { + "description": "Custom emoji to be used for rendering poll options.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of CustomEmoji()", + "type": "Array of CustomEmoji()", + "version_history": { + "2.8.0": "added" + } + }, + "voted": { + "description": "When called with a user token, has the authorized user voted?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.8.0": "added" + } + }, + "own_votes": { + "description": "When called with a user token, which options has the authorized user chosen? Contains an array of index values for `options`.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Integer", + "type": "Array of Integer", + "version_history": { + "2.8.0": "added" + } + } + }, + "PollOption": { + "doc_link": "https://docs.joinmastodon.org/entities/Poll.md", + "title": { + "description": "The text value of the poll option.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.8.0": "added" + } + }, + "votes_count": { + "description": "The total number of received votes for this option.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Integer, or null if results are not published yet.", + "type": "Integer, or null if results are not published yet.", + "version_history": { + "2.8.0": "added" + } + } + }, + "AdminIp": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Ip.md", + "ip": { + "description": "The IP address.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (IP address)", + "type": "String (IP address)", + "version_history": { + "3.5.0": "added" + } + }, + "used_at": { + "description": "The timestamp of when the IP address was last used for this account.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.5.0": "added" + } + } + }, + "AdminCanonicalEmailBlock": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_CanonicalEmailBlock.md", + "id": { + "description": "The ID of the email block in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "canonical_email_hash": { + "description": "The SHA256 hash of the canonical email address.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (SHA256)", + "type": "String (SHA256)", + "version_history": { + "4.0.0": "added" + } + } + }, + "StatusSource": { + "doc_link": "https://docs.joinmastodon.org/entities/StatusSource.md", + "id": { + "description": "ID of the status in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer but not guaranteed to be a number)", + "type": "String (cast from an integer but not guaranteed to be a number)", + "version_history": { + "3.5.0": "added" + } + }, + "text": { + "description": "The plain text used to compose the status.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + }, + "spoiler_text": { + "description": "The plain text used to compose the status's subject or content warning.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.5.0": "added" + } + } + }, + "ExtendedDescription": { + "doc_link": "https://docs.joinmastodon.org/entities/ExtendedDescription.md", + "updated_at": { + "description": "A timestamp of when the extended description was last updated.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "4.0.0": "added" + } + }, + "content": { + "description": "The rendered HTML content of the extended description.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "4.0.0": "added" + } + } + }, + "AdminReport": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_Report.md", + "id": { + "description": "The ID of the report in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "2.9.1": "added" + } + }, + "action_taken": { + "description": "Whether an action was taken to resolve this report.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "2.9.1": "added" + } + }, + "action_taken_at": { + "description": "When an action was taken, if this report is currently resolved.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime) or null", + "type": "String (ISO 8601 Datetime) or null", + "version_history": { + "2.9.1": "added" + } + }, + "category": { + "description": "The category under which the report is classified.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (Enumerable oneOf) `spam` = Malicious, fake, or repetitive content `violation` = Violates one or more specific `rules`(#rules) `other` = The default (catch-all) category", + "type": "String (Enumerable oneOf) `spam` = Malicious, fake, or repetitive content `violation` = Violates one or more specific `rules`(#rules) `other` = The default (catch-all) category", + "version_history": { + "3.5.0": "added" + } + }, + "comment": { + "description": "An optional reason for reporting.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "2.9.1": "added" + } + }, + "forwarded": { + "description": "Whether a report was forwarded to a remote instance.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "4.0.0": "added" + } + }, + "created_at": { + "description": "The time the report was filed.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "2.9.1": "added" + } + }, + "updated_at": { + "description": "The time of last action on this report.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "2.9.1": "added" + } + }, + "account": { + "description": "The account which filed the report.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "AdminAccount()", + "type": "AdminAccount()", + "version_history": { + "2.9.1": "added" + } + }, + "target_account": { + "description": "The account being reported.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "AdminAccount()", + "type": "AdminAccount()", + "version_history": { + "2.9.1": "added" + } + }, + "assigned_account": { + "description": "The account of the moderator assigned to this report.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " AdminAccount() or null", + "type": "AdminAccount() or null", + "version_history": { + "2.9.1": "added" + } + }, + "action_taken_by_account": { + "description": "The account of the moderator who handled the report.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " AdminAccount() or null", + "type": "AdminAccount() or null", + "version_history": { + "2.9.1": "added" + } + }, + "statuses": { + "description": "Statuses attached to the report, for context.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Status()", + "type": "Array of Status()", + "version_history": { + "2.9.1": "added" + } + }, + "rules": { + "description": "Rules attached to the report, for context.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Rule()", + "type": "Array of Rule()", + "version_history": { + "3.5.0": "added" + } + } + }, + "Announcement": { + "doc_link": "https://docs.joinmastodon.org/entities/Announcement.md", + "id": { + "description": "The ID of the announcement in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "3.1.0": "added" + } + }, + "content": { + "description": "The text of the announcement.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (HTML)", + "type": "String (HTML)", + "version_history": { + "3.1.0": "added" + } + }, + "starts_at": { + "description": "When the announcement will start.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime) or null", + "type": "String (ISO 8601 Datetime) or null", + "version_history": { + "3.1.0": "added" + } + }, + "ends_at": { + "description": "When the announcement will end.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime) or null", + "type": "String (ISO 8601 Datetime) or null", + "version_history": { + "3.1.0": "added" + } + }, + "published": { + "description": "Whether the announcement is currently active.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "all_day": { + "description": "Whether the announcement should start and end on dates only instead of datetimes. Will be false if there is no `starts_at` or `ends_at` time.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "published_at": { + "description": "When the announcement was published.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.1.0": "added" + } + }, + "updated_at": { + "description": "When the announcement was last updated.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.1.0": "added" + } + }, + "read": { + "description": "Whether the announcement has been read by the current user.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "mentions": { + "description": "Accounts mentioned in the announcement text.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of AnnouncementAccount(#Account)", + "type": "Array of AnnouncementAccount(#Account)", + "version_history": { + "3.1.0": "added" + } + }, + "statuses": { + "description": "Statuses linked in the announcement text.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of AnnouncementStatus(#Status)", + "type": "Array of AnnouncementStatus(#Status)", + "version_history": { + "3.1.0": "added" + } + }, + "tags": { + "description": "Tags linked in the announcement text.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of StatusTag()", + "type": "Array of StatusTag()", + "version_history": { + "3.1.0": "added" + } + }, + "emojis": { + "description": "Custom emoji used in the announcement text.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of CustomEmoji()", + "type": "Array of CustomEmoji()", + "version_history": { + "3.1.0": "added" + } + }, + "reactions": { + "description": "Emoji reactions attached to the announcement.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Reaction()", + "type": "Array of Reaction()", + "version_history": { + "3.1.0": "added" + } + } + }, + "AnnouncementAccount": { + "doc_link": "https://docs.joinmastodon.org/entities/Announcement.md", + "id": { + "description": "The account ID of the mentioned user.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "3.1.0": "added" + } + }, + "username": { + "description": "The username of the mentioned user.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.1.0": "added" + } + }, + "url": { + "description": "The location of the mentioned user's profile.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "3.1.0": "added" + } + }, + "acct": { + "description": "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "3.1.0": "added" + } + } + }, + "AnnouncementStatus": { + "doc_link": "https://docs.joinmastodon.org/entities/Announcement.md", + "id": { + "description": "The ID of an attached Status in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "3.1.0": "added" + } + }, + "url": { + "description": "The URL of an attached Status.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "3.1.0": "added" + } + } + }, + "Suggestion": { + "doc_link": "https://docs.joinmastodon.org/entities/Suggestion.md", + "source": { + "description": "The reason this account is being suggested.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (Enumerable oneOf) `staff` = This account was manually recommended by your administration team `past_interactions` = You have interacted with this account previously `global` = This account has many reblogs, favourites, and active local followers within the last 30 days", + "type": "String (Enumerable oneOf) `staff` = This account was manually recommended by your administration team `past_interactions` = You have interacted with this account previously `global` = This account has many reblogs, favourites, and active local followers within the last 30 days", + "version_history": { + "3.4.0": "added" + } + }, + "account": { + "description": "The account being recommended to follow.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Account()", + "type": "Account()", + "version_history": { + "3.4.0": "added" + } + } + }, + "AdminDomainAllow": { + "doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainAllow.md", + "id": { + "description": "The ID of the DomainAllow in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "4.0.0": "added" + } + }, + "domain": { + "description": "The domain that is allowed to federate.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "4.0.0": "added" + } + }, + "created_at": { + "description": "When the domain was allowed to federate.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "4.0.0": "added" } } }, "Instance": { + "doc_link": "https://docs.joinmastodon.org/entities/Instance.md", "domain": { "description": "The domain name of the instance.", "nullable": false, @@ -2676,6 +4313,7 @@ } }, "InstanceUsage": { + "doc_link": "https://docs.joinmastodon.org/entities/Instance.md", "users": { "description": "Usage data related to users on this instance.", "nullable": false, @@ -3106,1789 +4744,134 @@ } } }, - "AdminCohort": { - "period": { - "description": "The timestamp for the start of the period, at midnight.", + "FeaturedTag": { + "doc_link": "https://docs.joinmastodon.org/entities/FeaturedTag.md", + "id": { + "description": "The internal ID of the featured tag in the database.", "nullable": false, "optional": false, "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", + "type_key": "String (cast from integer but not guaranteed to be a number)", + "type": "String (cast from integer but not guaranteed to be a number)", "version_history": { - "3.5.0": "added" + "3.0.0": "added" } }, - "frequency": { - "description": "The size of the bucket for the returned data.", + "name": { + "description": "The name of the hashtag being featured.", "nullable": false, "optional": false, "enum": null, - "type_key": "String (Enumerable oneOf) `day` = Daily buckets `month` = Monthly buckets", - "type": "String (Enumerable oneOf) `day` = Daily buckets `month` = Monthly buckets", + "type_key": "String", + "type": "String", "version_history": { - "3.5.0": "added" + "3.0.0": "added" } }, - "data": { - "description": "Retention data for users who registered during the given period.", + "url": { + "description": "A link to all statuses by a user that contain this hashtag.", "nullable": false, "optional": false, "enum": null, - "type_key": "Array of CohortData(#CohortData)", - "type": "Array of CohortData(#CohortData)", + "type_key": "String (URL)", + "type": "String (URL)", "version_history": { - "3.5.0": "added" - } - } - }, - "CohortData": { - "date": { - "description": "The timestamp for the start of the bucket, at midnight.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.5.0": "added" + "3.3.0": "added" } }, - "rate": { - "description": "The percentage rate of users who registered in the specified `period` and were active for the given `date` bucket.", + "statuses_count": { + "description": "The number of authored statuses containing this hashtag.", "nullable": false, "optional": false, "enum": null, "type_key": "Number", "type": "Number", - "version_history": { - "3.5.0": "added" - } - }, - "value": { - "description": "How many users registered in the specified `period` and were active for the given `date` bucket.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "3.5.0": "added" - } - } - }, - "Account": { - "id": { - "description": "The account id.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "0.1.0": "added" - } - }, - "username": { - "description": "The username of the account, not including domain.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.1.0": "added" - } - }, - "acct": { - "description": "The Webfinger account URI. Equal to `username` for local users, or `username@domain` for remote users.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.1.0": "added" - } - }, - "url": { - "description": "The location of the user's profile page.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.1.0": "added" - } - }, - "display_name": { - "description": "The profile's display name.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.1.0": "added" - } - }, - "note": { - "description": "The profile's bio or description.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "0.1.0": "added" - } - }, - "avatar": { - "description": "An image icon that is shown next to statuses and in the profile.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.1.0": "added" - } - }, - "avatar_static": { - "description": "A static version of the avatar. Equal to `avatar` if its value is a static image; different if `avatar` is an animated GIF.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "1.1.2": "added" - } - }, - "header": { - "description": "An image banner that is shown above the profile and in profile cards.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.1.0": "added" - } - }, - "header_static": { - "description": "A static version of the header. Equal to `header` if its value is a static image; different if `header` is an animated GIF.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "1.1.2": "added" - } - }, - "locked": { - "description": "Whether the account manually approves follow requests.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.1.0": "added" - } - }, - "fields": { - "description": "Additional metadata attached to a profile as name-value pairs.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Field(#Field)", - "type": "Array of Field(#Field)", - "version_history": { - "2.4.0": "added" - } - }, - "emojis": { - "description": "Custom emoji entities to be used when rendering the profile.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of CustomEmoji()", - "type": "Array of CustomEmoji()", - "version_history": { - "2.4.0": "added" - } - }, - "bot": { - "description": "Indicates that the account may perform automated actions, may not be monitored, or identifies as a robot.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.0": "added" - } - }, - "group": { - "description": "Indicates that the account represents a Group actor.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "discoverable": { - "description": "Whether the account has opted into discovery features such as the profile directory.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "noindex": { - "description": "Whether the local user has opted out of being indexed by search engines.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Boolean", - "type": "Boolean", - "version_history": { - "4.0.0": "added" - } - }, - "moved": { - "description": "Indicates that the profile is currently inactive and that its user has moved to a new account.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Account(), or null if the profile is suspended.", - "type": "Account(), or null if the profile is suspended.", - "version_history": { - "2.1.0": "added" - } - }, - "suspended": { - "description": "An extra attribute returned only when an account is suspended.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.3.0": "added" - } - }, - "limited": { - "description": "An extra attribute returned only when an account is silenced. If true, indicates that the account should be hidden behind a warning screen.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.3": "added" - } - }, - "created_at": { - "description": "When the account was created.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "0.1.0": "added", - "3.4.0": "now resolves to midnight instead of an exact time" - } - }, - "last_status_at": { - "description": "When the most recent status was posted.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Date), or null if no statuses", - "type": "String (ISO 8601 Date), or null if no statuses", - "version_history": { - "3.0.0": "added", - "3.1.0": "now returns date only, no time" - } - }, - "statuses_count": { - "description": "How many statuses are attached to this account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "0.1.0": "added" - } - }, - "followers_count": { - "description": "The reported followers of this profile.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "0.1.0": "added" - } - }, - "following_count": { - "description": "The reported follows of this profile.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "0.1.0": "added" - } - } - }, - "CredentialAccount": { - "source": { - "description": "An extra attribute that contains source values to be used with API methods that verify credentials() and update credentials().", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Hash", - "type": "Hash", - "version_history": { - "2.4.0": "added" - } - } - }, - "CredentialAccountSource": { - "note": { - "description": "Profile bio, in plain-text instead of in HTML.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "1.5.0": "added" - } - }, - "fields": { - "description": "Metadata about the account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Field(#Field)", - "type": "Array of Field(#Field)", - "version_history": { - "2.4.0": "added" - } - }, - "privacy": { - "description": "The default post privacy to be used for new statuses.", - "nullable": false, - "optional": false, - "enum": { - "public": "Public post", - "unlisted": "Unlisted post", - "private": "Followers-only post", - "direct": "Direct post" - }, - "type_key": "String (Enumerable, oneOf) `public` = Public post `unlisted` = Unlisted post `private` = Followers-only post `direct` = Direct post", - "type": "String", - "version_history": { - "1.5.0": "added" - } - }, - "sensitive": { - "description": "Whether new statuses should be marked sensitive by default.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "1.5.0": "added" - } - }, - "language": { - "description": "The default posting language for new statuses.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 639-1 language two-letter code) or empty string", - "type": "String (ISO 639-1 language two-letter code) or empty string", - "version_history": { - "2.4.2": "added" - } - }, - "follow_requests_count": { - "description": "The number of pending follow requests.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", "version_history": { "3.0.0": "added" } }, - "role": { - "description": "The role assigned to the currently authorized user.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Role()", - "type": "Role()", - "version_history": { - "4.0.0": "added" - } - } - }, - "MutedAccount": { - "mute_expires_at": { - "description": "When a timed mute will expire, if applicable.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime), or null if the mute is indefinite", - "type": "String (ISO 8601 Datetime), or null if the mute is indefinite", - "version_history": { - "3.3.0": "added" - } - } - }, - "Field": { - "name": { - "description": "The key of a given field's key-value pair.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.4.0": "added" - } - }, - "value": { - "description": "The value associated with the `name` key.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "2.4.0": "added" - } - }, - "verified_at": { - "description": "Timestamp of when the server verified a URL value for a rel=\"me\" link.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime) if `value` is a verified URL. Otherwise, null.", - "type": "String (ISO 8601 Datetime) if `value` is a verified URL. Otherwise, null.", - "version_history": { - "2.6.0": "added" - } - } - }, - "Context": { - "ancestors": { - "description": "Parents in the thread.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Status()", - "type": "Array of Status()", - "version_history": { - "0.6.0": "added" - } - }, - "descendants": { - "description": "Children in the thread.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Status()", - "type": "Array of Status()", - "version_history": { - "0.6.0": "added" - } - } - }, - "AdminEmailDomainBlock": { - "id": { - "description": "The ID of the EmailDomainBlock in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "domain": { - "description": "The email domain that is not allowed to be used for signups.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "created_at": { - "description": "When the email domain was disallowed from signups.", + "last_status_at": { + "description": "The timestamp of the last authored status containing this hashtag.", "nullable": false, "optional": false, "enum": null, "type_key": "String (ISO 8601 Datetime)", "type": "String (ISO 8601 Datetime)", "version_history": { - "4.0.0": "added" - } - }, - "history": { - "description": "Usage statistics for given days (typically the past week).", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Hash", - "type": "Array of Hash", - "version_history": { - "4.0.0": "added" + "3.0.0": "added" } } }, - "AdminEmailDomainBlockHistory": { - "day": { - "description": "UNIX timestamp on midnight of the given day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (UNIX timestamp)", - "type": "String (UNIX timestamp)", - "version_history": { - "4.0.0": "added" - } - }, - "accounts": { - "description": "The counted accounts signup attempts using that email domain within that day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer)", - "type": "String (cast from an integer)", - "version_history": { - "4.0.0": "added" - } - }, - "uses": { - "description": "The counted IP signup attempts of that email domain within that day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer)", - "type": "String (cast from an integer)", - "version_history": { - "4.0.0": "added" - } - } - }, - "PreviewCard": { - "url": { - "description": "Location of linked resource.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "1.0.0": "added" - } - }, - "title": { - "description": "Title of linked resource.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "1.0.0": "added" - } - }, - "description": { - "description": "Description of preview.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "1.0.0": "added" - } - }, - "type": { - "description": "The type of the preview card.", - "nullable": false, - "optional": false, - "enum": { - "link": "Link OEmbed", - "photo": "Photo OEmbed", - "video": "Video OEmbed", - "rich": "iframe OEmbed. Not currently accepted, so won't show up in practice." - }, - "type_key": "String (Enumerable, oneOf) `link` = Link OEmbed `photo` = Photo OEmbed `video` = Video OEmbed `rich` = iframe OEmbed. Not currently accepted, so won't show up in practice.", - "type": "String", - "version_history": { - "1.3.0": "added" - } - }, - "author_name": { - "description": "The author of the original resource.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "1.3.0": "added" - } - }, - "author_url": { - "description": "A link to the author of the original resource.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "1.3.0": "added" - } - }, - "provider_name": { - "description": "The provider of the original resource.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "1.3.0": "added" - } - }, - "provider_url": { - "description": "A link to the provider of the original resource.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "1.3.0": "added" - } - }, - "html": { - "description": "HTML to be used for generating the preview card.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (HTML)", - "type": "String (HTML)", - "version_history": { - "1.3.0": "added" - } - }, - "width": { - "description": "Width of preview, in pixels.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "1.3.0": "added" - } - }, - "height": { - "description": "Height of preview, in pixels.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "1.3.0": "added" - } - }, - "image": { - "description": "Preview thumbnail.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (URL)", - "type": "String (URL)", - "version_history": { - "1.0.0": "added" - } - }, - "embed_url": { - "description": "Used for photo embeds, instead of custom `html`.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "2.1.0": "added" - } - }, - "blurhash": { - "description": "A hash computed by the BlurHash algorithm(https://github.com/woltapp/blurhash), for generating colorful preview thumbnails when media has not been downloaded yet.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String", - "type": "String", - "version_history": { - "3.2.0": "added" - } - } - }, - "TrendsLink": { - "history": { - "description": "Usage statistics for given days (typically the past week).", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Hash", - "type": "Array of Hash", - "version_history": { - "3.5.0": "added" - } - } - }, - "TrendsLinkHistory": { - "day": { - "description": "UNIX timestamp on midnight of the given day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (UNIX timestamp)", - "type": "String (UNIX timestamp)", - "version_history": { - "3.5.0": "added" - } - }, - "accounts": { - "description": "The counted accounts using the link within that day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer)", - "type": "String (cast from an integer)", - "version_history": { - "3.5.0": "added" - } - }, - "uses": { - "description": "The counted statuses using the link within that day.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer)", - "type": "String (cast from an integer)", - "version_history": { - "3.5.0": "added" - } - } - }, - "MediaAttachment": { + "Status": { + "doc_link": "https://docs.joinmastodon.org/entities/Status.md", "id": { - "description": "The ID of the attachment in the database.", + "description": "ID of the status in the database.", "nullable": false, "optional": false, "enum": null, "type_key": "String (cast from an integer but not guaranteed to be a number)", "type": "String (cast from an integer but not guaranteed to be a number)", "version_history": { - "0.6.0": "added" + "0.1.0": "added" } }, - "type": { - "description": "The type of the attachment.", - "nullable": false, - "optional": false, - "enum": { - "unknown": "unsupported or unrecognized file type", - "image": "Static image", - "gifv": "Looping, soundless animation", - "video": "Video clip", - "audio": "Audio track" - }, - "type_key": "String (Enumerable, oneOf) `unknown` = unsupported or unrecognized file type `image` = Static image `gifv` = Looping, soundless animation `video` = Video clip `audio` = Audio track", - "type": "String", - "version_history": { - "0.6.0": "added", - "2.9.1": "added `audio`" - } - }, - "url": { - "description": "The location of the original full-size attachment.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.6.0": "added" - } - }, - "preview_url": { - "description": "The location of a scaled-down preview of the attachment.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.6.0": "added" - } - }, - "remote_url": { - "description": "The location of the full-size original attachment on the remote website.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (URL), or null if the attachment is local", - "type": "String (URL), or null if the attachment is local", - "version_history": { - "0.6.0": "added" - } - }, - "meta": { - "description": "Metadata returned by Paperclip.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Hash", - "type": "Hash", - "version_history": { - "1.5.0": "added", - "2.3.0": "added `meta.focus` May contain subtrees `small` and `original`, as well as various other top-level properties. More importantly, there may be another topl-level `focus` Hash object on images as of 2.3.0, with coordinates can be used for smart thumbnail cropping -- see [Focal points for cropped media thumbnails]({{< relref \"api/guidelines#focal-points\" >}}) for more." - } - }, - "description": { - "description": "Alternate text that describes what is in the media attachment, to be used for the visually impaired or when media attachments do not load.", + "uri": { + "description": "URI of the status used for federation.", "nullable": false, "optional": false, "enum": null, "type_key": "String", "type": "String", "version_history": { - "2.0.0": "added" - } - }, - "blurhash": { - "description": "A hash computed by the BlurHash algorithm(https://github.com/woltapp/blurhash), for generating colorful preview thumbnails when media has not been downloaded yet.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (Blurhash)", - "type": "String (Blurhash)", - "version_history": { - "2.8.1": "added" - } - } - }, - "Deprecated": { - "text_url": { - "description": "A shorter URL for the attachment.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "0.6.0": "added", - "3.5.0": "removed" - } - } - }, - "V1Filter": { - "id": { - "description": "The ID of the filter in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.4.3": "added" - } - }, - "phrase": { - "description": "The text to be filtered.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.4.3": "added" - } - }, - "context": { - "description": "The contexts in which the filter should be applied.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of String (Enumerable anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", - "type": "Array of String (Enumerable anyOf) `home` = home timeline and lists `notifications` = notifications timeline `public` = public timelines `thread` = expanded thread of a detailed status `account` = when viewing a profile", - "version_history": { - "2.4.3": "added", - "3.1.0": "added `account`" - } - }, - "expires_at": { - "description": "When the filter should no longer be applied.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime), or null if the filter does not expire", - "type": "String (ISO 8601 Datetime), or null if the filter does not expire", - "version_history": { - "2.4.3": "added" - } - }, - "irreversible": { - "description": "Should matching entities in home and notifications be dropped by the server? See implementation guidelines for filters().", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.3": "added" - } - }, - "whole_word": { - "description": "Should the filter consider word boundaries? See implementation guidelines for filters().", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.3": "added" - } - } - }, - "AdminCanonicalEmailBlock": { - "id": { - "description": "The ID of the email block in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "canonical_email_hash": { - "description": "The SHA256 hash of the canonical email address.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (SHA256)", - "type": "String (SHA256)", - "version_history": { - "4.0.0": "added" - } - } - }, - "AdminIpBlock": { - "id": { - "description": "The ID of the DomainBlock in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "ip": { - "description": "The IP address range that is not allowed to federate.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (IP address and prefix)", - "type": "String (IP address and prefix)", - "version_history": { - "4.0.0": "added" - } - }, - "severity": { - "description": "The associated policy with this IP block.", - "nullable": false, - "optional": false, - "enum": { - "sign_up_requires_approval": "Any signup from this IP range will create a pending account", - "sign_up_block": "Any signup from this IP range will be rejected", - "no_access": "Any activity from this IP range will be rejected entirely" - }, - "type_key": "String (Enumerable, oneOf) `sign_up_requires_approval` = Any signup from this IP range will create a pending account `sign_up_block` = Any signup from this IP range will be rejected `no_access` = Any activity from this IP range will be rejected entirely", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "comment": { - "description": "The recorded reason for this IP block.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" + "0.1.0": "added" } }, "created_at": { - "description": "When the IP block was created.", + "description": "The date when this status was created.", "nullable": false, "optional": false, "enum": null, "type_key": "String (ISO 8601 Datetime)", "type": "String (ISO 8601 Datetime)", "version_history": { - "4.0.0": "added" - } - }, - "expires_at": { - "description": "When the IP block will expire.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "4.0.0": "added" - } - } - }, - "Rule": { - "id": { - "description": "An identifier for the rule.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer, but not guaranteed to be a number)", - "type": "String (cast from integer, but not guaranteed to be a number)", - "version_history": { - "3.4.0": "added" - } - }, - "text": { - "description": "The rule to be followed.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.4.0": "added" - } - } - }, - "AdminAccount": { - "id": { - "description": "The ID of the account in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.9.1": "added" - } - }, - "username": { - "description": "The username of the account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.9.1": "added" - } - }, - "domain": { - "description": "The domain of the account, if it is remote.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String, or null for local accounts", - "type": "String, or null for local accounts", - "version_history": { - "2.9.1": "added" - } - }, - "created_at": { - "description": "When the account was first discovered.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "2.9.1": "added" - } - }, - "email": { - "description": "The email address associated with the account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.9.1": "added" - } - }, - "ip": { - "description": "The IP address last used to login to this account.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String", - "type": "String", - "version_history": { - "2.9.1": "added", - "3.5.0": "return type changed from String to [AdminIp]({{< relref \"entities/Admin_Ip\" >}}) due to a bug", - "4.0.0": "bug fixed, return type is now a String again" - } - }, - "ips": { - "description": "All known IP addresses associated with this account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of AdminIp()", - "type": "Array of AdminIp()", - "version_history": { - "3.5.0": "added" - } - }, - "locale": { - "description": "The locale of the account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 639 Part 1 two-letter language code)", - "type": "String (ISO 639 Part 1 two-letter language code)", - "version_history": { - "2.9.1": "added" - } - }, - "invite_request": { - "description": "The reason given when requesting an invite (for instances that require manual approval of registrations)", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String", - "type": "String", - "version_history": { - "2.9.1": "added" - } - }, - "role": { - "description": "The current role of the account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Role()", - "type": "Role()", - "version_history": { - "2.9.1": "added, returns a String (enumerable, oneOf `user` `moderator` `admin`)", - "4.0.0": "now uses Role entity" - } - }, - "confirmed": { - "description": "Whether the account has confirmed their email address.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.9.1": "added" - } - }, - "approved": { - "description": "Whether the account is currently approved.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.9.1": "added" - } - }, - "disabled": { - "description": "Whether the account is currently disabled.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.9.1": "added" - } - }, - "silenced": { - "description": "Whether the account is currently silenced.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.9.1": "added" - } - }, - "suspended": { - "description": "Whether the account is currently suspended.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.9.1": "added" + "0.1.0": "added" } }, "account": { - "description": "User-level information about the account.", + "description": "The account that authored this status.", "nullable": false, "optional": false, "enum": null, "type_key": "Account()", "type": "Account()", "version_history": { - "2.9.1": "added" + "0.1.0": "added" } }, - "created_by_application_id": { - "description": "The ID of the Application() that created this account, if applicable.", + "content": { + "description": "HTML-encoded status content.", "nullable": false, "optional": false, "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", + "type_key": "String (HTML)", + "type": "String (HTML)", "version_history": { - "2.9.1": "added" + "0.1.0": "added" } }, - "invited_by_account_id": { - "description": "The ID of the Account() that invited this user, if applicable.", + "visibility": { + "description": "Visibility of this status.", "nullable": false, "optional": false, "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", + "type_key": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", + "type": "String (Enumerable oneOf) `public` = Visible to everyone, shown in public timelines. `unlisted` = Visible to public, but not included in public timelines. `private` = Visible to followers only, and to any mentioned users. `direct` = Visible only to mentioned users.", "version_history": { - "2.9.1": "added" - } - } - }, - "WebPushSubscription": { - "id": { - "description": "The ID of the Web Push subscription in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.4.0": "added" + "0.9.9": "added" } }, - "endpoint": { - "description": "Where push alerts will be sent to.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "2.4.0": "added" - } - }, - "server_key": { - "description": "The streaming server's VAPID key.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.4.0": "added" - } - }, - "alerts": { - "description": "Which alerts should be delivered to the `endpoint`.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Hash", - "type": "Hash", - "version_history": { - "2.4.0": "added", - "2.8.0": "added `alerts[poll]`", - "3.1.0": "added `alerts[follow_request]`", - "3.3.0": "added `alerts[status]`", - "3.5.0": "added `alerts[update]` and `alerts[admin.sign_up]`", - "4.0.0": "added `alerts[admin.report]`" - } - } - }, - "WebPushSubscriptionAlerts": { - "mention": { - "description": "Receive a push notification when someone else has mentioned you in a status?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.0": "added" - } - }, - "status": { - "description": "Receive a push notification when a subscribed account posts a status?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.3.0": "added" - } - }, - "reblog": { - "description": "Receive a push notification when a status you created has been boosted by someone else?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.0": "added" - } - }, - "follow": { - "description": "Receive a push notification when someone has followed you?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.0": "added" - } - }, - "follow_request": { - "description": "Receive a push notification when someone has requested to followed you?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.1.0": "added" - } - }, - "favourite": { - "description": "Receive a push notification when a status you created has been favourited by someone else?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.4.0": "added" - } - }, - "poll": { - "description": "Receive a push notification when a poll you voted in or created has ended?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "update": { - "description": "Receive a push notification when a status you interacted with has been edited?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.0": "added" - } - }, - "admin.sign_up": { - "description": "Receive a push notification when a new user has signed up?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.5.0": "added" - } - }, - "admin.report": { - "description": "Receive a push notification when a new report has been filed?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "4.0.0": "added" - } - } - }, - "Conversation": { - "id": { - "description": "The ID of the conversation in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.6.0": "added" - } - }, - "unread": { - "description": "Is the conversation currently marked as unread?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.6.0": "added" - } - }, - "accounts": { - "description": "Participants in the conversation.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Account()", - "type": "Array of Account()", - "version_history": { - "2.6.0": "added" - } - }, - "last_status": { - "description": "The last status in the conversation.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Status()", - "type": "Status()", - "version_history": { - "2.6.0": "added" - } - } - }, - "AdminMeasure": { - "key": { - "description": "The unique keystring for the requested measure.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "unit": { - "description": "The units associated with this data item's value, if applicable.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String or null", - "type": "String or null", - "version_history": { - "3.5.0": "added" - } - }, - "total": { - "description": "The numeric total associated with the requested measure.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer)", - "type": "String (cast from integer)", - "version_history": { - "3.5.0": "added" - } - }, - "human_value": { - "description": "A human-readable formatted value for this data item.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "previous_total": { - "description": "The numeric total associated with the requested measure, in the previous period. Previous period is calculated by subtracting the start_at and end_at dates, then offsetting both start and end dates backwards by the length of the time period.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer)", - "type": "String (cast from integer)", - "version_history": { - "3.5.0": "added" - } - }, - "data": { - "description": "The data available for the requested measure, split into daily buckets.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Hash", - "type": "Array of Hash", - "version_history": { - "3.5.0": "added" - } - } - }, - "AdminMeasureData": { - "date": { - "description": "Midnight on the requested day in the time period.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (ISO 8601 Datetime)", - "type": "String (ISO 8601 Datetime)", - "version_history": { - "3.5.0": "added" - } - }, - "value": { - "description": "The numeric value for the requested measure.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from integer)", - "type": "String (cast from integer)", - "version_history": { - "3.5.0": "added" - } - } - }, - "Role": { - "id": { - "description": "The ID of the Role in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "4.0.0": "added" - } - }, - "name": { - "description": "The name of the role.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "color": { - "description": "The hex code assigned to this role. If no hex code is assigned, the string will be empty.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "permissions": { - "description": "A bitmask that represents the sum of all permissions granted to the role.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "4.0.0": "added" - } - }, - "highlighted": { - "description": "Whether the role is publicly visible as a badge on user profiles.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "4.0.0": "added" - } - } - }, - "Relationship": { - "id": { - "description": "The account ID.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "0.6.0": "added" - } - }, - "following": { - "description": "Are you following this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.6.0": "added" - } - }, - "showing_reblogs": { - "description": "Are you receiving this user's boosts in your home timeline?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.1.0": "added" - } - }, - "notifying": { - "description": "Have you enabled notifications for this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "3.3.0": "added" - } - }, - "languages": { - "description": "Which languages are you following from this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of String (ISO 639-1 language two-letter code)", - "type": "Array of String (ISO 639-1 language two-letter code)", - "version_history": { - "4.0.0": "added" - } - }, - "followed_by": { - "description": "Are you followed by this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.6.0": "added" - } - }, - "blocking": { - "description": "Are you blocking this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "0.6.0": "added" - } - }, - "blocked_by": { - "description": "Is this user blocking you?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "muting": { - "description": "Are you muting this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "1.1.0": "added" - } - }, - "muting_notifications": { - "description": "Are you muting notifications from this user?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.1.0": "added" - } - }, - "requested": { - "description": "Do you have a pending follow request for this user?", + "sensitive": { + "description": "Is this status marked as sensitive content?", "nullable": false, "optional": false, "enum": null, @@ -4898,67 +4881,44 @@ "0.9.9": "added" } }, - "domain_blocking": { - "description": "Are you blocking this user's domain?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "1.4.0": "added" - } - }, - "endorsed": { - "description": "Are you featuring this user on your profile?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.5.0": "added" - } - }, - "note": { - "description": "This user's profile bio", + "spoiler_text": { + "description": "Subject or summary line, below which status content is collapsed until expanded.", "nullable": false, "optional": false, "enum": null, "type_key": "String", "type": "String", "version_history": { - "3.2.0": "added" - } - } - }, - "Suggestion": { - "source": { - "description": "The reason this account is being suggested.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (Enumerable oneOf) `staff` = This account was manually recommended by your administration team `past_interactions` = You have interacted with this account previously `global` = This account has many reblogs, favourites, and active local followers within the last 30 days", - "type": "String (Enumerable oneOf) `staff` = This account was manually recommended by your administration team `past_interactions` = You have interacted with this account previously `global` = This account has many reblogs, favourites, and active local followers within the last 30 days", - "version_history": { - "3.4.0": "added" + "1.0.0": "added" } }, - "account": { - "description": "The account being recommended to follow.", + "media_attachments": { + "description": "Media that is attached to this status.", "nullable": false, "optional": false, "enum": null, - "type_key": "Account()", - "type": "Account()", + "type_key": "Array of MediaAttachment()", + "type": "Array of MediaAttachment()", "version_history": { - "3.4.0": "added" + "0.6.0": "added" + } + }, + "application": { + "description": "The application used to post this status.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Hash", + "type": "Hash", + "version_history": { + "0.9.9": "added" } } }, - "Application": { + "StatusApplication": { + "doc_link": "https://docs.joinmastodon.org/entities/Status.md", "name": { - "description": "The name of your application.", + "description": "The name of the application that posted this status.", "nullable": false, "optional": false, "enum": null, @@ -4969,335 +4929,448 @@ } }, "website": { - "description": "The website associated with your application.", + "description": "The website associated with the application that posted this status.", "nullable": true, "optional": false, "enum": null, - "type_key": " String (URL)", - "type": "String (URL)", + "type_key": " String (URL) or null", + "type": "String (URL) or null", "version_history": { "0.9.9": "added", "3.5.1": "this property is now nullable" } }, - "vapid_key": { - "description": "Used for Push Streaming API. Returned with POST /api/v1/apps(). Equivalent to WebPushSubscription#server_key()", + "mentions": { + "description": "Mentions of users within the status content.", "nullable": false, "optional": false, "enum": null, - "type_key": "String", - "type": "String", + "type_key": "Array of StatusMention(#Mention)", + "type": "Array of StatusMention(#Mention)", "version_history": { - "2.8.0": "added" + "0.6.0": "added" } }, - "client_id": { - "description": "Client ID key, to be used for obtaining OAuth tokens", + "tags": { + "description": "Hashtags used within the status content.", "nullable": false, "optional": false, "enum": null, - "type_key": "String", - "type": "String", + "type_key": "Array of StatusTag(#Tag)", + "type": "Array of StatusTag(#Tag)", "version_history": { - "0.9.9": "added" - } - }, - "client_secret": { - "description": "Client secret key, to be used for obtaining OAuth tokens", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "0.9.9": "added" - } - } - }, - "FilterKeyword": { - "id": { - "description": "The ID of the FilterKeyword in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "4.0.0": "added" - } - }, - "keyword": { - "description": "The phrase to be matched against.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "4.0.0": "added" - } - }, - "whole_word": { - "description": "Should the filter consider word boundaries? See implementation guidelines for filters().", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "4.0.0": "added" - } - } - }, - "StatusSource": { - "id": { - "description": "ID of the status in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer but not guaranteed to be a number)", - "type": "String (cast from an integer but not guaranteed to be a number)", - "version_history": { - "3.5.0": "added" - } - }, - "text": { - "description": "The plain text used to compose the status.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - }, - "spoiler_text": { - "description": "The plain text used to compose the status's subject or content warning.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.5.0": "added" - } - } - }, - "FamiliarFollowers": { - "id": { - "description": "The ID of the Account in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "3.5.0": "added" - } - }, - "accounts": { - "description": "Accounts you follow that also follow this account.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of Account()", - "type": "Array of Account()", - "version_history": { - "3.5.0": "added" - } - } - }, - "CustomEmoji": { - "shortcode": { - "description": "The name of the custom emoji.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "2.0.0": "added" - } - }, - "url": { - "description": "A link to the custom emoji.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "2.0.0": "added" - } - }, - "static_url": { - "description": "A link to a static copy of the custom emoji.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (URL)", - "type": "String (URL)", - "version_history": { - "2.0.0": "added" - } - }, - "visible_in_picker": { - "description": "Whether this Emoji should be visible in the picker or unlisted.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.0.0": "added" - } - }, - "category": { - "description": "Used for sorting custom emoji in the picker.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String", - "type": "String", - "version_history": { - "3.0.0": "added" - } - } - }, - "Poll": { - "id": { - "description": "The ID of the poll in the database.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "String (cast from an integer, but not guaranteed to be a number)", - "type": "String (cast from an integer, but not guaranteed to be a number)", - "version_history": { - "2.8.0": "added" - } - }, - "expires_at": { - "description": "When the poll ends.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " String (ISO 8601 Datetime), or null if the poll does not end", - "type": "String (ISO 8601 Datetime), or null if the poll does not end", - "version_history": { - "2.8.0": "added" - } - }, - "expired": { - "description": "Is the poll currently expired?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "multiple": { - "description": "Does the poll allow multiple-choice answers?", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Boolean", - "type": "Boolean", - "version_history": { - "2.8.0": "added" - } - }, - "votes_count": { - "description": "How many votes have been received.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Integer", - "type": "Integer", - "version_history": { - "2.8.0": "added" - } - }, - "voters_count": { - "description": "How many unique accounts have voted on a multiple-choice poll.", - "nullable": true, - "optional": false, - "enum": null, - "type_key": " Integer, or null if `multiple` is false.", - "type": "Integer, or null if `multiple` is false.", - "version_history": { - "2.8.0": "added" - } - }, - "options": { - "description": "Possible answers for the poll.", - "nullable": false, - "optional": false, - "enum": null, - "type_key": "Array of PollOption(#Option)", - "type": "Array of PollOption(#Option)", - "version_history": { - "2.8.0": "added" + "0.6.0": "added" } }, "emojis": { - "description": "Custom emoji to be used for rendering poll options.", + "description": "Custom emoji to be used when rendering status content.", "nullable": false, "optional": false, "enum": null, "type_key": "Array of CustomEmoji()", "type": "Array of CustomEmoji()", + "version_history": { + "2.0.0": "added" + } + }, + "reblogs_count": { + "description": "How many boosts this status has received.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "0.1.0": "added" + } + }, + "favourites_count": { + "description": "How many favourites this status has received.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "0.1.0": "added" + } + }, + "replies_count": { + "description": "How many replies this status has received.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Integer", + "type": "Integer", + "version_history": { + "2.5.0": "added" + } + }, + "url": { + "description": "A link to the status's HTML representation.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (URL) or null", + "type": "String (URL) or null", + "version_history": { + "0.1.0": "added" + } + }, + "in_reply_to_id": { + "description": "ID of the status being replied to.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (cast from an integer but not guaranteed to be a number) or null", + "type": "String (cast from an integer but not guaranteed to be a number) or null", + "version_history": { + "0.1.0": "added" + } + }, + "in_reply_to_account_id": { + "description": "ID of the account that authored the status being replied to.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (cast from an integer but not guaranteed to be a number) or null", + "type": "String (cast from an integer but not guaranteed to be a number) or null", + "version_history": { + "0.1.0": "added" + } + }, + "reblog": { + "description": "The status being reblogged.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Status(#) or null", + "type": "Status(#) or null", + "version_history": { + "0.1.0": "added" + } + }, + "poll": { + "description": "The poll attached to the status.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " Poll() or null", + "type": "Poll() or null", "version_history": { "2.8.0": "added" } }, - "voted": { - "description": "When called with a user token, has the authorized user voted?", + "card": { + "description": "Preview card for links included within status content.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " PreviewCard() or null", + "type": "PreviewCard() or null", + "version_history": { + "2.6.0": "added" + } + }, + "language": { + "description": "Primary language of this status.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 639 Part 1 two-letter language code) or null", + "type": "String (ISO 639 Part 1 two-letter language code) or null", + "version_history": { + "1.4.0": "added" + } + }, + "text": { + "description": "Plain-text source of a status. Returned instead of `content` when status is deleted, so the user may redraft from the source text without the client having to reverse-engineer the original text from the HTML content.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String or null", + "type": "String or null", + "version_history": { + "2.9.0": "added" + } + }, + "edited_at": { + "description": "Timestamp of when the status was last edited.", + "nullable": true, + "optional": false, + "enum": null, + "type_key": " String (ISO 8601 Datetime)", + "type": "String (ISO 8601 Datetime)", + "version_history": { + "3.5.0": "added" + } + }, + "favourited": { + "description": "If the current token has an authorized user: Have you favourited this status?", "nullable": false, "optional": false, "enum": null, "type_key": "Boolean", "type": "Boolean", "version_history": { - "2.8.0": "added" + "0.1.0": "added" } }, - "own_votes": { - "description": "When called with a user token, which options has the authorized user chosen? Contains an array of index values for `options`.", + "reblogged": { + "description": "If the current token has an authorized user: Have you boosted this status?", "nullable": false, "optional": false, "enum": null, - "type_key": "Array of Integer", - "type": "Array of Integer", + "type_key": "Boolean", + "type": "Boolean", "version_history": { - "2.8.0": "added" + "0.1.0": "added" + } + }, + "muted": { + "description": "If the current token has an authorized user: Have you muted notifications for this status's conversation?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "1.4.0": "added" + } + }, + "bookmarked": { + "description": "If the current token has an authorized user: Have you bookmarked this status?", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.1.0": "added" + } + }, + "pinned": { + "description": "If the current token has an authorized user: Have you pinned this status? Only appears if the status is pinnable.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "1.6.0": "added" + } + }, + "filtered": { + "description": "If the current token has an authorized user: The filter and keywords that matched this status.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of FilterResult()", + "type": "Array of FilterResult()", + "version_history": { + "4.0.0": "added" } } }, - "PollOption": { - "title": { - "description": "The text value of the poll option.", + "StatusMention": { + "doc_link": "https://docs.joinmastodon.org/entities/Status.md", + "id": { + "description": "The account ID of the mentioned user.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer, but not guaranteed to be a number)", + "type": "String (cast from an integer, but not guaranteed to be a number)", + "version_history": { + "0.6.0": "added" + } + }, + "username": { + "description": "The username of the mentioned user.", "nullable": false, "optional": false, "enum": null, "type_key": "String", "type": "String", "version_history": { - "2.8.0": "added" + "0.6.0": "added" } }, - "votes_count": { - "description": "The total number of received votes for this option.", - "nullable": true, + "url": { + "description": "The location of the mentioned user's profile.", + "nullable": false, "optional": false, "enum": null, - "type_key": " Integer, or null if results are not published yet.", - "type": "Integer, or null if results are not published yet.", + "type_key": "String (URL)", + "type": "String (URL)", "version_history": { - "2.8.0": "added" + "0.6.0": "added" + } + }, + "acct": { + "description": "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.6.0": "added" + } + } + }, + "StatusTag": { + "doc_link": "https://docs.joinmastodon.org/entities/Status.md", + "name": { + "description": "The value of the hashtag after the # sign.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.9.0": "added" + } + }, + "url": { + "description": "A link to the hashtag on the instance.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.9.0": "added" + } + } + }, + "Tag": { + "doc_link": "https://docs.joinmastodon.org/entities/Tag.md", + "name": { + "description": "The value of the hashtag after the # sign.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String", + "type": "String", + "version_history": { + "0.9.0": "added" + } + }, + "url": { + "description": "A link to the hashtag on the instance.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (URL)", + "type": "String (URL)", + "version_history": { + "0.9.0": "added" + } + }, + "history": { + "description": "Usage statistics for given days (typically the past week).", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Array of Hash", + "type": "Array of Hash", + "version_history": { + "2.4.1": "added" + } + } + }, + "TagHistory": { + "doc_link": "https://docs.joinmastodon.org/entities/Tag.md", + "day": { + "description": "UNIX timestamp on midnight of the given day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (UNIX timestamp)", + "type": "String (UNIX timestamp)", + "version_history": { + "2.4.1": "added" + } + }, + "uses": { + "description": "The counted usage of the tag within that day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer)", + "type": "String (cast from an integer)", + "version_history": { + "2.4.1": "added" + } + }, + "accounts": { + "description": "The total of accounts using the tag within that day.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from an integer)", + "type": "String (cast from an integer)", + "version_history": { + "2.4.1": "added" + } + }, + "following": { + "description": "Whether the current token's authorized user is following this tag.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "4.0.0": "added" + } + } + }, + "AdminTag": { + "doc_link": "https://docs.joinmastodon.org/entities/Tag.md", + "id": { + "description": "The ID of the Tag in the database.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "String (cast from integer, but not guaranteed to be a number)", + "type": "String (cast from integer, but not guaranteed to be a number)", + "version_history": { + "3.5.0": "added" + } + }, + "trendable": { + "description": "Whether the hashtag has been approved to trend.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.0": "added" + } + }, + "usable": { + "description": "Whether the hashtag has not been disabled from auto-linking.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.0": "added" + } + }, + "requires_review": { + "description": "Whether the hashtag has not been reviewed yet to approve or deny its trending.", + "nullable": false, + "optional": false, + "enum": null, + "type_key": "Boolean", + "type": "Boolean", + "version_history": { + "3.5.0": "added" } } } diff --git a/srcgen/return_types_merged.json b/srcgen/return_types_merged.json new file mode 100644 index 0000000..5818265 --- /dev/null +++ b/srcgen/return_types_merged.json @@ -0,0 +1,5149 @@ +[ + { + "name": "User / account", + "python_name": "Account", + "func_call": "mastodon.account()", + "func_call_real": "mastodon.account(23972)", + "func_call_additional": "mastodon.account_verify_credentials()", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Account/", + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "Same as ", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "username": { + "description": "The username (what you @ them with)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "acct": { + "description": "The user's account name as username@domain (@domain omitted for local users)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "display_name": { + "description": "The user's display name", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "discoverable": { + "description": "Indicates whether or not a user is visible on the discovery page", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "group": { + "description": "A boolean indicating whether the account represents a group rather than an individual.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "locked": { + "description": "Denotes whether the account can be followed without a follow request", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "created_at": { + "description": "Account creation time", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added", + "3.4.0": "now resolves to midnight instead of an exact time" + }, + "enum": null + }, + "following_count": { + "description": "How many people they follow", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "followers_count": { + "description": "How many followers they have", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "statuses_count": { + "description": "How many statuses they have", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "note": { + "description": "Their bio", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "url": { + "description": "Their URL; for example 'https://mastodon.social/users/'", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "avatar": { + "description": "URL for their avatar, can be animated", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "header": { + "description": "URL for their header image, can be animated", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "avatar_static": { + "description": "URL for their avatar, never animated", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "1.1.2": "added" + }, + "enum": null + }, + "header_static": { + "description": "URL for their header image, never animated", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "1.1.2": "added" + }, + "enum": null + }, + "moved_to_account": { + "description": "If set, a account dict of the account this user has set up as their moved-to address.", + "field_type": "Account", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "2.1.0": "added" + } + }, + "suspended": { + "description": "Boolean indicating whether the user has been suspended.", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "3.3.0": "added" + }, + "enum": null + }, + "limited": { + "description": "Boolean indicating whether the user has been silenced.", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "3.5.3": "added" + }, + "enum": null + }, + "bot": { + "description": "Boolean indicating whether this account is automated.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "fields": { + "description": "List of up to four account field dicts", + "field_type": "list", + "field_subtype": "AccountField", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "emojis": { + "description": "List of custom emoji used in name, bio or fields", + "field_type": "list", + "field_subtype": "CustomEmoji", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "last_status_at": { + "description": "When the most recent status was posted.", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.0.0": "added", + "3.1.0": "now returns date only, no time" + }, + "enum": null + }, + "noindex": { + "description": "Whether the local user has opted out of being indexed by search engines.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "roles": { + "description": "Deprecated. Was a list of strings with the users roles. Now just an empty list. Mastodon.py makes no attempt to fill it, and the field may be removed if Mastodon removes it. use role field instead.", + "is_deprecated": true, + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "role": { + "description": "The users role. Only present for account returned from account_verify_credentials()", + "field_type": "Role", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + }, + "source": { + "description": "Additional information about the account, useful for profile editing. Only present for account returned from account_verify_credentials()", + "field_type": "AccountSource", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + }, + "mute_expires_at": { + "description": "If the user is muted by the logged in user with a timed mute, when the mute expires.", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.3.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Account field", + "python_name": "Field", + "func_call": "mastodon.account().fields[0]", + "func_call_real": "mastodon.account(23972).fields[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Account/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "name": { + "description": "The key of a given field's key-value pair.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "value": { + "description": "The value associated with the `name` key.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "verified_at": { + "description": "Timestamp of when the server verified a URL value for a rel=\"me\" link.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.6.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Account role", + "python_name": "Role", + "func_call": "mastodon.account_verify_credentials().role", + "func_call_real": "mastodon.account_verify_credentials().role", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Role/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "The ID of the Role in the database.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "name": { + "description": "The name of the role.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "permissions": { + "description": "A bitmask that represents the sum of all permissions granted to the role.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "color": { + "description": "The hex code assigned to this role. If no hex code is assigned, the string will be empty.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "highlighted": { + "description": "Whether the role is publicly visible as a badge on user profiles.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + } + } + }, + { + "name": "User / account source", + "python_name": "CredentialAccountSource", + "func_call": "mastodon.account_verify_credentials()[\"source\"]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Account/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "privacy": { + "description": "The user's default visibility setting (\"private\", \"unlisted\" or \"public\")", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.5.0": "added" + }, + "enum": { + "public": "Public post", + "unlisted": "Unlisted post", + "private": "Followers-only post", + "direct": "Direct post" + } + }, + "sensitive": { + "description": "Denotes whether user media should be marked sensitive by default", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.5.0": "added" + }, + "enum": null + }, + "note": { + "description": "Plain text version of the user's bio", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.5.0": "added" + }, + "enum": null + }, + "language": { + "description": "The default posting language for new statuses.", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.2": "added" + }, + "enum": null + }, + "fields": { + "description": "Metadata about the account.", + "field_type": "list", + "field_subtype": "AccountField", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "follow_requests_count": { + "description": "The number of pending follow requests.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Toot / Status", + "python_name": "Status", + "func_call": "mastodon.toot(\"Hello from Python\")", + "func_call_real": "mastodon.status(110446223051565765)", + "func_call_additional": "mastodon.status(110446183735368325)", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Status/", + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "Numerical id of this toot", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "uri": { + "description": "Descriptor for the toot EG 'tag:mastodon.social,2016-11-25:objectId=:objectType=Status'", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "url": { + "description": "URL of the toot", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "URL", + "is_optional": false, + "is_nullable": true, + "version_history": { + "0.1.0": "added" + } + }, + "account": { + "description": "Account dict for the account which posted the status", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "in_reply_to_id": { + "description": "Numerical id of the toot this toot is in response to", + "field_type": "IdType", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "0.1.0": "added" + } + }, + "in_reply_to_account_id": { + "description": "Numerical id of the account this toot is in response to", + "field_type": "IdType", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "0.1.0": "added" + } + }, + "reblog": { + "description": "Denotes whether the toot is a reblog. If so, set to the original toot dict.", + "field_type": "Status", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "0.1.0": "added" + } + }, + "content": { + "description": "Content of the toot, as HTML: '

Hello from Python

'", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "created_at": { + "description": "Creation time", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + }, + "enum": null + }, + "reblogs_count": { + "description": "Number of reblogs", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + } + }, + "favourites_count": { + "description": "Number of favourites", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + } + }, + "reblogged": { + "description": "Denotes whether the logged in user has boosted this toot", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + } + }, + "favourited": { + "description": "Denotes whether the logged in user has favourited this toot", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "0.1.0": "added" + } + }, + "sensitive": { + "description": "Denotes whether media attachments to the toot are marked sensitive", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "spoiler_text": { + "description": "Warning text that should be displayed before the toot content", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.0.0": "added" + }, + "enum": null + }, + "visibility": { + "description": "Toot visibility", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "VisibilityEnum", + "version_history": { + "0.9.9": "added" + }, + "enum": { + "public": "Publicly visible and discoverable in public timelines", + "unlisted": "Publicly visible, but not shown on public timelines and other discovery tools", + "private": "Visible only to followers", + "direct": "Visible only to people mentioned in the status" + } + }, + "mentions": { + "description": "A list of account dicts mentioned in the toot, as Mention dicts", + "field_type": "list", + "field_subtype": "Account", + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "media_attachments": { + "description": "A list of media dicts of attached files", + "field_type": "list", + "field_subtype": "MediaAttachment", + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "emojis": { + "description": "A list of custom emojis used in the toot, as Emoji dicts", + "field_type": "list", + "field_subtype": "CustomEmoji", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.0.0": "added" + } + }, + "tags": { + "description": "A list of hashtag used in the toot, as Hashtag dicts", + "field_type": "list", + "field_subtype": "Tag", + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "bookmarked": { + "description": "True if the status is bookmarked by the logged in user, False if not.", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + } + }, + "application": { + "description": "Application dict for the client used to post the toot (Does not federate and is therefore always None for remote toots, can also be None for local toots for some legacy applications).", + "field_type": "Application", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "language": { + "description": "The language of the toot, if specified by the server, as ISO 639-1 (two-letter) language code.", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": false, + "is_nullable": true, + "version_history": { + "1.4.0": "added" + } + }, + "muted": { + "description": "Boolean denoting whether the user has muted this status by way of conversation muting", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "1.4.0": "added" + } + }, + "pinned": { + "description": "Boolean denoting whether or not the status is currently pinned for the associated account.", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "1.6.0": "added" + } + }, + "replies_count": { + "description": "The number of replies to this status.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.5.0": "added" + } + }, + "card": { + "description": "A preview card for links from the status, if present at time of delivery, as card dict.", + "field_type": "PreviewCard", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.6.0": "added" + } + }, + "poll": { + "description": "A poll dict if a poll is attached to this status.", + "field_type": "Poll", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.8.0": "added" + } + }, + "edited_at": { + "description": "Time the status was last edited", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.5.0": "added" + } + + }, + "filtered": { + "description": "If present, a list of filter application results that indicate which of the users filters matched and what actions should be taken.", + "field_type": "list", + "field_subtype": "FilterResult", + "is_optional": true, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + } + } + }, + { + "name": "Status edit", + "python_name": "StatusEdit", + "func_call": "mastodon.status_history()[0]", + "func_call_real": "mastodon.status_history(110446223051565765)[-1]", + "func_call_additional": "mastodon.status_history(110446183735368325)[-1]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/StatusEdit/", + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "content": { + "description": "Content for this version of the status", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "spoiler_text": { + "description": "CW / Spoiler text for this version of the status", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "sensitive": { + "description": "Whether media in this version of the status is marked as sensitive", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "created_at": { + "description": "Time at which this version of the status was posted", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "account": { + "description": "Account dict of the user that posted the status", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "media_attachments": { + "description": "List of media dicts with the attached media for this version of the status", + "field_type": "list", + "field_subtype": "MediaAttachment", + "is_optional": false, + "is_nullable": false + }, + "emojis": { + "description": "List of custom emoji used in this version of the status.", + "field_type": "list", + "field_subtype": "CustomEmoji", + "is_optional": false, + "is_nullable": false + }, + "poll": { + "description": "The current state of the poll options at this revision. Note that edits changing the poll options will be collapsed together into one edit, since this action resets the poll.", + "field_type": "Poll", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Status filter action", + "python_name": "FilterResult", + "func_call": "mastodon.status().filtered[0]", + "func_call_real": "mastodon.status(110447998920481458).filtered[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/FilterResult/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "filter": { + "description": "The filter that was matched.", + "field_type": "V1Filter", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "keyword_matches": { + "description": "The keyword within the filter that was matched.", + "field_type": "list", + "field_subtype": "str", + "is_optional": false, + "is_nullable": true, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "status_matches": { + "description": "The status ID within the filter that was matched.", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "4.0.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Mention", + "python_name": "StatusMention", + "func_call": "mastodon.toot(\"@admin he doing it sideways\").mentions[0]", + "func_call_real": "mastodon.status(110446223051565765).mentions[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Mention/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "url": { + "description": "Mentioned user's profile URL (potentially remote)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "username": { + "description": "Mentioned user's user name (not including domain)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "acct": { + "description": "Mentioned user's account name (including domain)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "id": { + "description": "Mentioned user's (local) account ID", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Scheduled status / toot", + "python_name": "ScheduledStatus", + "func_call": "mastodon.status_post(\"futureposting\", scheduled_at=the_future)", + "func_call_real": "mastodon.status_post(\"posting in the far future\", scheduled_at=datetime(9999,12,12))", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "Scheduled toot ID (note: Not the id of the toot once it gets posted!)", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "scheduled_at": { + "description": "datetime object describing when the toot is to be posted", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "params": { + "description": "Parameters for the scheduled toot, specifically", + "field_type": "ScheduledStatusParams", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "media_attachments": { + "description": "Array of media dicts for the attachments to the scheduled toot", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + } + } + }, + { + "name": "Scheduled status / toot params", + "python_name": "ScheduledStatusParams", + "func_call": "mastodon.status_post(\"futureposting... 2\", scheduled_at=the_future).params", + "func_call_real": "mastodon.status_post(\"posting in the far future\", scheduled_at=datetime(9999,12,12)).params", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "text": { + "description": "Toot text", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "in_reply_to_id": { + "description": "ID of the toot this one is a reply to", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "media_ids": { + "description": "IDs of media attached to this toot", + "field_type": "list", + "field_subtype": "str", + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "sensitive": { + "description": "Whether this toot is sensitive or not", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "visibility": { + "description": "Visibility of the toot", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "idempotency": { + "description": "Idempotency key for the scheduled toot", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "scheduled_at": { + "description": "Present, but generally \"None\". Unsure what this is for - the actual scheduled_at is in the ScheduledStatus object, not here. If you know, let me know.", + "help_wanted": true, + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "spoiler_text": { + "description": "CW text for this toot", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "application_id": { + "description": "ID of the application that scheduled the toot", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "poll": { + "description": "Poll parameters, as a poll dict", + "field_type": "Poll", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "language": { + "description": "The language that will be used for the status.", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + }, + "enum": null + }, + "allowed_mentions": { + "description": "Undocumented. If you know what this does, please let me know.", + "help_wanted": true, + "field_type": "list", + "field_subtype": "str", + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.7.0": "added" + } + }, + "with_rate_limit": { + "description": "Whether the status should be rate limited. It is unclear to me what this does. If you know, please let met know", + "help_wanted": true, + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.7.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Poll", + "python_name": "Poll", + "func_call": "mastodon.poll()", + "func_call_real": "mastodon.status(110446383900387196).poll", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "The polls ID", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "expires_at": { + "description": "The time at which the poll is set to expire", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "expired": { + "description": "Boolean denoting whether you can still vote in this poll", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "multiple": { + "description": "Boolean indicating whether it is allowed to vote for more than one option", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "votes_count": { + "description": "Total number of votes cast in this poll", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "voted": { + "description": "Boolean indicating whether the logged-in user has already voted in this poll", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "options": { + "description": "The poll options as a list of poll option dicts", + "field_type": "list", + "field_subtype": "PollOption", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "emojis": { + "description": "List of emoji dicts for all emoji used in answer strings,", + "field_type": "list", + "field_subtype": "CustomEmoji", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "own_votes": { + "description": "The logged-in users votes, as a list of indices to the options.", + "field_type": "list", + "field_subtype": "int", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "voters_count": { + "description": "How many unique accounts have voted on a multiple-choice poll.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.8.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Poll option", + "python_name": "PollOption", + "func_call": "mastodon.poll().options[0]", + "func_call_real": "mastodon.status(110446383900387196).poll.options[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "title": { + "description": "Text of the option", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "votes_count": { + "description": "Count of votes for the option. Can be None if the poll creator has chosen to hide vote totals until the poll expires and it hasn't yet.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.8.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Conversation", + "python_name": "Conversation", + "func_call": "mastodon.conversations()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Conversation/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "The ID of this conversation object", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.6.0": "added" + }, + "enum": null + }, + "unread": { + "description": "Boolean indicating whether this conversation has yet to be read by the user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.6.0": "added" + }, + "enum": null + }, + "accounts": { + "description": "List of accounts (other than the logged-in account) that are part of this conversation", + "field_type": "list", + "field_subtype": "Account", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.6.0": "added" + }, + "enum": null + }, + "last_status": { + "description": "The newest status in this conversation", + "field_type": "Status", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.6.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Hashtag", + "python_name": "Tag", + "func_call": "mastodon.trending_tags()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Tag/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "name": { + "description": "Hashtag name (not including the #)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.0": "added" + }, + "enum": null + }, + "url": { + "description": "Hashtag URL (can be remote)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.9.0": "added" + }, + "enum": null + }, + "history": { + "description": "List of usage history dicts for up to 7 days. Not present in statuses.", + "field_type": "list", + "field_subtype": "HashtagUsage", + "is_optional": true, + "is_nullable": false, + "version_history": { + "2.4.1": "added" + }, + "enum": null + }, + "following": { + "description": "Boolean indicating whether the logged-in user is following this tag.", + "field_type": "bool", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + } + } + }, + { + "name": "Hashtag usage history", + "python_name": "TagHistory", + "func_call": "mastodon.trending_tags()[0].history[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Tag/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "day": { + "description": "Date of the day this history dict is for", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "datetime", + "version_history": { + "2.4.1": "added" + }, + "enum": null + }, + "uses": { + "description": "Number of statuses using this hashtag on that day", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.1": "added" + }, + "enum": null + }, + "accounts": { + "description": "Number of accounts using this hashtag in at least one status on that day", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.1": "added" + }, + "enum": null + } + } + }, + { + "name": "Emoji", + "python_name": "CustomEmoji", + "func_call": "mastodon.toot(\":sidekiqin:\").emojis[0]", + "func_call_real": "mastodon.status(110446223051565765).emojis[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/CustomEmoji/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "shortcode": { + "description": "Emoji shortcode, without surrounding colons", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.0.0": "added" + }, + "enum": null + }, + "url": { + "description": "URL for the emoji image, can be animated", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "2.0.0": "added" + }, + "enum": null + }, + "static_url": { + "description": "URL for the emoji image, never animated", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "2.0.0": "added" + }, + "enum": null + }, + "visible_in_picker": { + "description": "True if the emoji is enabled, False if not.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.0.0": "added" + }, + "enum": null + }, + "category": { + "description": "The category to display the emoji under (not present if none is set)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Application", + "python_name": "Application", + "func_call": "mastodon.app_verify_credentials()", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Application/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "name": { + "description": "The applications name", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "website": { + "description": "The applications website", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "0.9.9": "added", + "3.5.1": "this property is now nullable" + }, + "enum": null + }, + "vapid_key": { + "description": "A vapid key that can be used in web applications", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Relationship", + "python_name": "Relationship", + "func_call": "mastodon.account_relationships()[0]", + "func_call_real": "mastodon.account_relationships(23972)[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Relationship/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "Numerical id (same one as )", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "following": { + "description": "Boolean denoting whether the logged-in user follows the specified user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "followed_by": { + "description": "Boolean denoting whether the specified user follows the logged-in user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "blocking": { + "description": "Boolean denoting whether the logged-in user has blocked the specified user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "blocked_by": { + "description": "Boolean denoting whether the logged-in user has been blocked by the specified user, if information is available", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "muting": { + "description": "Boolean denoting whether the logged-in user has muted the specified user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + }, + "muting_notifications": { + "description": "Boolean denoting wheter the logged-in user has muted notifications related to the specified user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.0": "added" + }, + "enum": null + }, + "requested": { + "description": "Boolean denoting whether the logged-in user has sent the specified user a follow request", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "domain_blocking": { + "description": "Boolean denoting whether the logged-in user has blocked the specified users domain", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.4.0": "added" + }, + "enum": null + }, + "showing_reblogs": { + "description": "Boolean denoting whether the specified users reblogs show up on the logged-in users Timeline", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.0": "added" + }, + "enum": null + }, + "endorsed": { + "description": "Boolean denoting wheter the specified user is being endorsed / featured by the logged-in user", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.5.0": "added" + }, + "enum": null + }, + "note": { + "description": "A free text note the logged in user has created for this account (not publicly visible)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.2.0": "added" + }, + "enum": null + }, + "notifying": { + "description": "Have you enabled notifications for this user?", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.3.0": "added" + }, + "enum": null + }, + "languages": { + "description": "Which languages are you following from this user?", + "field_type": "list", + "field_subtype": "str", + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "requested_by": { + "description": "Boolean indicating whether the specified user has sent the logged-in user a follow request", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + } + } + } + }, + { + "name": "Filter", + "python_name": "V1Filter", + "func_call": "mastodon.filters()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Filter/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "Numerical id of the filter", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.3": "added" + }, + "enum": null + }, + "phrase": { + "description": "Filtered keyword or phrase", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.3": "added" + }, + "enum": null + }, + "context": { + "description": "List of places where the filters are applied. Items can be: ('home', 'notifications', 'public', 'thread')", + "field_type": "list", + "field_subtype": "str", + "is_optional": false, + "is_nullable": false, + "field_structuretype": "TimelineEnum", + "version_history": { + "2.4.3": "added", + "3.1.0": "added `account`" + }, + "enum": null + }, + "expires_at": { + "description": "Expiry date for the filter", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.4.3": "added" + }, + "enum": null + }, + "irreversible": { + "description": "Boolean denoting if this filter is executed server-side or if it should be ran client-side.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.3": "added" + }, + "enum": null + }, + "whole_word": { + "description": "Boolean denoting whether this filter can match partial words", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.3": "added" + }, + "enum": null + } + } + }, + { + "name": "Notification", + "python_name": "Notification", + "func_call": "mastodon.notifications()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Notification/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "id of the notification", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "type": { + "description": "\"mention\", \"reblog\", \"favourite\", \"follow\", \"poll\" or \"follow_request\"", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "NotificationTypeEnum", + "version_history": { + "0.9.9": "added", + "2.8.0": "added `poll`", + "3.1.0": "added `follow_request`", + "3.3.0": "added `status`", + "3.5.0": "added `update` and `admin.sign_up`", + "4.0.0": "added `admin.report`" + }, + "enum": null + }, + "created_at": { + "description": "The time the notification was created", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "account": { + "description": "Account dict of the user from whom the notification originates", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + }, + "status": { + "description": "In case of \"mention\", the mentioning status In case of reblog / favourite, the reblogged / favourited status", + "field_type": "Status", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.9.9": "added" + }, + "enum": null + } + } + }, + { + "name": "Context", + "python_name": "Context", + "func_call": "mastodon.status_context()", + "func_call_real": "mastodon.status_context(110446983926957470)", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Context/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "ancestors": { + "description": "A list of status dicts of statuses that this status is a reply to", + "field_type": "list", + "field_subtype": "Status", + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "descendants": { + "description": "A list of status dicts of statuses that are replies to this status", + "field_type": "list", + "field_subtype": "Status", + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + } + } + }, + { + "name": "User List", + "python_name": "UserList", + "func_call": "mastodon.lists()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/List/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "id of the list", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.0": "added" + }, + "enum": null + }, + "title": { + "description": "title of the list", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.0": "added" + }, + "enum": null + }, + "replies_policy": { + "description": "Which replies should be shown in the list.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "RepliesPolicyEnum", + "version_history": { + "3.3.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Media", + "python_name": "MediaAttachment", + "func_call": "mastodon.media_post(\"image.jpg\", \"image/jpeg\")[\"meta\"]", + "func_call_real": "mastodon.status(110447012773105565).media_attachments[0]", + "func_call_additional": "mastodon.status(110447003454258227).media_attachments[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "The ID of the attachment.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "type": { + "description": "Media type: 'image', 'video', 'gifv', 'audio' or 'unknown'.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added", + "2.9.1": "added `audio`" + }, + "enum": { + "unknown": "unsupported or unrecognized file type", + "image": "Static image", + "gifv": "Looping, soundless animation", + "video": "Video clip", + "audio": "Audio track" + } + }, + "url": { + "description": "The URL for the image in the local cache", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "remote_url": { + "description": "The remote URL for the media (if the image is from a remote instance)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "field_structuretype": "URL", + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "preview_url": { + "description": "The URL for the media preview", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "0.6.0": "added" + }, + "enum": null + }, + "text_url": { + "description": "Deprecated. The display text for the media (what shows up in text). May not be present in mastodon versions after 3.5.0", + "deprecated": true, + "field_type": "str", + "field_subtype": null, + "field_structuretype": "URL", + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added", + "3.5.0": "removed" + } + }, + "meta": { + "description": "Dictionary of two metadata dicts (see below), 'original' and 'small' (preview). Either may be empty. May additionally contain an \"fps\" field giving a videos frames per second (possibly rounded), and a \"length\" field giving a videos length in a human-readable format. Note that a video may have an image as preview. May also contain a 'focus' dict and a media 'colors' dict.", + "field_type": "MediaAttachmentMetadataContainer", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.5.0": "added", + "2.3.0": "added focus", + "4.0.0": "added colors" + }, + "enum": null + }, + "blurhash": { + "description": "The blurhash for the image, used for preview / placeholder generation", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "Blurhash", + "version_history": { + "2.8.1": "added" + }, + "enum": null + }, + "description": { + "description": "If set, the user-provided description for this media.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.0.0": "added" + }, + "enum": null + }, + "preview_remote_url": { + "description": "If set, the remote URL for the thumbnail of this media attachment on the or originating instance.", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "URL", + "is_optional": false, + "is_nullable": true, + "version_history": { + "0.6.0": "added" + } + } + } + }, + { + "name": "Media metadata container", + "func_call_real": "mastodon.status(110447012773105565).media_attachments[0].meta", + "func_call_additional": "mastodon.status(110447003454258227).media_attachments[0].meta", + "python_name": "MediaAttachmentMetadataContainer", + "func_call": "mastodon.media_post(\"audio.mp3\").meta", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "original": { + "description": "Metadata for the original media attachment", + "field_type": "Union[MediaAttachmentImageMetadata, MediaAttachmentVideoMetadata, MediaAttachmentAudioMetadata]", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "small": { + "description": "Metadata for the thumbnail of this media attachment.", + "field_type": "MediaAttachmentImageMetadata", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "colors": { + "description": "Information about accent colors for the media.", + "field_type": "MediaAttachmentColors", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + }, + "focus": { + "description": "Information about the focus point for the media.", + "field_type": "MediaAttachmentFocusPoint", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.3.0": "added" + } + } + } + }, + { + "name": "Media image metadata", + "python_name": "MediaAttachmentImageMetadata", + "func_call": "mastodon.media_post(\"image.jpg\").meta.original", + "func_call_real": "mastodon.status(110447003454258227).media_attachments[0].meta.original", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "width": { + "description": "Width of the image in pixels", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "height": { + "description": "Height of the image in pixels", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "aspect": { + "description": "Aspect ratio of the image as a floating point number", + "field_type": "float", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "size": { + "description": "Textual representation of the image size in pixels, e.g. '800x600'", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + } + } + }, + { + "name": "Media video and gifv metadata", + "python_name": "MediaAttachmentVideoMetadata", + "func_call": "mastodon.media_post(\"video.mp4\").meta.original", + "func_call_real": "mastodon.status(110447001287656894).media_attachments[0].meta.original", + "func_call_additional": "mastodon.status(110447018236380496).media_attachments[0].meta.original", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "width": { + "description": "Width of the video in pixels", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "height": { + "description": "Height of the video in pixels", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "frame_rate": { + "description": "Exact frame rate of the video in frames per second. Can be an integer fraction (i.e. \"20/7\")", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "duration": { + "description": "Duration of the video in seconds", + "field_type": "float", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "bitrate": { + "description": "Average bit-rate of the video in bytes per second", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + } + } + }, + { + "name": "Media audio metadata", + "python_name": "MediaAttachmentAudioMetadata", + "func_call": "mastodon.media_post(\"audio.mp3\").meta.original", + "func_call_real": "mastodon.status(110447012773105565).media_attachments[0].meta.original", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "duration": { + "description": "Duration of the audio file in seconds", + "field_type": "float", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + }, + "bitrate": { + "description": "Average bit-rate of the audio file in bytes per second", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "0.6.0": "added" + } + } + } + }, + { + "name": "Media focus point", + "python_name": "MediaAttachmentFocusPoint", + "func_call": "mastodon.media_post(\"image.jpg\").meta.focus", + "func_call_real": "mastodon.status(110447003454258227).media_attachments[0].meta.focus", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "x": { + "description": "Focus point x coordinate (between -1 and 1), with 0 being the center and -1 and 1 being the left and right edges respectively.", + "field_type": "float", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.3.0": "added" + } + }, + "y": { + "description": "Focus point x coordinate (between -1 and 1), with 0 being the center and -1 and 1 being the upper and lower edges respectively.", + "field_type": "float", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.3.0": "added" + } + } + } + }, + { + "name": "Media colors", + "python_name": "MediaAttachmentColors", + "func_call": "mastodon.media_post(\"image.jpg\").meta.colors", + "func_call_real": "mastodon.status(110447012773105565).media_attachments[0].meta.colors", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "foreground": { + "description": "Estimated foreground colour for the attachment thumbnail, as a html format hex color (#rrggbb)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "background": { + "description": "Estimated background colour for the attachment thumbnail, as a html format hex color (#rrggbb)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "accent": { + "description": "Estimated accent colour for the attachment thumbnail", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + } + } + }, + { + "name": "Card", + "func_call": "mastodon.status_card()", + "func_call_real": "mastodon.status_card(110447098625216345)", + "python_name": "PreviewCard", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/PreviewCard/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "url": { + "description": "The URL of the card.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "1.0.0": "added" + }, + "enum": null + }, + "title": { + "description": "The title of the card.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.0.0": "added" + }, + "enum": null + }, + "description": { + "description": "Description of the embedded content", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.0.0": "added" + }, + "enum": null + }, + "type": { + "description": "Embed type: 'link', 'photo', 'video', or 'rich'", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": { + "link": "Link OEmbed", + "photo": "Photo OEmbed", + "video": "Video OEmbed", + "rich": "iframe OEmbed. Not currently accepted, so won't show up in practice." + } + }, + "image": { + "description": "(optional) The image associated with the card.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "field_structuretype": "URL", + "version_history": { + "1.0.0": "added" + }, + "enum": null + }, + "author_name": { + "description": "Name of the embedded contents author", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "author_url": { + "description": "URL pointing to the embedded contents author", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "width": { + "description": "Width of the embedded object", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "height": { + "description": "Height of the embedded object", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "html": { + "description": "HTML string of the embed", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "provider_name": { + "description": "Name of the provider from which the embed originates", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "provider_url": { + "description": "URL pointing to the embeds provider", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "blurhash": { + "description": "(optional) Blurhash of the preview image", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.2.0": "added" + }, + "enum": null + }, + "language": { + "description": "Language of the embedded content", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": true, + "is_nullable": false + }, + "embed_url": { + "description": "Used for photo embeds, instead of custom `html`.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "2.1.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Search result", + "python_name": "Search", + "func_call": "mastodon.search(\"\")", + "func_call_real": "mastodon.search(\"halcy\")", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Search/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "accounts": { + "description": "List of account dicts resulting from the query", + "field_type": "list", + "field_subtype": "Account", + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + }, + "hashtags": { + "description": "List of hashtag dicts resulting from the query", + "field_type": "list", + "field_subtype": "Tag", + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added", + "2.4.1": "v1/search deprecated because it returns Array of String. v2/search added which returns Array of Tag.", + "3.0.0": "v1 removed" + }, + "enum": null + }, + "statuses": { + "description": "List of status dicts resulting from the query", + "field_type": "list", + "field_subtype": "Status", + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Instance", + "python_name": "V1Instance", + "func_call": "mastodon.instance()", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "domain": { + "description": "The instances domain name", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + }, + "description": { + "description": "A brief instance description set by the admin", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + }, + "short_description": { + "description": "An even briefer instance description", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.2": "added" + }, + "enum": null + }, + "email": { + "description": "The admin contact email", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + }, + "title": { + "description": "The instance's title", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + }, + "uri": { + "description": "The instance's URL", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.1.0": "added" + }, + "enum": null + }, + "version": { + "description": "The instance's Mastodon version", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.3.0": "added" + }, + "enum": null + }, + "urls": { + "description": "Additional URLs dict, presently only 'streaming_api' with the stream websocket address.", + "field_type": "InstanceURLs", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.4.2": "added" + }, + "enum": null + }, + "stats": { + "description": "A dictionary containing three stats, user_count (number of local users), status_count (number of local statuses) and domain_count (number of known instance domains other than this one).", + "field_type": "InstanceStatistics", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "contact_account": { + "description": "Account dict of the primary contact for the instance", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "languages": { + "description": "Array of ISO 639-1 (two-letter) language codes the instance has chosen to advertise.", + "field_type": "list", + "field_subtype": "str", + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": false, + "is_nullable": false + }, + "registrations": { + "description": "Boolean indication whether registrations on this instance are open (True) or not (False)", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "approval_required": { + "description": "True if account approval is required when registering, False if not", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "rules": { + "description": "List of dicts with `id` and `text` fields, one for each server rule set by the admin", + "field_type": "list", + "field_subtype": "Rule", + "is_optional": false, + "is_nullable": false + }, + "thumbnail": { + "description": "URL pointing to a banner image representing the instance.", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "URL", + "is_optional": false, + "is_nullable": true, + "version_history": { + "1.6.1": "added" + } + }, + "invites_enabled": { + "description": "Boolean indicating whether invites are enabled on this instance.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.4": "added" + } + }, + "configuration": { + "description": "Various instance configuration settings - especially various limits (character counts, media upload sizes, ...)", + "field_type": "InstanceConfiguration", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.4": "added" + } + } + } + }, + { + "name": "Instance urls", + "python_name": "InstanceURLs", + "func_call": "mastodon.instance().urls", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "streaming_api": { + "description": "The Websockets URL for connecting to the streaming API.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "1.4.2": "added" + }, + "enum": null + } + } + }, + { + "name": "Instance statistics", + "python_name": "InstanceUsage", + "func_call": "mastodon.instance().stats", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "user_count": { + "description": "The total number of accounts that have been created on this instance.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.6.0": "added" + } + }, + "status_count": { + "description": "The total number of local posts that have been made on this instance.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.6.0": "added" + } + }, + "domain_count": { + "description": "The total number of other instances that this instance is aware of.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "1.6.0": "added" + } + } + } + }, + { + "name": "Instance rule", + "python_name": "Rule", + "func_call": "mastodon.instance().rules[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Rule/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "An identifier for the rule.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.0": "added" + }, + "enum": null + }, + "text": { + "description": "The rule to be followed.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Instance configuration", + "python_name": "InstanceConfiguration", + "func_call": "mastodon.instance().configuration", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/methods/instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "accounts": { + "description": "Account-related instance configuration fields", + "field_type": "InstanceAccountConfiguration", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + }, + "statuses": { + "description": "Status-related instance configuration fields", + "field_type": "InstanceStatusConfiguration", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "media_attachments": { + "description": "Media-related instance configuration fields", + "field_type": "InstanceMediaConfiguration", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "polls": { + "description": "Poll-related instance configuration fields", + "field_type": "InstancePollConfiguration", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "version_history": { + "3.4.2": "added" + } + } + }, + { + "name": "Instance account configuration", + "python_name": "InstanceAccountConfiguration", + "func_call": "mastodon.instance().configuration.accounts", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/methods/instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "max_featured_tags": { + "description": "The maximum number of featured tags that can be displayed on a profile.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + } + } + } + }, + { + "name": "Instance status configuration", + "python_name": "InstanceStatusConfiguration", + "func_call": "mastodon.instance().configuration.statuses", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/methods/instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "max_characters": { + "description": "Maximum number of characters in a status this instance allows local users to use.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "max_media_attachments": { + "description": "Maximum number of media attachments per status this instance allows local users to use.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "characters_reserved_per_url": { + "description": "Number of characters that this instance counts a URL as when counting charaters.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + } + } + }, + { + "name": "Instance media attachment configuration", + "python_name": "InstanceMediaConfiguration", + "func_call": "mastodon.instance().configuration.media_attachments", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/methods/instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "supported_mime_types": { + "description": "Mime types the instance accepts for media attachment uploads.", + "field_type": "list", + "field_subtype": "str", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "image_size_limit": { + "description": "Maximum size (in bytes) the instance will accept for image uploads.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "image_matrix_limit": { + "description": "Maximum total number of pixels (i.e. width * height) the instance will accept for image uploads.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "video_size_limit": { + "description": "Maximum size (in bytes) the instance will accept for video uploads", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "video_frame_rate_limit": { + "description": "Maximum frame rate the instance will accept for video uploads", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "video_matrix_limit": { + "description": "Maximum total number of pixels (i.e. width * height) the instance will accept for video uploads", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + } + } + }, + { + "name": "Instance poll configuration", + "python_name": "InstancePollConfiguration", + "func_call": "mastodon.instance().configuration.polls", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/methods/instance/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "max_options": { + "description": "How many poll options this instance allows local users to use per poll", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "max_characters_per_option": { + "description": "Maximum number of characters this instance allows local users to use per poll option", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "min_expiration": { + "description": "The shortest allowed duration for a poll on this instance, in seconds", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + }, + "max_expiration": { + "description": "The longest allowed duration for a poll on this instance, in seconds", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.4.2": "added" + } + } + } + }, + { + "name": "Nodeinfo", + "python_name": "Nodeinfo", + "func_call": "mastodon.instance_nodeinfo()", + "last_changed": "0.0.0", + "masto_doc_link": "https://github.com/jhass/nodeinfo", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "version": { + "description": "Version of the nodeinfo schemaw spec that was used for this response.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "software": { + "description": "Information about the server software being used on this instance.", + "field_type": "NodeinfoSoftware", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "protocols": { + "description": "A list of strings specifying the federation protocols this instance supports. Typically, just \"activitypub\".", + "field_type": "list", + "field_subtype": "str", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "services": { + "description": "Services that this instance can retrieve messages from or send messages to.", + "field_type": "NodeinfoServices", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "usage": { + "description": "Information about recent activity on this instance.", + "field_type": "NodeinfoUsage", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "openRegistrations": { + "description": "Bool indicating whether the instance is open for registrations.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "metadata": { + "description": "Additional node metadata. On Mastodon, typically an empty object with no fields.", + "field_type": "NodeinfoMetadata", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + } + } + }, + { + "name": "Nodeinfo software", + "python_name": "NodeinfoSoftware", + "func_call": "mastodon.instance_nodeinfo().software", + "last_changed": "0.0.0", + "masto_doc_link": "https://github.com/jhass/nodeinfo", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "name": { + "description": "Name of the software used by this instance.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "version": { + "description": "String indicating the version of the software used by this instance.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + } + } + }, + { + "name": "Nodeinfo services", + "python_name": "NodeinfoServices", + "func_call": "mastodon.instance_nodeinfo().services", + "last_changed": "0.0.0", + "masto_doc_link": "https://github.com/jhass/nodeinfo", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "outbound": { + "description": "List of services that this instance can send messages to. On Mastodon, typically an empty list.", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "inbound": { + "description": "List of services that this instance can retrieve messages from. On Mastodon, typically an empty list.", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + } + } + }, + { + "name": "Nodeinfo usage", + "python_name": "NodeinfoUsage", + "func_call": "mastodon.instance_nodeinfo().usage", + "last_changed": "0.0.0", + "masto_doc_link": "https://github.com/jhass/nodeinfo", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "users": { + "description": "Information about user counts on this instance.", + "field_type": "NodeinfoUsageUsers", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "localPosts": { + "description": "The total number of local posts that have been made on this instance.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + } + } + }, + { + "name": "Nodeinfo usage user count", + "python_name": "NodeinfoUsageUsers", + "func_call": "mastodon.instance_nodeinfo().usage.users", + "last_changed": "0.0.0", + "masto_doc_link": "https://github.com/jhass/nodeinfo", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "total": { + "description": "The total number of accounts that have been created on this instance.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "activeMonth": { + "description": "Number of users that have been active, by some definition (Mastodon: Have logged in at least once) in the last month.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + }, + "activeHalfyear": { + "description": "Number of users that have been active, by some definition (Mastodon: Have logged in at least once) in the last half year.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + } + } + } + }, + { + "name": "Nodeinfo metadata", + "python_name": "NodeinfoMetadata", + "masto_doc_link": "https://github.com/jhass/nodeinfo", + "func_call": "mastodon.instance_nodeinfo().metadata", + "fields": {}, + "last_changed": "3.0.0" + }, + { + "name": "Activity", + "python_name": "Activity", + "func_call": "mastodon.instance_activity()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/methods/instance/#activity", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "week": { + "description": "Date of the first day of the week the stats were collected for", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.2": "added" + } + }, + "logins": { + "description": "Number of users that logged in that week", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.2": "added" + } + }, + "registrations": { + "description": "Number of new users that week", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.2": "added" + } + }, + "statuses": { + "description": "Number of statuses posted that week", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.1.2": "added" + } + } + } + }, + { + "name": "Report", + "python_name": "AdminReport", + "func_call": "mastodon.admin_reports()[0]", + "func_alternate_acc": true, + "func_call_real": "mastodon.admin_reports()[-1]", + "func_call_additional": "mastodon.admin_reports(resolved=True)[-1]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Report/", + "manual_update": false, + "fields": { + "id": { + "description": "Numerical id of the report", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "action_taken": { + "description": "True if a moderator or admin has processed the report, False otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "comment": { + "description": "Text comment submitted with the report", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "created_at": { + "description": "Time at which this report was created, as a datetime object", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "updated_at": { + "description": "Last time this report has been updated, as a datetime object", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "account": { + "description": "Account dict of the user that filed this report", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "target_account": { + "description": "Account that has been reported with this report", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "assigned_account": { + "description": "If the report as been assigned to an account, account dict of that account (None if not)", + "field_type": "AdminAccount", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "action_taken_by_account": { + "description": "Account dict of the account that processed this report", + "field_type": "AdminAccount", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "statuses": { + "description": "List of statuses attached to the report, as status dicts", + "field_type": "list", + "field_subtype": "Status", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "action_taken_at": { + "description": "When an action was taken, if this report is currently resolved.", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "category": { + "description": "The category under which the report is classified.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "ReportReasonEnum", + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "forwarded": { + "description": "Whether a report was forwarded to a remote instance.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "rules": { + "description": "Rules attached to the report, for context.", + "field_type": "list", + "field_subtype": "Rule", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Push subscription", + "python_name": "WebPushSubscription", + "func_call": "mastodon.push_subscription()", + "func_call_real": "mastodon.push_subscription_set(\"http://halcy.de/\",mastodon.push_subscription_generate_keys()[1],follow_events=True)", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "Numerical id of the push subscription", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "endpoint": { + "description": "Endpoint URL for the subscription", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "server_key": { + "description": "Server pubkey used for signature verification", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "alerts": { + "description": "Subscribed events - object that may contain various keys, with value True if webpushes have been requested for those events.", + "field_type": "PushSubscriptionAlert", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added", + "2.8.0": "added poll`", + "3.1.0": "added follow_request`", + "3.3.0": "added status", + "3.5.0": "added update and admin.sign_up", + "4.0.0": "added admin.report" + }, + "enum": null + }, + "policy": { + "description": "Which sources should generate webpushes.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "enum": { + "all": "All sources generate pushes.", + "none": "Don't actually send pushes.", + "follower": "Pushes should be generated for events originating from accounts that follow the logged in user.", + "followed": "Pushes should be generated for events originating from accounts the logged in user follows." + }, + "version_history": { + "2.4.0": "added" + } + } + } + }, + { + "name": "Push subscription alert", + "python_name": "WebPushSubscriptionAlerts", + "func_call": "mastodon.push_subscription().alerts", + "func_call_real": "mastodon_soc.push_subscription_set(\"http://halcy.de/\",mastodon_soc.push_subscription_generate_keys()[1],follow_events=True).alerts", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/", + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "follow": { + "description": "True if push subscriptions for follow events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "favourite": { + "description": "True if push subscriptions for favourite events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "reblog": { + "description": "True if push subscriptions for reblog events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "mention": { + "description": "True if push subscriptions for mention events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "poll": { + "description": "True if push subscriptions for poll events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "follow_request": { + "description": "True if push subscriptions for follow request events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": null + }, + "status": { + "description": "True if push subscriptions for status creation (watched users only) events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "update": { + "description": "True if push subscriptions for status update (edit) events have been requested, false or not present otherwise.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.3.0": "added" + }, + "enum": null + }, + "admin_sign_up": { + "description": "True if push subscriptions for sign up events have been requested, false or not present otherwise. Admins only.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "admin_report": { + "description": "True if push subscriptions for report creation events have been requested, false or not present otherwise. Admins only.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Push notification", + "python_name": "PushNotification", + "func_call": "mastodon.push_subscription_decrypt_push(...)", + "manual_update": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "fields": { + "access_token": { + "description": "Access token that can be used to access the API as the notified user", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + }, + "body": { + "description": "Text body of the notification", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + }, + "icon": { + "description": "URL to an icon for the notification", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "URL", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + }, + "notification_id": { + "description": "ID that can be passed to notification() to get the full notification object,", + "field_type": "IdType", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + }, + "notification_type": { + "description": "String indicating the type of notification.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + }, + "enum": { + "follow": "A user followed the logged in user.", + "favourite": "A user favourited one of the logged in user's statuses.", + "reblog": "A user reblogged one of the logged in user's statuses.", + "mention" : "A user mentioned the logged in user in a status.", + "poll": "A poll created or participated in by the logged in user has updated or ended", + "follow_request": "A user has requested to follow the logged in user.", + "status":" A watched user has posted a new status.", + "update": "A status the logged in user has reblogged has been edited.", + "admin_sign_up": "A new user has signed up on the instance.", + "admin_report": "A user has been reported to the instance's administrators." + } + }, + "preferred_locale": { + "description": "The user's preferred locale", + "field_type": "str", + "field_subtype": null, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + }, + "title": { + "description": "Title for the notification", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.4.0": "added" + } + } + } + }, + { + "name": "Preference", + "python_name": "Preferences", + "func_call": "mastodon.preferences()", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Preferences/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "posting:default:visibility": { + "description": "Default visibility for new posts. Equivalent to CredentialAccount#source\\[privacy\\]().", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": { + "public": "Public post", + "unlisted": "Unlisted post", + "private": "Followers-only post", + "direct": "Direct post" + } + }, + "posting:default:sensitive": { + "description": "Default sensitivity flag for new posts. Equivalent to CredentialAccount#source\\[sensitive\\]().", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "posting:default:language": { + "description": "Default language for new posts. Equivalent to CredentialAccount#source\\[language\\]()", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "reading:expand:media": { + "description": "String indicating whether media attachments should be automatically displayed or blurred/hidden.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": { + "default": "Hide media marked as sensitive", + "show_all": "Always show all media by default, regardless of sensitivity", + "hide_all": "Always hide all media by default, regardless of sensitivity" + } + }, + "reading:expand:spoilers": { + "description": "Boolean indicating whether CWs should be expanded by default.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + }, + "enum": null + }, + "reading:autoplay:gifs": { + "description": "Boolean indicating whether gifs should be autoplayed (True) or not (False)", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.8.0": "added" + } + } + } + }, + { + "name": "Featured tag", + "python_name": "FeaturedTag", + "func_call": "mastodon.featured_tags()[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/FeaturedTag/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "id": { + "description": "The featured tags id", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + }, + "name": { + "description": "The featured tags name (without leading #)", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + }, + "statuses_count": { + "description": "Number of publicly visible statuses posted with this hashtag that this instance knows about", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + }, + "last_status_at": { + "description": "The last time a public status containing this hashtag was added to this instance's database (can be None if there are none)", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + }, + "url": { + "description": "A link to all statuses by a user that contain this hashtag.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "3.3.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Read marker", + "python_name": "Marker", + "func_call": "mastodon.markers_get()[\"home\"]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Marker/", + "func_call_real": null, + "func_call_additional": null, + "func_alternate_acc": false, + "manual_update": false, + "fields": { + "last_read_id": { + "description": "ID of the last read object in the timeline", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": [], + "enum": null + }, + "version": { + "description": "A counter that is incremented whenever the marker is set to a new status", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.0.0": "added" + }, + "enum": null + }, + "updated_at": { + "description": "The time the marker was last set, as a datetime object", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": [], + "enum": null + } + } + }, + { + "name": "Announcement", + "python_name": "Announcement", + "func_call": "mastodon.announcements()[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Announcement/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "id": { + "description": "The annoucements id", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "content": { + "description": "The contents of the annoucement, as an html string", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "starts_at": { + "description": "The annoucements start time, as a datetime object. Can be None", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "ends_at": { + "description": "The annoucements end time, as a datetime object. Can be None", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "all_day": { + "description": "Boolean indicating whether the annoucement represents an \"all day\" event", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "published_at": { + "description": "The annoucements publish time, as a datetime object", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "updated_at": { + "description": "The annoucements last updated time, as a datetime object", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "read": { + "description": "A boolean indicating whether the logged in user has dismissed the annoucement", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "mentions": { + "description": "Users mentioned in the annoucement, as a list of mention dicts", + "field_type": "list", + "field_subtype": "Mention", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "tags": { + "description": "Hashtags mentioned in the announcement, as a list of hashtag dicts", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "emojis": { + "description": "Custom emoji used in the annoucement, as a list of emoji dicts", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "reactions": { + "description": "Reactions to the annoucement, as a list of reaction dicts", + "field_type": "list", + "field_subtype": "Reaction", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "statuses": { + "description": "Statuses linked in the announcement text.", + "field_type": "list", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Announcement reaction", + "python_name": "Reaction", + "func_call": "mastodon.announcements()[0].reactions[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Reaction/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "name": { + "description": "Name of the custom emoji or unicode emoji of the reaction", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "count": { + "description": "Reaction counter (i.e. number of users who have added this reaction)", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "me": { + "description": "True if the logged-in user has reacted with this emoji, false otherwise", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "url": { + "description": "URL for the custom emoji image", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "3.1.0": "added" + }, + "enum": null + }, + "static_url": { + "description": "URL for a never-animated version of the custom emoji image", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "URL", + "version_history": { + "3.1.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Familiar follower", + "python_name": "FamiliarFollowers", + "func_alternate_acc": true, + "func_call": "mastodon.account_familiar_followers()[0]", + "func_call_real": "mastodon.account_familiar_followers(2)[0]", + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/FamiliarFollowers/", + "func_call_additional": null, + "manual_update": false, + "fields": { + "id": { + "description": "ID of the account for which the familiar followers are being returned", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "accounts": { + "description": "List of account dicts of the familiar followers", + "field_type": "list", + "field_subtype": "Account", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin account", + "python_name": "AdminAccount", + "func_call": "mastodon.admin_account()", + "func_call_real": "mastodon.admin_account(1)", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Account/", + "func_call_additional": null, + "manual_update": false, + "fields": { + "id": { + "description": "The users id,", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "username": { + "description": "The users username, no leading @", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "domain": { + "description": "The users domain", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "created_at": { + "description": "The time of account creation", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "email": { + "description": "For local users, the user's email", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "ip": { + "description": "For local users, the user's last known IP address", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.9.1": "added", + "3.5.0": "return type changed from String to [AdminIp]({{< relref \"entities/Admin_Ip\" >}}) due to a bug", + "4.0.0": "bug fixed, return type is now a String again" + }, + "enum": null + }, + "role": { + "description": "The users role", + "field_type": "Role", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added, returns a String (enumerable, oneOf `user` `moderator` `admin`)", + "4.0.0": "now uses Role entity" + }, + "enum": null + }, + "confirmed": { + "description": "For local users, False if the user has not confirmed their email, True otherwise", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "suspended": { + "description": "Boolean indicating whether the user has been suspended", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "silenced": { + "description": "Boolean indicating whether the user has been silenced", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "disabled": { + "description": "For local users, boolean indicating whether the user has had their login disabled", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "approved": { + "description": "For local users, False if the user is pending, True otherwise", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "locale": { + "description": "For local users, the locale the user has set,", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "TwoLetterLanguageCodeEnum", + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "invite_request": { + "description": "If the user requested an invite, the invite request comment of that user.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "invited_by_account_id": { + "description": "Present if the user was invited by another user and set to the inviting users id.", + "field_type": "IdType", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "account": { + "description": "The user's account, as a standard account dict", + "field_type": "Account", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "sensitized": { + "description": "Undocumented. If you know what this does, please let me know.", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "help_wanted": true, + "version_history": { + "2.9.1": "added" + } + }, + "ips": { + "description": "All known IP addresses associated with this account.", + "field_type": "list", + "field_subtype": "AdminIp", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "created_by_application_id": { + "description": "Present if the user was created by an application and set to the application id.", + "field_type": "IdType", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + }, + "invited_by_account_id ": { + "description": "Present if the user was created via invite and set to the inviting users id.", + "field_type": "IdType", + "field_subtype": null, + "is_optional": true, + "is_nullable": false, + "version_history": { + "2.9.1": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin account IP", + "python_name": "AdminIp", + "func_call": "mastodon.admin_account().ips[0]", + "func_call_real": "mastodon.admin_account(1).ips[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Ip/", + "func_call_additional": null, + "manual_update": false, + "fields": { + "ip": { + "description": "The IP address.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "used_at": { + "description": "The timestamp of when the IP address was last used for this account.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin measure", + "python_name": "AdminMeasure", + "func_call": "mastodon.admin_measures(datetime.now() - timedelta(hours=24*5), datetime.now(), interactions=True)[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "key": { + "description": "Name of the measure returned", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "unit": { + "description": "Unit for the measure, if available", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "total": { + "description": "Value of the measure returned", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "human_value": { + "description": "Human readable variant of the measure returned", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "previous_total": { + "description": "Previous measurement period value of the measure returned, if available", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "data": { + "description": "A list of dicts with the measure broken down by date, as below", + "field_type": "list", + "field_subtype": "AdminMeasureData", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin measure data", + "python_name": "AdminMeasureData", + "func_call": "mastodon.admin_measures(datetime.now() - timedelta(hours=24*5), datetime.now(), active_users=True)[0].data[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "date": { + "description": "Date for this row", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "value": { + "description": "Value of the measure for this row", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin dimension", + "python_name": "AdminDimension", + "func_call": "mastodon.admin_dimensions(datetime.now() - timedelta(hours=24*5), datetime.now(), languages=True)[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "key": { + "description": "Name of the dimension returned", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "data": { + "description": "A list of data dicts, as below", + "field_type": "list", + "field_subtype": "AdminDimensionData", + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin dimension data", + "python_name": "AdminDimensionData", + "func_call": "mastodon.admin_dimensions(datetime.now() - timedelta(hours=24*5), datetime.now(), languages=True)[0].data[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "key": { + "description": "category for this row", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "human_key": { + "description": "Human readable name for the category for this row, when available", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + }, + "value": { + "description": "Numeric value for the category", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "3.5.0": "added" + }, + "enum": null + } + } + }, + { + "name": "Admin retention", + "python_name": "AdminRetention", + "func_call": "mastodon.admin_retention(datetime.now() - timedelta(hours=24*5), datetime.now())[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "period": { + "description": "Starting time of the period that the data is being returned for", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "frequency": { + "description": "Time resolution (day or month) for the returned data", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "data": { + "description": "List of data dicts, as below", + "field_type": "list", + "field_subtype": "AdminCohort", + "is_optional": false, + "is_nullable": false + } + } + }, + { + "name": "Admin retention data", + "python_name": "AdminCohort", + "func_call": "mastodon.admin_retention(datetime.now() - timedelta(hours=24*5), datetime.now())[0].data[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "date": { + "description": "Date for this entry", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "rate": { + "description": "Fraction of users retained", + "field_type": "float", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + }, + "value": { + "description": "Absolute number of users retained", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false + } + } + }, + { + "name": "Admin domain block", + "python_name": "AdminDomainBlock", + "func_call": "mastodon_ico_admin.admin_domain_blocks()[0]", + "func_alternate_acc": true, + "last_changed": "0.0.0", + "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainBlock/", + "func_call_real": null, + "func_call_additional": null, + "manual_update": false, + "fields": { + "id": { + "description": "The ID of the DomainBlock in the database.", + "field_type": "int", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "domain": { + "description": "The domain that is not allowed to federate.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "created_at": { + "description": "When the domain was blocked from federating.", + "field_type": "datetime", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "severity": { + "description": "The policy to be applied by this domain block.", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "field_structuretype": "DomainLimitEnum", + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "reject_media": { + "description": "Whether to reject media attachments from this domain", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "reject_reports": { + "description": "Whether to reject reports from this domain", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "private_comment": { + "description": "", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "public_comment": { + "description": "", + "field_type": "str", + "field_subtype": null, + "is_optional": false, + "is_nullable": true, + "version_history": { + "4.0.0": "added" + }, + "enum": null + }, + "obfuscate": { + "description": "Whether to obfuscate public displays of this domain block", + "field_type": "bool", + "field_subtype": null, + "is_optional": false, + "is_nullable": false, + "version_history": { + "4.0.0": "added" + }, + "enum": null + } + } + } +] \ No newline at end of file