{ "ApplicationCommandSchema": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "application_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "guild_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "name": { "type": "string" }, "name_localizations": { "$ref": "#/definitions/Record" }, "name_localized": { "type": [ "null", "string" ] }, "description": { "type": "string" }, "description_localizations": { "$ref": "#/definitions/Record" }, "description_localized": { "type": [ "null", "string" ] }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } }, "default_member_permissions": { "type": [ "null", "string" ] }, "dm_permission": { "type": "boolean" }, "permissions": { "$ref": "#/definitions/ApplicationCommandIndexPermissions" }, "nsfw": { "type": "boolean" }, "integration_types": { "type": "array", "items": { "$ref": "#/definitions/ApplicationIntegrationType" } }, "global_popularity_rank": { "type": "integer" }, "contexts": { "type": "array", "items": { "$ref": "#/definitions/InteractionContextType" } }, "version": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "handler": { "enum": [ 1, 2, 3 ], "type": "number" } }, "additionalProperties": false, "required": [ "application_id", "default_member_permissions", "description", "name", "version" ], "definitions": { "Record": { "type": "object", "additionalProperties": false }, "ApplicationCommandOption": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ApplicationCommandOptionType" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "choices": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOptionChoice" } }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } } }, "additionalProperties": false, "required": [ "description", "name", "type" ] }, "ApplicationCommandOptionType": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ] }, "ApplicationCommandOptionChoice": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": [ "string", "integer" ] } }, "additionalProperties": false, "required": [ "name", "value" ] }, "ApplicationCommandIndexPermissions": { "type": "object", "properties": { "user": { "type": "boolean" }, "roles": { "$ref": "#/definitions/Record" }, "channels": { "$ref": "#/definitions/Record" } }, "additionalProperties": false }, "Record": { "type": "object", "additionalProperties": false }, "ApplicationIntegrationType": { "type": "number", "enum": [ 0, 1 ] }, "InteractionContextType": { "type": "number", "enum": [ 0, 1, 2 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "InteractionSchema": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ApplicationCommandType" }, "application_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "guild_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "channel_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "message_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "message_flags": { "type": "integer" }, "session_id": { "type": "string" }, "data": { "$ref": "#/definitions/InteractionData" }, "files": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } }, "nonce": { "type": "string" }, "analytics_location": { "type": "string" }, "section_name": { "type": "string" }, "source": { "type": "string" } }, "additionalProperties": false, "required": [ "application_id", "channel_id", "data", "type" ], "definitions": { "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "InteractionData": { "type": "object", "properties": { "application_command": { "type": "object", "properties": {}, "additionalProperties": true }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/UploadAttachmentRequestSchema" } }, "id": { "type": "string" }, "name": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } }, "type": { "type": "integer" }, "version": { "type": "string" } }, "additionalProperties": false, "required": [ "application_command", "attachments", "id", "name", "options", "type", "version" ] }, "UploadAttachmentRequestSchema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/definitions/UploadAttachmentRequest" } } }, "additionalProperties": false, "required": [ "files" ] }, "UploadAttachmentRequest": { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "file_size": { "type": "integer" }, "is_clip": { "type": "boolean" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "file_size", "filename" ] }, "ApplicationCommandOption": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ApplicationCommandOptionType" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "choices": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOptionChoice" } }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } } }, "additionalProperties": false, "required": [ "description", "name", "type" ] }, "ApplicationCommandOptionType": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ] }, "ApplicationCommandOptionChoice": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": [ "string", "integer" ] } }, "additionalProperties": false, "required": [ "name", "value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "InteractionCallbackSchema": { "type": "object", "properties": { "type": { "$ref": "#/definitions/InteractionCallbackType" }, "data": { "$ref": "#/definitions/MessageCreateSchema" } }, "additionalProperties": false, "required": [ "data", "type" ], "definitions": { "InteractionCallbackType": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] }, "MessageCreateSchema": { "type": "object", "properties": { "type": { "type": "integer" }, "content": { "type": "string" }, "mobile_network_type": { "type": "string" }, "nonce": { "type": "string" }, "channel_id": { "type": "string" }, "tts": { "type": "boolean" }, "flags": { "type": "integer" }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "embed": { "$ref": "#/definitions/Embed" }, "allowed_mentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "message_id" ] }, "payload_json": { "type": "string" }, "file": { "type": "object", "properties": { "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename" ] }, "attachments": { "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion", "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "uploaded_filename": { "type": "string" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "uploaded_filename" ] } ] } }, "sticker_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "components": { "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, { "type": "null" } ] }, "poll": { "$ref": "#/definitions/PollCreationSchema" }, "enforce_nonce": { "type": "boolean" }, "applied_tags": { "type": "array", "items": { "type": "string" } }, "thread_name": { "type": "string" }, "avatar_url": { "type": "string" }, "interaction": { "$ref": "#/definitions/MessageInteractionSchema" }, "interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" } }, "additionalProperties": false }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "PollCreationSchema": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "duration": { "type": "integer" }, "allow_multiselect": { "type": "boolean" }, "layout_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "answers", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "MessageInteractionSchema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" }, "command_type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "ephemerality_reason": { "type": "integer" }, "user": { "$ref": "#/definitions/PublicUser" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "original_response_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "interacted_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "triggering_interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" }, "target_user": { "$ref": "#/definitions/PublicUser" }, "target_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] }, "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ConnectedAccountCommonOAuthTokenResponse": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "scope", "token_type" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ClientResponse": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "body": { "type": "object", "properties": {}, "additionalProperties": true }, "headers": {} }, "additionalProperties": false, "required": [ "body", "headers", "statusCode" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "HttpResponse": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "reason": { "type": "string" }, "headers": { "$ref": "#/definitions/HeaderBag" }, "body": {} }, "additionalProperties": false, "required": [ "headers", "statusCode" ], "definitions": { "HeaderBag": { "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StreamingBlobSchema": { "type": "integer", "const": 42, "$schema": "http://json-schema.org/draft-07/schema#" }, "StringSchema": { "description": "Includes string and enum Smithy types.", "type": "integer", "const": 0, "$schema": "http://json-schema.org/draft-07/schema#" }, "TimestampDefaultSchema": { "description": "Smithy type timestamp, in JS as native Date object.", "type": "integer", "const": 4, "$schema": "http://json-schema.org/draft-07/schema#" }, "TimestampDateTimeSchema": { "type": "integer", "const": 5, "$schema": "http://json-schema.org/draft-07/schema#" }, "TimestampHttpDateSchema": { "type": "integer", "const": 6, "$schema": "http://json-schema.org/draft-07/schema#" }, "TimestampEpochSecondsSchema": { "type": "integer", "const": 7, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticSchema": { "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 } ], "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticSimpleSchema": { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticSimpleSchema": { "$ref": "#/definitions/StaticSimpleSchema", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticSimpleSchema": { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticListSchema": { "$ref": "#/definitions/StaticListSchema", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "$ref": "#/definitions/StaticListSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticListSchema": { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticMapSchema": { "$ref": "#/definitions/StaticMapSchema", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "$ref": "#/definitions/StaticMapSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticMapSchema": { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticStructureSchema": { "$ref": "#/definitions/StaticStructureSchema", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/StaticStructureSchema" }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticStructureSchema": { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticErrorSchema": { "$ref": "#/definitions/StaticErrorSchema", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/StaticErrorSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticErrorSchema": { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StaticOperationSchema": { "$ref": "#/definitions/StaticOperationSchema", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/StaticOperationSchema" }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticOperationSchema": { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "$Schema": { "description": "A schema is an object or value that describes how to serialize/deserialize data.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "const": "unit", "type": "string" }, { "type": "integer" } ], "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticSimpleSchema": { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SimpleSchema": { "description": "Although numeric values exist for most simple schema, this class is used for cases where traits are\nattached to those schema, since a single number cannot easily represent both a schema and its traits.", "type": "integer", "$schema": "http://json-schema.org/draft-07/schema#" }, "UnitSchema": { "description": "Signal value for the Smithy void value. Typically used for\noperation input and outputs.", "type": "string", "const": "unit", "$schema": "http://json-schema.org/draft-07/schema#" }, "$MemberSchema": { "$ref": "#/definitions/$MemberSchema", "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "definitions": { "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/$MemberSchema", "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits." }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$MemberSchema": { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "$OperationSchema": { "description": "Schema for an operation.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" }, "input": { "$ref": "#/definitions/$SchemaRef" }, "output": { "$ref": "#/definitions/$SchemaRef" } }, "additionalProperties": false, "required": [ "input", "name", "namespace", "output", "traits" ], "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TraitsSchema": { "description": "A schema that has traits.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits" ], "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MemberSchema": { "$ref": "#/definitions/MemberSchema", "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "definitions": { "SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/NormalizedSchema" }, { "$ref": "#/definitions/TraitsSchema" }, { "$ref": "#/definitions/ListSchema" }, { "$ref": "#/definitions/MapSchema" }, { "$ref": "#/definitions/StructureSchema" }, { "$ref": "#/definitions/MemberSchema", "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits." }, { "$ref": "#/definitions/OperationSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticSimpleSchema": { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false }, "TraitsSchema": { "description": "A schema that has traits.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits" ] }, "ListSchema": { "description": "Schema for the list aggregate type.", "type": "object", "properties": { "valueSchema": { "$ref": "#/definitions/SchemaRef" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits", "valueSchema" ] }, "MapSchema": { "description": "Schema for the map aggregate type.", "type": "object", "properties": { "keySchema": { "$ref": "#/definitions/SchemaRef" }, "valueSchema": { "$ref": "#/definitions/SchemaRef" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "keySchema", "name", "namespace", "traits", "valueSchema" ] }, "StructureSchema": { "description": "Schema for the structure aggregate type.", "type": "object", "properties": { "memberNames": { "type": "array", "items": { "type": "string" } }, "memberList": { "type": "array", "items": { "$ref": "#/definitions/SchemaRef" } }, "members": { "$ref": "#/definitions/Record" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "memberList", "memberNames", "name", "namespace", "traits" ] }, "Record": { "type": "object", "additionalProperties": false }, "MemberSchema": { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, "OperationSchema": { "description": "Schema for an operation.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" }, "input": { "$ref": "#/definitions/SchemaRef" }, "output": { "$ref": "#/definitions/SchemaRef" } }, "additionalProperties": false, "required": [ "input", "name", "namespace", "output", "traits" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StructureSchema": { "$ref": "#/definitions/StructureSchema", "description": "Schema for the structure aggregate type.", "definitions": { "SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/NormalizedSchema" }, { "$ref": "#/definitions/TraitsSchema" }, { "$ref": "#/definitions/ListSchema" }, { "$ref": "#/definitions/MapSchema" }, { "$ref": "#/definitions/StructureSchema" }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/OperationSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticSimpleSchema": { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false }, "TraitsSchema": { "description": "A schema that has traits.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits" ] }, "ListSchema": { "description": "Schema for the list aggregate type.", "type": "object", "properties": { "valueSchema": { "$ref": "#/definitions/SchemaRef" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits", "valueSchema" ] }, "MapSchema": { "description": "Schema for the map aggregate type.", "type": "object", "properties": { "keySchema": { "$ref": "#/definitions/SchemaRef" }, "valueSchema": { "$ref": "#/definitions/SchemaRef" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "keySchema", "name", "namespace", "traits", "valueSchema" ] }, "StructureSchema": { "description": "Schema for the structure aggregate type.", "type": "object", "properties": { "memberNames": { "type": "array", "items": { "type": "string" } }, "memberList": { "type": "array", "items": { "$ref": "#/definitions/SchemaRef" } }, "members": { "$ref": "#/definitions/Record" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "memberList", "memberNames", "name", "namespace", "traits" ] }, "Record": { "type": "object", "additionalProperties": false }, "OperationSchema": { "description": "Schema for an operation.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" }, "input": { "$ref": "#/definitions/SchemaRef" }, "output": { "$ref": "#/definitions/SchemaRef" } }, "additionalProperties": false, "required": [ "input", "name", "namespace", "output", "traits" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "OperationSchema": { "$ref": "#/definitions/OperationSchema", "description": "Schema for an operation.", "definitions": { "SchemaTraits": { "description": "Traits attached to schema objects.\n\nWhen this is a number, it refers to a pre-allocated\ntrait combination that is equivalent to one of the\nobject type's variations.", "anyOf": [ { "description": "See https://smithy.io/2.0/trait-index.html for individual definitions.", "type": "object", "additionalProperties": {}, "properties": { "idempotent": { "const": 1, "type": "number" }, "idempotencyToken": { "const": 1, "type": "number" }, "sensitive": { "const": 1, "type": "number" }, "sparse": { "const": 1, "type": "number" }, "httpLabel": { "const": 1, "type": "number" }, "httpHeader": { "type": "string" }, "httpQuery": { "type": "string" }, "httpPrefixHeaders": { "type": "string" }, "httpQueryParams": { "const": 1, "type": "number" }, "httpPayload": { "const": 1, "type": "number" }, "http": { "description": "[method, path, statusCode]", "type": "array", "items": [ { "type": "string" }, { "type": "string" }, { "type": "integer" } ], "minItems": 3, "maxItems": 3 }, "httpResponseCode": { "const": 1, "type": "number" }, "endpoint": { "description": "[hostPrefix]", "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "xmlAttribute": { "const": 1, "type": "number" }, "xmlName": { "type": "string" }, "xmlNamespace": { "description": "[prefix, uri]", "type": "array", "items": [ { "type": "string" }, { "type": "string" } ], "minItems": 2, "maxItems": 2 }, "xmlFlattened": { "const": 1, "type": "number" }, "jsonName": { "type": "string" }, "mediaType": { "type": "string" }, "error": { "enum": [ "client", "server" ], "type": "string" }, "streaming": { "const": 1, "type": "number" }, "eventHeader": { "const": 1, "type": "number" }, "eventPayload": { "const": 1, "type": "number" } } }, { "type": "integer" } ] }, "SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "$ref": "#/definitions/NormalizedSchema" }, { "$ref": "#/definitions/TraitsSchema" }, { "$ref": "#/definitions/ListSchema" }, { "$ref": "#/definitions/MapSchema" }, { "$ref": "#/definitions/StructureSchema" }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/OperationSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "$SchemaRef": { "description": "A schema \"reference\" is either a schema or a function that\nprovides a schema. This is useful for lazy loading, and to allow\ncode generation to define schema out of dependency order.", "anyOf": [ { "$ref": "#/definitions/StaticSimpleSchema" }, { "type": "array", "items": [ { "type": "integer", "const": 1 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, { "type": "array", "items": [ { "type": "integer", "const": 2 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": -3 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/$SchemaRef" } } ], "minItems": 6, "maxItems": 6 }, { "type": "array", "items": [ { "type": "integer", "const": 9 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 6, "maxItems": 6 }, { "description": "Indicates the schema is a member of a parent Structure schema.\nIt may also have a set of member traits distinct from its target shape's traits.", "type": "array", "items": [ { "$ref": "#/definitions/$SchemaRef" }, { "$ref": "#/definitions/SchemaTraits" } ], "minItems": 2, "maxItems": 2 }, { "$ref": "#/definitions/NormalizedSchema" }, { "type": "object", "additionalProperties": false }, { "const": "unit", "type": "string" }, { "type": "integer" } ] }, "StaticSimpleSchema": { "type": "array", "items": [ { "type": "integer", "const": 0 }, { "type": "string" }, { "type": "string" }, { "$ref": "#/definitions/SchemaTraits" }, { "$ref": "#/definitions/$SchemaRef" } ], "minItems": 5, "maxItems": 5 }, "NormalizedSchema": { "description": "Normalization wrapper for various schema data objects.", "type": "object", "additionalProperties": false }, "TraitsSchema": { "description": "A schema that has traits.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits" ] }, "ListSchema": { "description": "Schema for the list aggregate type.", "type": "object", "properties": { "valueSchema": { "$ref": "#/definitions/SchemaRef" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "name", "namespace", "traits", "valueSchema" ] }, "MapSchema": { "description": "Schema for the map aggregate type.", "type": "object", "properties": { "keySchema": { "$ref": "#/definitions/SchemaRef" }, "valueSchema": { "$ref": "#/definitions/SchemaRef" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "keySchema", "name", "namespace", "traits", "valueSchema" ] }, "StructureSchema": { "description": "Schema for the structure aggregate type.", "type": "object", "properties": { "memberNames": { "type": "array", "items": { "type": "string" } }, "memberList": { "type": "array", "items": { "$ref": "#/definitions/SchemaRef" } }, "members": { "$ref": "#/definitions/Record" }, "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" } }, "additionalProperties": false, "required": [ "memberList", "memberNames", "name", "namespace", "traits" ] }, "Record": { "type": "object", "additionalProperties": false }, "OperationSchema": { "description": "Schema for an operation.", "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "traits": { "$ref": "#/definitions/SchemaTraits" }, "input": { "$ref": "#/definitions/SchemaRef" }, "output": { "$ref": "#/definitions/SchemaRef" } }, "additionalProperties": false, "required": [ "input", "name", "namespace", "output", "traits" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ResolvedHttpResponse": { "type": "object", "properties": { "body": { "type": "string" }, "statusCode": { "type": "integer" }, "reason": { "type": "string" }, "headers": { "$ref": "#/definitions/HeaderBag" } }, "additionalProperties": false, "required": [ "body", "headers", "statusCode" ], "definitions": { "HeaderBag": { "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "BatchGetMetricDataResponse": { "description": "

Represents the result of processing your metric data batch request

", "type": "object", "properties": { "Results": { "description": "

A list of successfully retrieved MetricDataResult.

", "type": "array", "items": { "$ref": "#/definitions/MetricDataResult" } }, "Errors": { "description": "

A list of MetricDataError encountered while processing your metric data batch request.

", "type": "array", "items": { "$ref": "#/definitions/MetricDataError" } } }, "additionalProperties": false, "definitions": { "MetricDataResult": { "description": "

The result of a single metric data query.

", "type": "object", "properties": { "Id": { "description": "

The query identifier.

", "type": "string" }, "Timestamps": { "description": "

A list of timestamps for the metric data results.

", "type": "array", "items": { "type": "string", "format": "date-time" } }, "Values": { "description": "

A list of values (cumulative / sum) for the metric data results.

", "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "MetricDataError": { "description": "

An error corresponding to the unsuccessful processing of a single metric data query.

", "type": "object", "properties": { "Id": { "description": "

The query identifier.

", "type": "string" }, "Code": { "description": "

The query error code. Can be one of:

\n
    \n
  • \n

    \n INTERNAL_FAILURE – Amazon SES has failed to process one of the queries.

    \n
    • \n
  • \n

    \n ACCESS_DENIED – You have insufficient access to retrieve metrics\n based on the given query.

    \n
    • \n
", "enum": [ "ACCESS_DENIED", "INTERNAL_FAILURE" ], "type": "string" }, "Message": { "description": "

The error message associated with the current query error.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CancelExportJobResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateConfigurationSetResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateConfigurationSetEventDestinationResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateContactResponse": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateContactListResponse": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateCustomVerificationEmailTemplateResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateDedicatedIpPoolResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateDeliverabilityTestReportResponse": { "description": "

Information about the predictive inbox placement test that you created.

", "type": "object", "properties": { "ReportId": { "description": "

A unique string that identifies the predictive inbox placement test.

", "type": "string" }, "DeliverabilityTestStatus": { "description": "

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

", "enum": [ "COMPLETED", "IN_PROGRESS" ], "type": "string" } }, "additionalProperties": false, "required": [ "DeliverabilityTestStatus", "ReportId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateEmailIdentityResponse": { "description": "

If the email identity is a domain, this object contains information about the DKIM\n verification status for the domain.

\n

If the email identity is an email address, this object is empty.

", "type": "object", "properties": { "IdentityType": { "description": "

The email identity type. Note: the MANAGED_DOMAIN identity type is not\n supported.

", "enum": [ "DOMAIN", "EMAIL_ADDRESS", "MANAGED_DOMAIN" ], "type": "string" }, "VerifiedForSendingStatus": { "description": "

Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.

", "type": "boolean" }, "DkimAttributes": { "description": "

An object that contains information about the DKIM attributes for the identity.

", "$ref": "#/definitions/DkimAttributes" } }, "additionalProperties": false, "definitions": { "DkimAttributes": { "description": "

An object that contains information about the DKIM authentication status for an email\n identity.

\n

Amazon SES determines the authentication status by searching for specific records in the\n DNS configuration for the domain. If you used Easy DKIM to set up DKIM\n authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration\n for your domain. If you provided a public key to perform DKIM authentication, Amazon SES\n tries to find a TXT record that uses the selector that you specified. The value of the\n TXT record must be a public key that's paired with the private key that you specified in\n the process of creating the identity

", "type": "object", "properties": { "SigningEnabled": { "description": "

If the value is true, then the messages that you send from the identity\n are signed using DKIM. If the value is false, then the messages that you\n send from the identity aren't DKIM-signed.

", "type": "boolean" }, "Status": { "description": "

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS\n records for the domain. The status can be one of the following:

\n
    \n
  • \n

    \n PENDING – The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.

    \n
    • \n
  • \n

    \n SUCCESS – The verification process completed\n successfully.

    \n
    • \n
  • \n

    \n FAILED – The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.

    \n
    • \n
  • \n

    \n TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.

    \n
    • \n
  • \n

    \n NOT_STARTED – The DKIM verification process hasn't been\n initiated for the domain.

    \n
    • \n
", "enum": [ "FAILED", "NOT_STARTED", "PENDING", "SUCCESS", "TEMPORARY_FAILURE" ], "type": "string" }, "Tokens": { "description": "

If you used Easy DKIM to configure DKIM authentication for the domain, then this object\n contains a set of unique strings that you use to create a set of CNAME records that you\n add to the DNS configuration for your domain. When Amazon SES detects these records in the\n DNS configuration for your domain, the DKIM authentication process is complete.

\n

If you configured DKIM authentication for the domain by providing your own\n public-private key pair, then this object contains the selector for the public\n key.

\n

Regardless of the DKIM authentication method you use, Amazon SES searches for the\n appropriate records in the DNS configuration of the domain for up to 72 hours.

", "type": "array", "items": { "type": "string" } }, "SigningAttributesOrigin": { "description": "

A string that indicates how DKIM was configured for the identity. These are the\n possible values:

\n
    \n
  • \n

    \n AWS_SES – Indicates that DKIM was configured for the\n identity by using Easy DKIM.

    \n
    • \n
  • \n

    \n EXTERNAL – Indicates that DKIM was configured for the\n identity by using Bring Your Own DKIM (BYODKIM).

    \n
    • \n
  • \n

    \n AWS_SES_AF_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_NORTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTH_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_WEST_3 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_WEST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_WEST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_NORTHEAST_3 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_NORTHEAST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_ME_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_ME_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_NORTHEAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_IL_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_SA_EAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_CA_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTHEAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTHEAST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTHEAST_3 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_CENTRAL_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_EAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_EAST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_WEST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US West (N. California) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_WEST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
", "enum": [ "AWS_SES", "AWS_SES_AF_SOUTH_1", "AWS_SES_AP_NORTHEAST_1", "AWS_SES_AP_NORTHEAST_2", "AWS_SES_AP_NORTHEAST_3", "AWS_SES_AP_SOUTHEAST_1", "AWS_SES_AP_SOUTHEAST_2", "AWS_SES_AP_SOUTHEAST_3", "AWS_SES_AP_SOUTH_1", "AWS_SES_AP_SOUTH_2", "AWS_SES_CA_CENTRAL_1", "AWS_SES_EU_CENTRAL_1", "AWS_SES_EU_CENTRAL_2", "AWS_SES_EU_NORTH_1", "AWS_SES_EU_SOUTH_1", "AWS_SES_EU_WEST_1", "AWS_SES_EU_WEST_2", "AWS_SES_EU_WEST_3", "AWS_SES_IL_CENTRAL_1", "AWS_SES_ME_CENTRAL_1", "AWS_SES_ME_SOUTH_1", "AWS_SES_SA_EAST_1", "AWS_SES_US_EAST_1", "AWS_SES_US_EAST_2", "AWS_SES_US_WEST_1", "AWS_SES_US_WEST_2", "EXTERNAL" ], "type": "string" }, "NextSigningKeyLength": { "description": "

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be\n changed at most once per day.

", "enum": [ "RSA_1024_BIT", "RSA_2048_BIT" ], "type": "string" }, "CurrentSigningKeyLength": { "description": "

[Easy DKIM] The key length of the DKIM key pair in use.

", "enum": [ "RSA_1024_BIT", "RSA_2048_BIT" ], "type": "string" }, "LastKeyGenerationTimestamp": { "description": "

[Easy DKIM] The last time a key pair was generated for this identity.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateEmailIdentityPolicyResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateEmailTemplateResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateExportJobResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "JobId": { "description": "

A string that represents the export job ID.

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateImportJobResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "JobId": { "description": "

A string that represents the import job ID.

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateMultiRegionEndpointResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "Status": { "description": "

A status of the multi-region endpoint (global-endpoint) right after the create request.

\n
    \n
  • \n

    \n CREATING – The resource is being provisioned.

    \n
    • \n
  • \n

    \n READY – The resource is ready to use.

    \n
    • \n
  • \n

    \n FAILED – The resource failed to be provisioned.

    \n
    • \n
  • \n

    \n DELETING – The resource is being deleted as requested.

    \n
    • \n
", "enum": [ "CREATING", "DELETING", "FAILED", "READY" ], "type": "string" }, "EndpointId": { "description": "

The ID of the multi-region endpoint (global-endpoint).

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateTenantResponse": { "description": "

Information about a newly created tenant.

", "type": "object", "properties": { "TenantName": { "description": "

The name of the tenant.

", "type": "string" }, "TenantId": { "description": "

A unique identifier for the tenant.

", "type": "string" }, "TenantArn": { "description": "

The Amazon Resource Name (ARN) of the tenant.

", "type": "string" }, "CreatedTimestamp": { "description": "

The date and time when the tenant was created.

", "type": "string", "format": "date-time" }, "Tags": { "description": "

An array of objects that define the tags (keys and values) associated with the tenant.

", "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "SendingStatus": { "description": "

The status of email sending capability for the tenant.

", "enum": [ "DISABLED", "ENABLED", "REINSTATED" ], "type": "string" } }, "additionalProperties": false, "definitions": { "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateTenantResourceAssociationResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetAccountResponse": { "description": "

A list of details about the email-sending capabilities of your Amazon SES account in the\n current Amazon Web Services Region.

", "type": "object", "properties": { "DedicatedIpAutoWarmupEnabled": { "description": "

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP\n addresses that are associated with your account.

", "type": "boolean" }, "EnforcementStatus": { "description": "

The reputation status of your Amazon SES account. The status can be one of the\n following:

\n
    \n
  • \n

    \n HEALTHY – There are no reputation-related issues that\n currently impact your account.

    \n
    • \n
  • \n

    \n PROBATION – We've identified potential issues with your\n Amazon SES account. We're placing your account under review while you work on\n correcting these issues.

    \n
    • \n
  • \n

    \n SHUTDOWN – Your account's ability to send email is\n currently paused because of an issue with the email sent from your account. When\n you correct the issue, you can contact us and request that your account's\n ability to send email is resumed.

    \n
    • \n
", "type": "string" }, "ProductionAccessEnabled": { "description": "

Indicates whether or not your account has production access in the current Amazon Web Services\n Region.

\n

If the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities.\n

\n

If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.

", "type": "boolean" }, "SendQuota": { "description": "

An object that contains information about the per-day and per-second sending limits\n for your Amazon SES account in the current Amazon Web Services Region.

", "$ref": "#/definitions/SendQuota" }, "SendingEnabled": { "description": "

Indicates whether or not email sending is enabled for your Amazon SES account in the\n current Amazon Web Services Region.

", "type": "boolean" }, "SuppressionAttributes": { "description": "

An object that contains information about the email address suppression preferences\n for your account in the current Amazon Web Services Region.

", "$ref": "#/definitions/SuppressionAttributes" }, "Details": { "description": "

An object that defines your account details.

", "$ref": "#/definitions/AccountDetails" }, "VdmAttributes": { "description": "

The VDM attributes that apply to your Amazon SES account.

", "$ref": "#/definitions/VdmAttributes" } }, "additionalProperties": false, "definitions": { "SendQuota": { "description": "

An object that contains information about the per-day and per-second sending limits\n for your Amazon SES account in the current Amazon Web Services Region.

", "type": "object", "properties": { "Max24HourSend": { "description": "

The maximum number of emails that you can send in the current Amazon Web Services Region over a\n 24-hour period. A value of -1 signifies an unlimited quota. (This value is also referred\n to as your sending quota.)

", "type": "integer" }, "MaxSendRate": { "description": "

The maximum number of emails that you can send per second in the current Amazon Web Services Region.\n This value is also called your maximum sending rate or your\n maximum TPS (transactions per second) rate.

", "type": "integer" }, "SentLast24Hours": { "description": "

The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the\n past 24 hours.

", "type": "integer" } }, "additionalProperties": false }, "SuppressionAttributes": { "description": "

An object that contains information about the email address suppression preferences\n for your account in the current Amazon Web Services Region.

", "type": "object", "properties": { "SuppressedReasons": { "description": "

A list that contains the reasons that email addresses will be automatically added to\n the suppression list for your account. This list can contain any or all of the\n following:

\n
    \n
  • \n

    \n COMPLAINT – Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.

    \n
    • \n
  • \n

    \n BOUNCE – Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a hard\n bounce.

    \n
    • \n
", "type": "array", "items": { "$ref": "#/definitions/SuppressionListReason" } } }, "additionalProperties": false }, "SuppressionListReason": { "enum": [ "BOUNCE", "COMPLAINT" ], "type": "string" }, "AccountDetails": { "description": "

An object that contains information about your account details.

", "type": "object", "properties": { "MailType": { "description": "

The type of email your account is sending. The mail type can be one of the\n following:

\n
    \n
  • \n

    \n MARKETING – Most of your sending traffic is to keep your\n customers informed of your latest offering.

    \n
    • \n
  • \n

    \n TRANSACTIONAL – Most of your sending traffic is to\n communicate during a transaction with a customer.

    \n
    • \n
", "enum": [ "MARKETING", "TRANSACTIONAL" ], "type": "string" }, "WebsiteURL": { "description": "

The URL of your website. This information helps us better understand the type of\n content that you plan to send.

", "type": "string" }, "ContactLanguage": { "description": "

The language you would prefer for the case. The contact language can be one of\n ENGLISH or JAPANESE.

", "enum": [ "EN", "JA" ], "type": "string" }, "UseCaseDescription": { "description": "

A description of the types of email that you plan to send.

", "type": "string" }, "AdditionalContactEmailAddresses": { "description": "

Additional email addresses where updates are sent about your account review\n process.

", "type": "array", "items": { "type": "string" } }, "ReviewDetails": { "description": "

Information about the review of the latest details you submitted.

", "$ref": "#/definitions/ReviewDetails" } }, "additionalProperties": false }, "ReviewDetails": { "description": "

An object that contains information about your account details review.

", "type": "object", "properties": { "Status": { "description": "

The status of the latest review of your account. The status can be one of the\n following:

\n
    \n
  • \n

    \n PENDING – We have received your appeal and are in the\n process of reviewing it.

    \n
    • \n
  • \n

    \n GRANTED – Your appeal has been reviewed and your production\n access has been granted.

    \n
    • \n
  • \n

    \n DENIED – Your appeal has been reviewed and your production\n access has been denied.

    \n
    • \n
  • \n

    \n FAILED – An internal error occurred and we didn't receive\n your appeal. You can submit your appeal again.

    \n
    • \n
", "enum": [ "DENIED", "FAILED", "GRANTED", "PENDING" ], "type": "string" }, "CaseId": { "description": "

The associated support center case ID (if any).

", "type": "string" } }, "additionalProperties": false }, "VdmAttributes": { "description": "

The VDM attributes that apply to your Amazon SES account.

", "type": "object", "properties": { "VdmEnabled": { "description": "

Specifies the status of your VDM configuration. Can be one of the following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables VDM for your account.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables VDM for your account.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "DashboardAttributes": { "description": "

Specifies additional settings for your VDM configuration as applicable to the\n Dashboard.

", "$ref": "#/definitions/DashboardAttributes" }, "GuardianAttributes": { "description": "

Specifies additional settings for your VDM configuration as applicable to the\n Guardian.

", "$ref": "#/definitions/GuardianAttributes" } }, "additionalProperties": false, "required": [ "VdmEnabled" ] }, "DashboardAttributes": { "description": "

An object containing additional settings for your VDM configuration as applicable to\n the Dashboard.

", "type": "object", "properties": { "EngagementMetrics": { "description": "

Specifies the status of your VDM engagement metrics collection. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables engagement metrics for your\n account.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables engagement metrics for your\n account.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED" ], "type": "string" } }, "additionalProperties": false }, "GuardianAttributes": { "description": "

An object containing additional settings for your VDM configuration as applicable to\n the Guardian.

", "type": "object", "properties": { "OptimizedSharedDelivery": { "description": "

Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables optimized shared delivery for your\n account.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables optimized shared delivery for\n your account.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED" ], "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetBlacklistReportsResponse": { "description": "

An object that contains information about blacklist events.

", "type": "object", "properties": { "BlacklistReport": { "description": "

An object that contains information about a blacklist that one of your dedicated IP\n addresses appears on.

", "$ref": "#/definitions/Record" } }, "additionalProperties": false, "required": [ "BlacklistReport" ], "definitions": { "Record": { "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetConfigurationSetResponse": { "description": "

Information about a configuration set.

", "type": "object", "properties": { "ConfigurationSetName": { "description": "

The name of the configuration set.

", "type": "string" }, "TrackingOptions": { "description": "

An object that defines the open and click tracking options for emails that you send\n using the configuration set.

", "$ref": "#/definitions/TrackingOptions" }, "DeliveryOptions": { "description": "

An object that defines the dedicated IP pool that is used to send emails that you send\n using the configuration set.

", "$ref": "#/definitions/DeliveryOptions" }, "ReputationOptions": { "description": "

An object that defines whether or not Amazon SES collects reputation metrics for the emails\n that you send that use the configuration set.

", "$ref": "#/definitions/ReputationOptions" }, "SendingOptions": { "description": "

An object that defines whether or not Amazon SES can send email that you send using the\n configuration set.

", "$ref": "#/definitions/SendingOptions" }, "Tags": { "description": "

An array of objects that define the tags (keys and values) that are associated with\n the configuration set.

", "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "SuppressionOptions": { "description": "

An object that contains information about the suppression list preferences for your\n account.

", "$ref": "#/definitions/SuppressionOptions" }, "VdmOptions": { "description": "

An object that contains information about the VDM preferences for your configuration\n set.

", "$ref": "#/definitions/VdmOptions" }, "ArchivingOptions": { "description": "

An object that defines the MailManager archive where sent emails are archived that you send\n using the configuration set.

", "$ref": "#/definitions/ArchivingOptions" } }, "additionalProperties": false, "definitions": { "TrackingOptions": { "description": "

An object that defines the tracking options for a configuration set. When you use the\n Amazon SES API v2 to send an email, it contains an invisible image that's used to track when\n recipients open your email. If your email contains links, those links are changed\n slightly in order to track when recipients click them.

\n

These images and links include references to a domain operated by Amazon Web Services. You can\n optionally configure the Amazon SES to use a domain that you operate for these images and\n links.

", "type": "object", "properties": { "CustomRedirectDomain": { "description": "

The domain to use for tracking open and click events.

", "type": "string" }, "HttpsPolicy": { "description": "

The https policy to use for tracking open and click events.

", "enum": [ "OPTIONAL", "REQUIRE", "REQUIRE_OPEN_ONLY" ], "type": "string" } }, "additionalProperties": false, "required": [ "CustomRedirectDomain" ] }, "DeliveryOptions": { "description": "

Used to associate a configuration set with a dedicated IP pool.

", "type": "object", "properties": { "TlsPolicy": { "description": "

Specifies whether messages that use the configuration set are required to use\n Transport Layer Security (TLS). If the value is Require, messages are only\n delivered if a TLS connection can be established. If the value is Optional,\n messages can be delivered in plain text if a TLS connection can't be established.

", "enum": [ "OPTIONAL", "REQUIRE" ], "type": "string" }, "SendingPoolName": { "description": "

The name of the dedicated IP pool to associate with the configuration set.

", "type": "string" }, "MaxDeliverySeconds": { "description": "

The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email.\n If specified, the value must greater than or equal to 300 seconds (5 minutes)\n and less than or equal to 50400 seconds (840 minutes).\n

", "type": "integer" } }, "additionalProperties": false }, "ReputationOptions": { "description": "

Enable or disable collection of reputation metrics for emails that you send using this\n configuration set in the current Amazon Web Services Region.

", "type": "object", "properties": { "ReputationMetricsEnabled": { "description": "

If true, tracking of reputation metrics is enabled for the configuration\n set. If false, tracking of reputation metrics is disabled for the\n configuration set.

", "type": "boolean" }, "LastFreshStart": { "description": "

The date and time (in Unix time) when the reputation metrics were last given a fresh\n start. When your account is given a fresh start, your reputation metrics are calculated\n starting from the date of the fresh start.

", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SendingOptions": { "description": "

Used to enable or disable email sending for messages that use this configuration set\n in the current Amazon Web Services Region.

", "type": "object", "properties": { "SendingEnabled": { "description": "

If true, email sending is enabled for the configuration set. If\n false, email sending is disabled for the configuration set.

", "type": "boolean" } }, "additionalProperties": false }, "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] }, "SuppressionOptions": { "description": "

An object that contains information about the suppression list preferences for your\n account.

", "type": "object", "properties": { "SuppressedReasons": { "description": "

A list that contains the reasons that email addresses are automatically added to the\n suppression list for your account. This list can contain any or all of the\n following:

\n
    \n
  • \n

    \n COMPLAINT – Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.

    \n
    • \n
  • \n

    \n BOUNCE – Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a hard\n bounce.

    \n
    • \n
", "type": "array", "items": { "$ref": "#/definitions/SuppressionListReason" } } }, "additionalProperties": false }, "SuppressionListReason": { "enum": [ "BOUNCE", "COMPLAINT" ], "type": "string" }, "VdmOptions": { "description": "

An object that defines the VDM settings that apply to emails that you send using the\n configuration set.

", "type": "object", "properties": { "DashboardOptions": { "description": "

Specifies additional settings for your VDM configuration as applicable to the\n Dashboard.

", "$ref": "#/definitions/DashboardOptions" }, "GuardianOptions": { "description": "

Specifies additional settings for your VDM configuration as applicable to the\n Guardian.

", "$ref": "#/definitions/GuardianOptions" } }, "additionalProperties": false }, "DashboardOptions": { "description": "

An object containing additional settings for your VDM configuration as applicable to\n the Dashboard.

", "type": "object", "properties": { "EngagementMetrics": { "description": "

Specifies the status of your VDM engagement metrics collection. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables engagement metrics for the\n configuration set.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables engagement metrics for the\n configuration set.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED" ], "type": "string" } }, "additionalProperties": false }, "GuardianOptions": { "description": "

An object containing additional settings for your VDM configuration as applicable to\n the Guardian.

", "type": "object", "properties": { "OptimizedSharedDelivery": { "description": "

Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables optimized shared delivery for the\n configuration set.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables optimized shared delivery for the\n configuration set.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED" ], "type": "string" } }, "additionalProperties": false }, "ArchivingOptions": { "description": "

Used to associate a configuration set with a MailManager archive.

", "type": "object", "properties": { "ArchiveArn": { "description": "

The Amazon Resource Name (ARN) of the MailManager archive where the Amazon SES API v2 will archive sent\n emails.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetConfigurationSetEventDestinationsResponse": { "description": "

Information about an event destination for a configuration set.

", "type": "object", "properties": { "EventDestinations": { "description": "

An array that includes all of the events destinations that have been configured for\n the configuration set.

", "type": "array", "items": { "$ref": "#/definitions/EventDestination" } } }, "additionalProperties": false, "definitions": { "EventDestination": { "description": "

In the Amazon SES API v2, events include message sends, deliveries, opens,\n clicks, bounces, complaints and delivery delays. Event destinations\n are places that you can send information about these events to. For example, you can\n send event data to Amazon SNS to receive notifications when you receive bounces or\n complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

", "type": "object", "properties": { "Name": { "description": "

A name that identifies the event destination.

", "type": "string" }, "Enabled": { "description": "

If true, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition.

\n

If false, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.

", "type": "boolean" }, "MatchingEventTypes": { "description": "

The types of events that Amazon SES sends to the specified event destinations.

\n
    \n
  • \n

    \n SEND - The send request was successful and SES will\n attempt to deliver the message to the recipient’s mail server. (If account-level\n or global suppression is being used, SES will still count it as a send,\n but delivery is suppressed.)

    \n
    • \n
  • \n

    \n REJECT - SES accepted the email, but determined that it\n contained a virus and didn’t attempt to deliver it to the recipient’s mail\n server.

    \n
    • \n
  • \n

    \n BOUNCE - (Hard bounce) The recipient's\n mail server permanently rejected the email. (Soft bounces\n are only included when SES fails to deliver the email after retrying for\n a period of time.)

    \n
    • \n
  • \n

    \n COMPLAINT - The email was successfully delivered to the\n recipient’s mail server, but the recipient marked it as spam.

    \n
    • \n
  • \n

    \n DELIVERY - SES successfully delivered the email to the\n recipient's mail server.

    \n
    • \n
  • \n

    \n OPEN - The recipient received the message and opened it in their\n email client.

    \n
    • \n
  • \n

    \n CLICK - The recipient clicked one or more links in the\n email.

    \n
    • \n
  • \n

    \n RENDERING_FAILURE - The email wasn't sent because of a\n template rendering issue. This event type can occur when template data is\n missing, or when there is a mismatch between template parameters and data. (This\n event type only occurs when you send email using the \n SendEmail\n or \n SendBulkEmail\n API operations.)

    \n
    • \n
  • \n

    \n DELIVERY_DELAY - The email couldn't be delivered to the\n recipient’s mail server because a temporary issue occurred. Delivery delays can\n occur, for example, when the recipient's inbox is full, or when the\n receiving email server experiences a transient issue.

    \n
    • \n
  • \n

    \n SUBSCRIPTION - The email was successfully delivered, but the\n recipient updated their subscription preferences by clicking on an\n unsubscribe link as part of your subscription\n management.

    \n
    • \n
", "type": "array", "items": { "$ref": "#/definitions/EventType" } }, "KinesisFirehoseDestination": { "description": "

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

", "$ref": "#/definitions/KinesisFirehoseDestination" }, "CloudWatchDestination": { "description": "

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.

", "$ref": "#/definitions/CloudWatchDestination" }, "SnsDestination": { "description": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notifications when certain email events occur.

", "$ref": "#/definitions/SnsDestination" }, "EventBridgeDestination": { "description": "

An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to\n send notifications when certain email events occur.

", "$ref": "#/definitions/EventBridgeDestination" }, "PinpointDestination": { "description": "

An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see Transactional\n Messaging Charts in the Amazon Pinpoint User Guide.

", "$ref": "#/definitions/PinpointDestination" } }, "additionalProperties": false, "required": [ "MatchingEventTypes", "Name" ] }, "EventType": { "enum": [ "BOUNCE", "CLICK", "COMPLAINT", "DELIVERY", "DELIVERY_DELAY", "OPEN", "REJECT", "RENDERING_FAILURE", "SEND", "SUBSCRIPTION" ], "type": "string" }, "KinesisFirehoseDestination": { "description": "

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

", "type": "object", "properties": { "IamRoleArn": { "description": "

The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email\n events to the Amazon Kinesis Data Firehose stream.

", "type": "string" }, "DeliveryStreamArn": { "description": "

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email\n events to.

", "type": "string" } }, "additionalProperties": false, "required": [ "DeliveryStreamArn", "IamRoleArn" ] }, "CloudWatchDestination": { "description": "

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.

", "type": "object", "properties": { "DimensionConfigurations": { "description": "

An array of objects that define the dimensions to use when you send email events to\n Amazon CloudWatch.

", "type": "array", "items": { "$ref": "#/definitions/CloudWatchDimensionConfiguration" } } }, "additionalProperties": false, "required": [ "DimensionConfigurations" ] }, "CloudWatchDimensionConfiguration": { "description": "

An object that defines the dimension configuration to use when you send email events\n to Amazon CloudWatch.

", "type": "object", "properties": { "DimensionName": { "description": "

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to\n meet the following criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "type": "string" }, "DimensionValueSource": { "description": "

The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To\n use the message tags that you specify using an X-SES-MESSAGE-TAGS header or\n a parameter to the SendEmail or SendRawEmail API, choose\n messageTag. To use your own email headers, choose\n emailHeader. To use link tags, choose linkTags.

", "enum": [ "EMAIL_HEADER", "LINK_TAG", "MESSAGE_TAG" ], "type": "string" }, "DefaultDimensionValue": { "description": "

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the\n value of the dimension when you send an email. This value has to meet the following\n criteria:

\n
    \n
  • \n

    Can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-), at signs (@), and periods (.).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "type": "string" } }, "additionalProperties": false, "required": [ "DefaultDimensionValue", "DimensionName", "DimensionValueSource" ] }, "SnsDestination": { "description": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notifications when certain email events occur.

", "type": "object", "properties": { "TopicArn": { "description": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For\n more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

", "type": "string" } }, "additionalProperties": false, "required": [ "TopicArn" ] }, "EventBridgeDestination": { "description": "

An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to\n send notifications when certain email events occur.

", "type": "object", "properties": { "EventBusArn": { "description": "

The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.

", "type": "string" } }, "additionalProperties": false, "required": [ "EventBusArn" ] }, "PinpointDestination": { "description": "

An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see Transactional\n Messaging Charts in the Amazon Pinpoint User Guide.

", "type": "object", "properties": { "ApplicationArn": { "description": "

The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetContactResponse": { "type": "object", "properties": { "ContactListName": { "description": "

The name of the contact list to which the contact belongs.

", "type": "string" }, "EmailAddress": { "description": "

The contact's email address.

", "type": "string" }, "TopicPreferences": { "description": "

The contact's preference for being opted-in to or opted-out of a topic.>

", "type": "array", "items": { "$ref": "#/definitions/TopicPreference" } }, "TopicDefaultPreferences": { "description": "

The default topic preferences applied to the contact.

", "type": "array", "items": { "$ref": "#/definitions/TopicPreference" } }, "UnsubscribeAll": { "description": "

A boolean value status noting if the contact is unsubscribed from all contact list\n topics.

", "type": "boolean" }, "AttributesData": { "description": "

The attribute data attached to a contact.

", "type": "string" }, "CreatedTimestamp": { "description": "

A timestamp noting when the contact was created.

", "type": "string", "format": "date-time" }, "LastUpdatedTimestamp": { "description": "

A timestamp noting the last time the contact's information was updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false, "definitions": { "TopicPreference": { "description": "

The contact's preference for being opted-in to or opted-out of a topic.

", "type": "object", "properties": { "TopicName": { "description": "

The name of the topic.

", "type": "string" }, "SubscriptionStatus": { "description": "

The contact's subscription status to a topic which is either OPT_IN or\n OPT_OUT.

", "enum": [ "OPT_IN", "OPT_OUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "SubscriptionStatus", "TopicName" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetContactListResponse": { "type": "object", "properties": { "ContactListName": { "description": "

The name of the contact list.

", "type": "string" }, "Topics": { "description": "

An interest group, theme, or label within a list. A contact list can have multiple\n topics.

", "type": "array", "items": { "$ref": "#/definitions/Topic" } }, "Description": { "description": "

A description of what the contact list is about.

", "type": "string" }, "CreatedTimestamp": { "description": "

A timestamp noting when the contact list was created.

", "type": "string", "format": "date-time" }, "LastUpdatedTimestamp": { "description": "

A timestamp noting the last time the contact list was updated.

", "type": "string", "format": "date-time" }, "Tags": { "description": "

The tags associated with a contact list.

", "type": "array", "items": { "$ref": "#/definitions/Tag" } } }, "additionalProperties": false, "definitions": { "Topic": { "description": "

An interest group, theme, or label within a list. Lists can have multiple\n topics.

", "type": "object", "properties": { "TopicName": { "description": "

The name of the topic.

", "type": "string" }, "DisplayName": { "description": "

The name of the topic the contact will see.

", "type": "string" }, "Description": { "description": "

A description of what the topic is about, which the contact will see.

", "type": "string" }, "DefaultSubscriptionStatus": { "description": "

The default subscription status to be applied to a contact if the contact has not\n noted their preference for subscribing to a topic.

", "enum": [ "OPT_IN", "OPT_OUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "DefaultSubscriptionStatus", "DisplayName", "TopicName" ] }, "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetCustomVerificationEmailTemplateResponse": { "description": "

The following elements are returned by the service.

", "type": "object", "properties": { "TemplateName": { "description": "

The name of the custom verification email template.

", "type": "string" }, "FromEmailAddress": { "description": "

The email address that the custom verification email is sent from.

", "type": "string" }, "TemplateSubject": { "description": "

The subject line of the custom verification email.

", "type": "string" }, "TemplateContent": { "description": "

The content of the custom verification email.

", "type": "string" }, "SuccessRedirectionURL": { "description": "

The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

", "type": "string" }, "FailureRedirectionURL": { "description": "

The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDedicatedIpResponse": { "description": "

Information about a dedicated IP address.

", "type": "object", "properties": { "DedicatedIp": { "description": "

An object that contains information about a dedicated IP address.

", "$ref": "#/definitions/DedicatedIp" } }, "additionalProperties": false, "definitions": { "DedicatedIp": { "description": "

Contains information about a dedicated IP address that is associated with your Amazon SES\n account.

\n

To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing\n Dedicated IP Addresses in the Amazon SES Developer\n Guide.

", "type": "object", "properties": { "Ip": { "description": "

An IPv4 address.

", "type": "string" }, "WarmupStatus": { "description": "

The warm-up status of a dedicated IP address. The status can have one of the following\n values:

\n
    \n
  • \n

    \n IN_PROGRESS – The IP address isn't ready to use because the\n dedicated IP warm-up process is ongoing.

    \n
    • \n
  • \n

    \n DONE – The dedicated IP warm-up process is complete, and\n the IP address is ready to use.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE – The warm-up status doesn't apply to this IP address.\n This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically\n handles the warm-up process.

    \n
    • \n
", "enum": [ "DONE", "IN_PROGRESS", "NOT_APPLICABLE" ], "type": "string" }, "WarmupPercentage": { "description": "

Indicates the progress of your dedicated IP warm-up:

\n
    \n
  • \n

    \n 0-100 – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.

    \n
    • \n
  • \n

    \n -1 – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.

    \n
    • \n
", "type": "integer" }, "PoolName": { "description": "

The name of the dedicated IP pool that the IP address is associated with.

", "type": "string" } }, "additionalProperties": false, "required": [ "Ip", "WarmupPercentage", "WarmupStatus" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDedicatedIpPoolResponse": { "description": "

The following element is returned by the service.

", "type": "object", "properties": { "DedicatedIpPool": { "description": "

An object that contains information about a dedicated IP pool.

", "$ref": "#/definitions/DedicatedIpPool" } }, "additionalProperties": false, "definitions": { "DedicatedIpPool": { "description": "

Contains information about a dedicated IP pool.

", "type": "object", "properties": { "PoolName": { "description": "

The name of the dedicated IP pool.

", "type": "string" }, "ScalingMode": { "description": "

The type of the dedicated IP pool.

\n
    \n
  • \n

    \n STANDARD – A dedicated IP pool where you can\n control which IPs are part of the pool.

    \n
    • \n
  • \n

    \n MANAGED – A dedicated IP pool where the reputation and\n number of IPs are automatically managed by Amazon SES.

    \n
    • \n
", "enum": [ "MANAGED", "STANDARD" ], "type": "string" } }, "additionalProperties": false, "required": [ "PoolName", "ScalingMode" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDedicatedIpsResponse": { "description": "

Information about the dedicated IP addresses that are associated with your Amazon Web Services\n account.

", "type": "object", "properties": { "DedicatedIps": { "description": "

A list of dedicated IP addresses that are associated with your Amazon Web Services account.

", "type": "array", "items": { "$ref": "#/definitions/DedicatedIp" } }, "NextToken": { "description": "

A token that indicates that there are additional dedicated IP addresses to list. To\n view additional addresses, issue another request to GetDedicatedIps,\n passing this token in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "DedicatedIp": { "description": "

Contains information about a dedicated IP address that is associated with your Amazon SES\n account.

\n

To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing\n Dedicated IP Addresses in the Amazon SES Developer\n Guide.

", "type": "object", "properties": { "Ip": { "description": "

An IPv4 address.

", "type": "string" }, "WarmupStatus": { "description": "

The warm-up status of a dedicated IP address. The status can have one of the following\n values:

\n
    \n
  • \n

    \n IN_PROGRESS – The IP address isn't ready to use because the\n dedicated IP warm-up process is ongoing.

    \n
    • \n
  • \n

    \n DONE – The dedicated IP warm-up process is complete, and\n the IP address is ready to use.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE – The warm-up status doesn't apply to this IP address.\n This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically\n handles the warm-up process.

    \n
    • \n
", "enum": [ "DONE", "IN_PROGRESS", "NOT_APPLICABLE" ], "type": "string" }, "WarmupPercentage": { "description": "

Indicates the progress of your dedicated IP warm-up:

\n
    \n
  • \n

    \n 0-100 – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.

    \n
    • \n
  • \n

    \n -1 – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.

    \n
    • \n
", "type": "integer" }, "PoolName": { "description": "

The name of the dedicated IP pool that the IP address is associated with.

", "type": "string" } }, "additionalProperties": false, "required": [ "Ip", "WarmupPercentage", "WarmupStatus" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDeliverabilityDashboardOptionsResponse": { "description": "

An object that shows the status of the Deliverability dashboard.

", "type": "object", "properties": { "DashboardEnabled": { "description": "

Specifies whether the Deliverability dashboard is enabled. If this value is true,\n the dashboard is enabled.

", "type": "boolean" }, "SubscriptionExpiryDate": { "description": "

The date when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isn’t\n due to expire at the end of the month.

", "type": "string", "format": "date-time" }, "AccountStatus": { "description": "

The current status of your Deliverability dashboard subscription. If this value is\n PENDING_EXPIRATION, your subscription is scheduled to expire at the end\n of the current calendar month.

", "enum": [ "ACTIVE", "DISABLED", "PENDING_EXPIRATION" ], "type": "string" }, "ActiveSubscribedDomains": { "description": "

An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at\n the end of the current calendar month.

", "type": "array", "items": { "$ref": "#/definitions/DomainDeliverabilityTrackingOption" } }, "PendingExpirationSubscribedDomains": { "description": "

An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that's scheduled to expire at the\n end of the current calendar month.

", "type": "array", "items": { "$ref": "#/definitions/DomainDeliverabilityTrackingOption" } } }, "additionalProperties": false, "required": [ "DashboardEnabled" ], "definitions": { "DomainDeliverabilityTrackingOption": { "description": "

An object that contains information about the Deliverability dashboard subscription for a\n verified domain that you use to send email and currently has an active Deliverability dashboard\n subscription. If a Deliverability dashboard subscription is active for a domain, you gain access\n to reputation, inbox placement, and other metrics for the domain.

", "type": "object", "properties": { "Domain": { "description": "

A verified domain that’s associated with your Amazon Web Services account and currently has an\n active Deliverability dashboard subscription.

", "type": "string" }, "SubscriptionStartDate": { "description": "

The date when you enabled the Deliverability dashboard for the\n domain.

", "type": "string", "format": "date-time" }, "InboxPlacementTrackingOption": { "description": "

An object that contains information about the inbox placement data settings for the\n domain.

", "$ref": "#/definitions/InboxPlacementTrackingOption" } }, "additionalProperties": false }, "InboxPlacementTrackingOption": { "description": "

An object that contains information about the inbox placement data settings for a\n verified domain that’s associated with your Amazon Web Services account. This data is available only\n if you enabled the Deliverability dashboard for the domain.

", "type": "object", "properties": { "Global": { "description": "

Specifies whether inbox placement data is being tracked for the domain.

", "type": "boolean" }, "TrackedIsps": { "description": "

An array of strings, one for each major email provider that the inbox placement data\n applies to.

", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDeliverabilityTestReportResponse": { "description": "

The results of the predictive inbox placement test.

", "type": "object", "properties": { "DeliverabilityTestReport": { "description": "

An object that contains the results of the predictive inbox placement test.

", "$ref": "#/definitions/DeliverabilityTestReport" }, "OverallPlacement": { "description": "

An object that specifies how many test messages that were sent during the predictive inbox placement test were\n delivered to recipients' inboxes, how many were sent to recipients' spam folders, and\n how many weren't delivered.

", "$ref": "#/definitions/PlacementStatistics" }, "IspPlacements": { "description": "

An object that describes how the test email was handled by several email providers,\n including Gmail, Hotmail, Yahoo, AOL, and others.

", "type": "array", "items": { "$ref": "#/definitions/IspPlacement" } }, "Message": { "description": "

An object that contains the message that you sent when you performed this\n predictive inbox placement test.

", "type": "string" }, "Tags": { "description": "

An array of objects that define the tags (keys and values) that are associated with\n the predictive inbox placement test.

", "type": "array", "items": { "$ref": "#/definitions/Tag" } } }, "additionalProperties": false, "required": [ "DeliverabilityTestReport", "IspPlacements", "OverallPlacement" ], "definitions": { "DeliverabilityTestReport": { "description": "

An object that contains metadata related to a predictive inbox placement test.

", "type": "object", "properties": { "ReportId": { "description": "

A unique string that identifies the predictive inbox placement test.

", "type": "string" }, "ReportName": { "description": "

A name that helps you identify a predictive inbox placement test report.

", "type": "string" }, "Subject": { "description": "

The subject line for an email that you submitted in a predictive inbox placement test.

", "type": "string" }, "FromEmailAddress": { "description": "

The sender address that you specified for the predictive inbox placement test.

", "type": "string" }, "CreateDate": { "description": "

The date and time when the predictive inbox placement test was created.

", "type": "string", "format": "date-time" }, "DeliverabilityTestStatus": { "description": "

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

", "enum": [ "COMPLETED", "IN_PROGRESS" ], "type": "string" } }, "additionalProperties": false }, "PlacementStatistics": { "description": "

An object that contains inbox placement data for an email provider.

", "type": "object", "properties": { "InboxPercentage": { "description": "

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

", "type": "integer" }, "SpamPercentage": { "description": "

The percentage of emails that arrived in recipients' spam or junk mail folders during\n the predictive inbox placement test.

", "type": "integer" }, "MissingPercentage": { "description": "

The percentage of emails that didn't arrive in recipients' inboxes at all during the\n predictive inbox placement test.

", "type": "integer" }, "SpfPercentage": { "description": "

The percentage of emails that were authenticated by using Sender Policy Framework\n (SPF) during the predictive inbox placement test.

", "type": "integer" }, "DkimPercentage": { "description": "

The percentage of emails that were authenticated by using DomainKeys Identified Mail\n (DKIM) during the predictive inbox placement test.

", "type": "integer" } }, "additionalProperties": false }, "IspPlacement": { "description": "

An object that describes how email sent during the predictive inbox placement test was handled by a certain\n email provider.

", "type": "object", "properties": { "IspName": { "description": "

The name of the email provider that the inbox placement data applies to.

", "type": "string" }, "PlacementStatistics": { "description": "

An object that contains inbox placement metrics for a specific email provider.

", "$ref": "#/definitions/PlacementStatistics" } }, "additionalProperties": false }, "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDomainDeliverabilityCampaignResponse": { "description": "

An object that contains all the deliverability data for a specific campaign. This data\n is available for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for.

", "type": "object", "properties": { "DomainDeliverabilityCampaign": { "description": "

An object that contains the deliverability data for the campaign.

", "$ref": "#/definitions/DomainDeliverabilityCampaign" } }, "additionalProperties": false, "required": [ "DomainDeliverabilityCampaign" ], "definitions": { "DomainDeliverabilityCampaign": { "description": "

An object that contains the deliverability data for a specific campaign. This data is\n available for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption\n operation).

", "type": "object", "properties": { "CampaignId": { "description": "

The unique identifier for the campaign. The Deliverability dashboard automatically generates\n and assigns this identifier to a campaign.

", "type": "string" }, "ImageUrl": { "description": "

The URL of an image that contains a snapshot of the email message that was\n sent.

", "type": "string" }, "Subject": { "description": "

The subject line, or title, of the email message.

", "type": "string" }, "FromAddress": { "description": "

The verified email address that the email message was sent from.

", "type": "string" }, "SendingIps": { "description": "

The IP addresses that were used to send the email message.

", "type": "array", "items": { "type": "string" } }, "FirstSeenDateTime": { "description": "

The first time when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

", "type": "string", "format": "date-time" }, "LastSeenDateTime": { "description": "

The last time when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

", "type": "string", "format": "date-time" }, "InboxCount": { "description": "

The number of email messages that were delivered to recipients’ inboxes.

", "type": "integer" }, "SpamCount": { "description": "

The number of email messages that were delivered to recipients' spam or junk mail\n folders.

", "type": "integer" }, "ReadRate": { "description": "

The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.

", "type": "integer" }, "DeleteRate": { "description": "

The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.

", "type": "integer" }, "ReadDeleteRate": { "description": "

The percentage of email messages that were opened and then deleted by recipients. Due\n to technical limitations, this value only includes recipients who opened the message by\n using an email client that supports images.

", "type": "integer" }, "ProjectedVolume": { "description": "

The projected number of recipients that the email message was sent to.

", "type": "integer" }, "Esps": { "description": "

The major email providers who handled the email message.

", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDomainStatisticsReportResponse": { "description": "

An object that includes statistics that are related to the domain that you\n specified.

", "type": "object", "properties": { "OverallVolume": { "description": "

An object that contains deliverability metrics for the domain that you specified. The\n data in this object is a summary of all of the data that was collected from the\n StartDate to the EndDate.

", "$ref": "#/definitions/OverallVolume" }, "DailyVolumes": { "description": "

An object that contains deliverability metrics for the domain that you specified. This\n object contains data for each day, starting on the StartDate and ending on\n the EndDate.

", "type": "array", "items": { "$ref": "#/definitions/DailyVolume" } } }, "additionalProperties": false, "required": [ "DailyVolumes", "OverallVolume" ], "definitions": { "OverallVolume": { "description": "

An object that contains information about email that was sent from the selected\n domain.

", "type": "object", "properties": { "VolumeStatistics": { "description": "

An object that contains information about the numbers of messages that arrived in\n recipients' inboxes and junk mail folders.

", "$ref": "#/definitions/VolumeStatistics" }, "ReadRatePercent": { "description": "

The percentage of emails that were sent from the domain that were read by their\n recipients.

", "type": "integer" }, "DomainIspPlacements": { "description": "

An object that contains inbox and junk mail placement metrics for individual email\n providers.

", "type": "array", "items": { "$ref": "#/definitions/DomainIspPlacement" } } }, "additionalProperties": false }, "VolumeStatistics": { "description": "

An object that contains information about the amount of email that was delivered to\n recipients.

", "type": "object", "properties": { "InboxRawCount": { "description": "

The total number of emails that arrived in recipients' inboxes.

", "type": "integer" }, "SpamRawCount": { "description": "

The total number of emails that arrived in recipients' spam or junk mail\n folders.

", "type": "integer" }, "ProjectedInbox": { "description": "

An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' inboxes.

", "type": "integer" }, "ProjectedSpam": { "description": "

An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' spam or junk mail folders.

", "type": "integer" } }, "additionalProperties": false }, "DomainIspPlacement": { "description": "

An object that contains inbox placement data for email sent from one of your email\n domains to a specific email provider.

", "type": "object", "properties": { "IspName": { "description": "

The name of the email provider that the inbox placement data applies to.

", "type": "string" }, "InboxRawCount": { "description": "

The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

", "type": "integer" }, "SpamRawCount": { "description": "

The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

", "type": "integer" }, "InboxPercentage": { "description": "

The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

", "type": "integer" }, "SpamPercentage": { "description": "

The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

", "type": "integer" } }, "additionalProperties": false }, "DailyVolume": { "description": "

An object that contains information about the volume of email sent on each day of the\n analysis period.

", "type": "object", "properties": { "StartDate": { "description": "

The date that the DailyVolume metrics apply to, in Unix time.

", "type": "string", "format": "date-time" }, "VolumeStatistics": { "description": "

An object that contains inbox placement metrics for a specific day in the analysis\n period.

", "$ref": "#/definitions/VolumeStatistics" }, "DomainIspPlacements": { "description": "

An object that contains inbox placement metrics for a specified day in the analysis\n period, broken out by the recipient's email provider.

", "type": "array", "items": { "$ref": "#/definitions/DomainIspPlacement" } } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetEmailIdentityResponse": { "description": "

Details about an email identity.

", "type": "object", "properties": { "IdentityType": { "description": "

The email identity type. Note: the MANAGED_DOMAIN identity type is not\n supported.

", "enum": [ "DOMAIN", "EMAIL_ADDRESS", "MANAGED_DOMAIN" ], "type": "string" }, "FeedbackForwardingStatus": { "description": "

The feedback forwarding configuration for the identity.

\n

If the value is true, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the Return-Path header of the original email.

\n

You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).

", "type": "boolean" }, "VerifiedForSendingStatus": { "description": "

Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.

", "type": "boolean" }, "DkimAttributes": { "description": "

An object that contains information about the DKIM attributes for the identity.

", "$ref": "#/definitions/DkimAttributes" }, "MailFromAttributes": { "description": "

An object that contains information about the Mail-From attributes for the email\n identity.

", "$ref": "#/definitions/MailFromAttributes" }, "Policies": { "description": "

A map of policy names to policies.

", "$ref": "#/definitions/Record" }, "Tags": { "description": "

An array of objects that define the tags (keys and values) that are associated with\n the email identity.

", "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "ConfigurationSetName": { "description": "

The configuration set used by default when sending from this identity.

", "type": "string" }, "VerificationStatus": { "description": "

The verification status of the identity. The status can be one of the following:

\n
    \n
  • \n

    \n PENDING – The verification process was initiated, but Amazon SES\n hasn't yet been able to verify the identity.

    \n
    • \n
  • \n

    \n SUCCESS – The verification process completed\n successfully.

    \n
    • \n
  • \n

    \n FAILED – The verification process failed.

    \n
    • \n
  • \n

    \n TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES\n from determining the verification status of the identity.

    \n
    • \n
  • \n

    \n NOT_STARTED – The verification process hasn't been\n initiated for the identity.

    \n
    • \n
", "enum": [ "FAILED", "NOT_STARTED", "PENDING", "SUCCESS", "TEMPORARY_FAILURE" ], "type": "string" }, "VerificationInfo": { "description": "

An object that contains additional information about the verification status for the\n identity.

", "$ref": "#/definitions/VerificationInfo" } }, "additionalProperties": false, "definitions": { "DkimAttributes": { "description": "

An object that contains information about the DKIM authentication status for an email\n identity.

\n

Amazon SES determines the authentication status by searching for specific records in the\n DNS configuration for the domain. If you used Easy DKIM to set up DKIM\n authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration\n for your domain. If you provided a public key to perform DKIM authentication, Amazon SES\n tries to find a TXT record that uses the selector that you specified. The value of the\n TXT record must be a public key that's paired with the private key that you specified in\n the process of creating the identity

", "type": "object", "properties": { "SigningEnabled": { "description": "

If the value is true, then the messages that you send from the identity\n are signed using DKIM. If the value is false, then the messages that you\n send from the identity aren't DKIM-signed.

", "type": "boolean" }, "Status": { "description": "

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS\n records for the domain. The status can be one of the following:

\n
    \n
  • \n

    \n PENDING – The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.

    \n
    • \n
  • \n

    \n SUCCESS – The verification process completed\n successfully.

    \n
    • \n
  • \n

    \n FAILED – The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.

    \n
    • \n
  • \n

    \n TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.

    \n
    • \n
  • \n

    \n NOT_STARTED – The DKIM verification process hasn't been\n initiated for the domain.

    \n
    • \n
", "enum": [ "FAILED", "NOT_STARTED", "PENDING", "SUCCESS", "TEMPORARY_FAILURE" ], "type": "string" }, "Tokens": { "description": "

If you used Easy DKIM to configure DKIM authentication for the domain, then this object\n contains a set of unique strings that you use to create a set of CNAME records that you\n add to the DNS configuration for your domain. When Amazon SES detects these records in the\n DNS configuration for your domain, the DKIM authentication process is complete.

\n

If you configured DKIM authentication for the domain by providing your own\n public-private key pair, then this object contains the selector for the public\n key.

\n

Regardless of the DKIM authentication method you use, Amazon SES searches for the\n appropriate records in the DNS configuration of the domain for up to 72 hours.

", "type": "array", "items": { "type": "string" } }, "SigningAttributesOrigin": { "description": "

A string that indicates how DKIM was configured for the identity. These are the\n possible values:

\n
    \n
  • \n

    \n AWS_SES – Indicates that DKIM was configured for the\n identity by using Easy DKIM.

    \n
    • \n
  • \n

    \n EXTERNAL – Indicates that DKIM was configured for the\n identity by using Bring Your Own DKIM (BYODKIM).

    \n
    • \n
  • \n

    \n AWS_SES_AF_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_NORTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTH_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_WEST_3 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_WEST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_WEST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_NORTHEAST_3 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_NORTHEAST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_ME_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_ME_SOUTH_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_NORTHEAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_IL_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_SA_EAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_CA_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTHEAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTHEAST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_AP_SOUTHEAST_3 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_CENTRAL_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_EU_CENTRAL_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_EAST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_EAST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_WEST_1 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US West (N. California) region using Deterministic Easy-DKIM\n (DEED).\n

    \n
    • \n
  • \n

    \n AWS_SES_US_WEST_2 – Indicates that DKIM was configured for the identity by\n replicating signing attributes from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED).\n

    \n
    • \n
", "enum": [ "AWS_SES", "AWS_SES_AF_SOUTH_1", "AWS_SES_AP_NORTHEAST_1", "AWS_SES_AP_NORTHEAST_2", "AWS_SES_AP_NORTHEAST_3", "AWS_SES_AP_SOUTHEAST_1", "AWS_SES_AP_SOUTHEAST_2", "AWS_SES_AP_SOUTHEAST_3", "AWS_SES_AP_SOUTH_1", "AWS_SES_AP_SOUTH_2", "AWS_SES_CA_CENTRAL_1", "AWS_SES_EU_CENTRAL_1", "AWS_SES_EU_CENTRAL_2", "AWS_SES_EU_NORTH_1", "AWS_SES_EU_SOUTH_1", "AWS_SES_EU_WEST_1", "AWS_SES_EU_WEST_2", "AWS_SES_EU_WEST_3", "AWS_SES_IL_CENTRAL_1", "AWS_SES_ME_CENTRAL_1", "AWS_SES_ME_SOUTH_1", "AWS_SES_SA_EAST_1", "AWS_SES_US_EAST_1", "AWS_SES_US_EAST_2", "AWS_SES_US_WEST_1", "AWS_SES_US_WEST_2", "EXTERNAL" ], "type": "string" }, "NextSigningKeyLength": { "description": "

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be\n changed at most once per day.

", "enum": [ "RSA_1024_BIT", "RSA_2048_BIT" ], "type": "string" }, "CurrentSigningKeyLength": { "description": "

[Easy DKIM] The key length of the DKIM key pair in use.

", "enum": [ "RSA_1024_BIT", "RSA_2048_BIT" ], "type": "string" }, "LastKeyGenerationTimestamp": { "description": "

[Easy DKIM] The last time a key pair was generated for this identity.

", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MailFromAttributes": { "description": "

A list of attributes that are associated with a MAIL FROM domain.

", "type": "object", "properties": { "MailFromDomain": { "description": "

The name of a domain that an email identity uses as a custom MAIL FROM domain.

", "type": "string" }, "MailFromDomainStatus": { "description": "

The status of the MAIL FROM domain. This status can have the following values:

\n
    \n
  • \n

    \n PENDING – Amazon SES hasn't started searching for the MX record\n yet.

    \n
    • \n
  • \n

    \n SUCCESS – Amazon SES detected the required MX record for the\n MAIL FROM domain.

    \n
    • \n
  • \n

    \n FAILED – Amazon SES can't find the required MX record, or the\n record no longer exists.

    \n
    • \n
  • \n

    \n TEMPORARY_FAILURE – A temporary issue occurred, which\n prevented Amazon SES from determining the status of the MAIL FROM domain.

    \n
    • \n
", "enum": [ "FAILED", "PENDING", "SUCCESS", "TEMPORARY_FAILURE" ], "type": "string" }, "BehaviorOnMxFailure": { "description": "

The action to take if the required MX record can't be found when you send an email.\n When you set this value to USE_DEFAULT_VALUE, the mail is sent using\n amazonses.com as the MAIL FROM domain. When you set this value\n to REJECT_MESSAGE, the Amazon SES API v2 returns a\n MailFromDomainNotVerified error, and doesn't attempt to deliver the\n email.

\n

These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending, Failed, and TemporaryFailure\n states.

", "enum": [ "REJECT_MESSAGE", "USE_DEFAULT_VALUE" ], "type": "string" } }, "additionalProperties": false, "required": [ "BehaviorOnMxFailure", "MailFromDomain", "MailFromDomainStatus" ] }, "Record": { "type": "object", "additionalProperties": false }, "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] }, "VerificationInfo": { "description": "

An object that contains additional information about the verification status for the\n identity.

", "type": "object", "properties": { "LastCheckedTimestamp": { "description": "

The last time a verification attempt was made for this identity.

", "type": "string", "format": "date-time" }, "LastSuccessTimestamp": { "description": "

The last time a successful verification was made for this identity.

", "type": "string", "format": "date-time" }, "ErrorType": { "description": "

Provides the reason for the failure describing why Amazon SES was not able to successfully\n verify the identity. Below are the possible values:

\n
    \n
  • \n

    \n INVALID_VALUE – Amazon SES was able to find the record, but the\n value contained within the record was invalid. Ensure you have published the\n correct values for the record.

    \n
    • \n
  • \n

    \n TYPE_NOT_FOUND – The queried hostname exists but does not\n have the requested type of DNS record. Ensure that you have published the\n correct type of DNS record.

    \n
    • \n
  • \n

    \n HOST_NOT_FOUND – The queried hostname does not exist or was\n not reachable at the time of the request. Ensure that you have published the\n required DNS record(s).

    \n
    • \n
  • \n

    \n SERVICE_ERROR – A temporary issue is preventing Amazon SES from\n determining the verification status of the domain.

    \n
    • \n
  • \n

    \n DNS_SERVER_ERROR – The DNS server encountered an issue and\n was unable to complete the request.

    \n
    • \n
  • \n

    \n REPLICATION_ACCESS_DENIED – The verification failed because the user does not\n have the required permissions to replicate the DKIM key from the primary region. Ensure you have the\n necessary permissions in both primary and replica regions.\n

    \n
    • \n
  • \n

    \n REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding\n identity was found in the specified primary region. Ensure the identity exists in the primary region\n before attempting replication.\n

    \n
    • \n
  • \n

    \n REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the\n identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key\n replication is only supported for identities using Easy DKIM.\n

    \n
    • \n
  • \n

    \n REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because\n the specified primary identity is a replica of another identity, and multi-level replication is not\n supported; the primary identity must be a non-replica identity.\n

    \n
    • \n
  • \n

    \n REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid\n primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different\n from the replica region.\n

    \n
    • \n
", "enum": [ "DNS_SERVER_ERROR", "HOST_NOT_FOUND", "INVALID_VALUE", "REPLICATION_ACCESS_DENIED", "REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED", "REPLICATION_PRIMARY_INVALID_REGION", "REPLICATION_PRIMARY_NOT_FOUND", "REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED", "SERVICE_ERROR", "TYPE_NOT_FOUND" ], "type": "string" }, "SOARecord": { "description": "

An object that contains information about the start of authority (SOA) record\n associated with the identity.

", "$ref": "#/definitions/SOARecord" } }, "additionalProperties": false }, "SOARecord": { "description": "

An object that contains information about the start of authority (SOA) record\n associated with the identity.

", "type": "object", "properties": { "PrimaryNameServer": { "description": "

Primary name server specified in the SOA record.

", "type": "string" }, "AdminEmail": { "description": "

Administrative contact email from the SOA record.

", "type": "string" }, "SerialNumber": { "description": "

Serial number from the SOA record.

", "type": "integer" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetEmailIdentityPoliciesResponse": { "description": "

Identity policies associated with email identity.

", "type": "object", "properties": { "Policies": { "description": "

A map of policy names to policies.

", "$ref": "#/definitions/Record" } }, "additionalProperties": false, "definitions": { "Record": { "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetEmailTemplateResponse": { "description": "

The following element is returned by the service.

", "type": "object", "properties": { "TemplateName": { "description": "

The name of the template.

", "type": "string" }, "TemplateContent": { "description": "

The content of the email template, composed of a subject line, an HTML part, and a\n text-only part.

", "$ref": "#/definitions/EmailTemplateContent" } }, "additionalProperties": false, "required": [ "TemplateContent", "TemplateName" ], "definitions": { "EmailTemplateContent": { "description": "

The content of the email, composed of a subject line, an HTML part, and a text-only\n part.

", "type": "object", "properties": { "Subject": { "description": "

The subject line of the email.

", "type": "string" }, "Text": { "description": "

The email body that will be visible to recipients whose email clients do not display\n HTML.

", "type": "string" }, "Html": { "description": "

The HTML body of the email.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetExportJobResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "JobId": { "description": "

The export job ID.

", "type": "string" }, "ExportSourceType": { "description": "

The type of source of the export job.

", "enum": [ "MESSAGE_INSIGHTS", "METRICS_DATA" ], "type": "string" }, "JobStatus": { "description": "

The status of the export job.

", "enum": [ "CANCELLED", "COMPLETED", "CREATED", "FAILED", "PROCESSING" ], "type": "string" }, "ExportDestination": { "description": "

The destination of the export job.

", "$ref": "#/definitions/ExportDestination" }, "ExportDataSource": { "description": "

The data source of the export job.

", "$ref": "#/definitions/ExportDataSource" }, "CreatedTimestamp": { "description": "

The timestamp of when the export job was created.

", "type": "string", "format": "date-time" }, "CompletedTimestamp": { "description": "

The timestamp of when the export job was completed.

", "type": "string", "format": "date-time" }, "FailureInfo": { "description": "

The failure details about an export job.

", "$ref": "#/definitions/FailureInfo" }, "Statistics": { "description": "

The statistics about the export job.

", "$ref": "#/definitions/ExportStatistics" } }, "additionalProperties": false, "definitions": { "ExportDestination": { "description": "

An object that contains details about the destination of the export job.

", "type": "object", "properties": { "DataFormat": { "description": "

The data format of the final export job file, can be one of the following:

\n
    \n
  • \n

    \n CSV - A comma-separated values file.

    \n
    • \n
  • \n

    \n JSON - A Json file.

    \n
    • \n
", "enum": [ "CSV", "JSON" ], "type": "string" }, "S3Url": { "description": "

An Amazon S3 pre-signed URL that points to the generated export file.

", "type": "string" } }, "additionalProperties": false, "required": [ "DataFormat" ] }, "ExportDataSource": { "description": "

An object that contains details about the data source of the export job. It can only\n contain one of MetricsDataSource or MessageInsightsDataSource object.

", "type": "object", "properties": { "MetricsDataSource": { "description": "

An object that contains details about the data source for the metrics export.

", "$ref": "#/definitions/MetricsDataSource" }, "MessageInsightsDataSource": { "description": "

An object that contains filters applied when performing the Message Insights export.

", "$ref": "#/definitions/MessageInsightsDataSource" } }, "additionalProperties": false }, "MetricsDataSource": { "description": "

An object that contains details about the data source for the metrics export.

", "type": "object", "properties": { "Dimensions": { "description": "

An object that contains a mapping between a MetricDimensionName and\n MetricDimensionValue to filter metrics by. Must contain a least 1\n dimension but no more than 3 unique ones.

", "$ref": "#/definitions/Partial>" }, "Namespace": { "description": "

The metrics namespace - e.g., VDM.

", "const": "VDM", "type": "string" }, "Metrics": { "description": "

A list of ExportMetric objects to export.

", "type": "array", "items": { "$ref": "#/definitions/ExportMetric" } }, "StartDate": { "description": "

Represents the start date for the export interval as a timestamp.

", "type": "string", "format": "date-time" }, "EndDate": { "description": "

Represents the end date for the export interval as a timestamp.

", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "Dimensions", "EndDate", "Metrics", "Namespace", "StartDate" ] }, "Partial>": { "type": "object", "properties": { "CONFIGURATION_SET": { "type": "array", "items": { "type": "string" } }, "EMAIL_IDENTITY": { "type": "array", "items": { "type": "string" } }, "ISP": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ExportMetric": { "description": "

An object that contains a mapping between a Metric and\n MetricAggregation.

", "type": "object", "properties": { "Name": { "description": "

The metric to export, can be one of the following:

\n
    \n
  • \n

    \n SEND - Emails sent eligible for tracking in the VDM\n dashboard. This excludes emails sent to the mailbox simulator and emails\n addressed to more than one recipient.

    \n
    • \n
  • \n

    \n COMPLAINT - Complaints received for your account. This\n excludes complaints from the mailbox simulator, those originating from your\n account-level suppression list (if enabled), and those for emails addressed to\n more than one recipient

    \n
    • \n
  • \n

    \n PERMANENT_BOUNCE - Permanent bounces - i.e., feedback\n received for emails sent to non-existent mailboxes. Excludes bounces from the\n mailbox simulator, those originating from your account-level suppression list\n (if enabled), and those for emails addressed to more than one recipient.

    \n
    • \n
  • \n

    \n TRANSIENT_BOUNCE - Transient bounces - i.e., feedback\n received for delivery failures excluding issues with non-existent mailboxes.\n Excludes bounces from the mailbox simulator, and those for emails addressed to\n more than one recipient.

    \n
    • \n
  • \n

    \n OPEN - Unique open events for emails including open\n trackers. Excludes opens for emails addressed to more than one recipient.

    \n
    • \n
  • \n

    \n CLICK - Unique click events for emails including wrapped\n links. Excludes clicks for emails addressed to more than one recipient.

    \n
    • \n
  • \n

    \n DELIVERY - Successful deliveries for email sending\n attempts. Excludes deliveries to the mailbox simulator and for emails addressed\n to more than one recipient.

    \n
    • \n
  • \n

    \n DELIVERY_OPEN - Successful deliveries for email sending\n attempts. Excludes deliveries to the mailbox simulator, for emails addressed to\n more than one recipient, and emails without open trackers.

    \n
    • \n
  • \n

    \n DELIVERY_CLICK - Successful deliveries for email sending\n attempts. Excludes deliveries to the mailbox simulator, for emails addressed to\n more than one recipient, and emails without click trackers.

    \n
    • \n
  • \n

    \n DELIVERY_COMPLAINT - Successful deliveries for email\n sending attempts. Excludes deliveries to the mailbox simulator, for emails\n addressed to more than one recipient, and emails addressed to recipients hosted\n by ISPs with which Amazon SES does not have a feedback loop agreement.

    \n
    • \n
", "enum": [ "CLICK", "COMPLAINT", "DELIVERY", "DELIVERY_CLICK", "DELIVERY_COMPLAINT", "DELIVERY_OPEN", "OPEN", "PERMANENT_BOUNCE", "SEND", "TRANSIENT_BOUNCE" ], "type": "string" }, "Aggregation": { "description": "

The aggregation to apply to a metric, can be one of the following:

\n
    \n
  • \n

    \n VOLUME - The volume of events for this metric.

    \n
    • \n
  • \n

    \n RATE - The rate for this metric relative to the\n SEND metric volume.

    \n
    • \n
", "enum": [ "RATE", "VOLUME" ], "type": "string" } }, "additionalProperties": false }, "MessageInsightsDataSource": { "description": "

An object that contains filters applied when performing the Message Insights export.

", "type": "object", "properties": { "StartDate": { "description": "

Represents the start date for the export interval as a timestamp. The start date is inclusive.

", "type": "string", "format": "date-time" }, "EndDate": { "description": "

Represents the end date for the export interval as a timestamp. The end date is inclusive.

", "type": "string", "format": "date-time" }, "Include": { "description": "

Filters for results to be included in the export file.

", "$ref": "#/definitions/MessageInsightsFilters" }, "Exclude": { "description": "

Filters for results to be excluded from the export file.

", "$ref": "#/definitions/MessageInsightsFilters" }, "MaxResults": { "description": "

The maximum number of results.

", "type": "integer" } }, "additionalProperties": false, "required": [ "EndDate", "StartDate" ] }, "MessageInsightsFilters": { "description": "

An object containing Message Insights filters.

\n

If you specify multiple filters, the filters are joined by AND.

\n

If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.

\n

\n FromEmailAddress, Destination, and Subject filters support partial match.\n A partial match is performed by using the * wildcard character placed at the beginning (suffix match), the end (prefix match)\n or both ends of the string (contains match).\n In order to match the literal characters * or \\, they must be escaped using the \\ character.\n If no wildcard character is present, an exact match is performed.\n

", "type": "object", "properties": { "FromEmailAddress": { "description": "

The from address used to send the message.

", "type": "array", "items": { "type": "string" } }, "Destination": { "description": "

The recipient's email address.

", "type": "array", "items": { "type": "string" } }, "Subject": { "description": "

The subject line of the message.

", "type": "array", "items": { "type": "string" } }, "Isp": { "description": "

The recipient's ISP (e.g., Gmail, Yahoo,\n etc.).

", "type": "array", "items": { "type": "string" } }, "LastDeliveryEvent": { "description": "

\n The last delivery-related event for the email, where the ordering is as follows:\n SEND < BOUNCE < DELIVERY < COMPLAINT.\n

", "type": "array", "items": { "$ref": "#/definitions/DeliveryEventType" } }, "LastEngagementEvent": { "description": "

\n The last engagement-related event for the email, where the ordering is as follows:\n OPEN < CLICK.\n

\n

\n Engagement events are only available if Engagement tracking\n is enabled.\n

", "type": "array", "items": { "$ref": "#/definitions/EngagementEventType" } } }, "additionalProperties": false }, "DeliveryEventType": { "enum": [ "COMPLAINT", "DELIVERY", "PERMANENT_BOUNCE", "SEND", "TRANSIENT_BOUNCE", "UNDETERMINED_BOUNCE" ], "type": "string" }, "EngagementEventType": { "enum": [ "CLICK", "OPEN" ], "type": "string" }, "FailureInfo": { "description": "

An object that contains the failure details about a job.

", "type": "object", "properties": { "FailedRecordsS3Url": { "description": "

An Amazon S3 pre-signed URL that contains all the failed records and related information.

", "type": "string" }, "ErrorMessage": { "description": "

A message about why the job failed.

", "type": "string" } }, "additionalProperties": false }, "ExportStatistics": { "description": "

Statistics about the execution of an export job.

", "type": "object", "properties": { "ProcessedRecordsCount": { "description": "

The number of records that were processed to generate the final export file.

", "type": "integer" }, "ExportedRecordsCount": { "description": "

The number of records that were exported to the final export file.

\n

This value might not be available for all export source types

", "type": "integer" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetImportJobResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "JobId": { "description": "

A string that represents the import job ID.

", "type": "string" }, "ImportDestination": { "description": "

The destination of the import job.

", "$ref": "#/definitions/ImportDestination" }, "ImportDataSource": { "description": "

The data source of the import job.

", "$ref": "#/definitions/ImportDataSource" }, "FailureInfo": { "description": "

The failure details about an import job.

", "$ref": "#/definitions/FailureInfo" }, "JobStatus": { "description": "

The status of the import job.

", "enum": [ "CANCELLED", "COMPLETED", "CREATED", "FAILED", "PROCESSING" ], "type": "string" }, "CreatedTimestamp": { "description": "

The time stamp of when the import job was created.

", "type": "string", "format": "date-time" }, "CompletedTimestamp": { "description": "

The time stamp of when the import job was completed.

", "type": "string", "format": "date-time" }, "ProcessedRecordsCount": { "description": "

The current number of records processed.

", "type": "integer" }, "FailedRecordsCount": { "description": "

The number of records that failed processing because of invalid input or other\n reasons.

", "type": "integer" } }, "additionalProperties": false, "definitions": { "ImportDestination": { "description": "

An object that contains details about the resource destination the import job is going\n to target.

", "type": "object", "properties": { "SuppressionListDestination": { "description": "

An object that contains the action of the import job towards suppression list.

", "$ref": "#/definitions/SuppressionListDestination" }, "ContactListDestination": { "description": "

An object that contains the action of the import job towards a contact list.

", "$ref": "#/definitions/ContactListDestination" } }, "additionalProperties": false }, "SuppressionListDestination": { "description": "

An object that contains details about the action of suppression list.

", "type": "object", "properties": { "SuppressionListImportAction": { "description": "

The type of action to perform on the address. The following are possible values:

\n
    \n
  • \n

    PUT: add the addresses to the suppression list. If the record already exists,\n it will override it with the new value.

    \n
    • \n
  • \n

    DELETE: remove the addresses from the suppression list.

    \n
    • \n
", "enum": [ "DELETE", "PUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "SuppressionListImportAction" ] }, "ContactListDestination": { "description": "

An object that contains details about the action of a contact list.

", "type": "object", "properties": { "ContactListName": { "description": "

The name of the contact list.

", "type": "string" }, "ContactListImportAction": { "description": "

>The type of action to perform on the addresses. The following are the possible\n values:

\n
    \n
  • \n

    PUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.

    \n
    • \n
  • \n

    DELETE: remove the addresses from the contact list.

    \n
    • \n
", "enum": [ "DELETE", "PUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "ContactListImportAction", "ContactListName" ] }, "ImportDataSource": { "description": "

An object that contains details about the data source of the import job.

", "type": "object", "properties": { "S3Url": { "description": "

An Amazon S3 URL in the format\n s3:///.

", "type": "string" }, "DataFormat": { "description": "

The data format of the import job's data source.

", "enum": [ "CSV", "JSON" ], "type": "string" } }, "additionalProperties": false, "required": [ "DataFormat", "S3Url" ] }, "FailureInfo": { "description": "

An object that contains the failure details about a job.

", "type": "object", "properties": { "FailedRecordsS3Url": { "description": "

An Amazon S3 pre-signed URL that contains all the failed records and related information.

", "type": "string" }, "ErrorMessage": { "description": "

A message about why the job failed.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetMessageInsightsResponse": { "description": "

Information about a message.

", "type": "object", "properties": { "MessageId": { "description": "

A unique identifier for the message.

", "type": "string" }, "FromEmailAddress": { "description": "

The from address used to send the message.

", "type": "string" }, "Subject": { "description": "

The subject line of the message.

", "type": "string" }, "EmailTags": { "description": "

\n A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES\n Auto-Tags.\n

", "type": "array", "items": { "$ref": "#/definitions/MessageTag" } }, "Insights": { "description": "

A set of insights associated with the message.

", "type": "array", "items": { "$ref": "#/definitions/EmailInsights" } } }, "additionalProperties": false, "definitions": { "MessageTag": { "description": "

Contains the name and value of a tag that you apply to an email. You can use message\n tags when you publish email sending events.\n

", "type": "object", "properties": { "Name": { "description": "

The name of the message tag. The message tag name has to meet the following\n criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "type": "string" }, "Value": { "description": "

The value of the message tag. The message tag value has to meet the following\n criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "type": "string" } }, "additionalProperties": false, "required": [ "Name", "Value" ] }, "EmailInsights": { "description": "

An email's insights contain metadata and delivery information about a specific email.

", "type": "object", "properties": { "Destination": { "description": "

The recipient of the email.

", "type": "string" }, "Isp": { "description": "

The recipient's ISP (e.g., Gmail, Yahoo,\n etc.).

", "type": "string" }, "Events": { "description": "

A list of events associated with the sent email.

", "type": "array", "items": { "$ref": "#/definitions/InsightsEvent" } } }, "additionalProperties": false }, "InsightsEvent": { "description": "

An object containing details about a specific event.

", "type": "object", "properties": { "Timestamp": { "description": "

The timestamp of the event.

", "type": "string", "format": "date-time" }, "Type": { "description": "

The type of event:

\n
    \n
  • \n

    \n SEND - The send request was successful and SES will\n attempt to deliver the message to the recipient’s mail server. (If account-level\n or global suppression is being used, SES will still count it as a send,\n but delivery is suppressed.)\n

    \n
    • \n
  • \n

    \n DELIVERY - SES successfully delivered the email to the\n recipient's mail server. Excludes deliveries to the mailbox simulator,\n and those from emails addressed to more than one recipient.\n

    \n
    • \n
  • \n

    \n BOUNCE - Feedback received for delivery failures. Additional details about the bounce are provided in the Details object.\n Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.\n

    \n
    • \n
  • \n

    \n COMPLAINT - Complaint received for the email. Additional details about the complaint are provided in the Details object.\n This excludes complaints from the mailbox simulator, those originating from\n your account-level suppression list (if enabled), and those from emails addressed\n to more than one recipient.\n

    \n
    • \n
  • \n

    \n OPEN - Open event for emails including open trackers.\n Excludes opens for emails addressed to more than one recipient.

    \n
    • \n
  • \n

    \n CLICK - Click event for emails including wrapped links.\n Excludes clicks for emails addressed to more than one recipient.

    \n
    • \n
", "enum": [ "BOUNCE", "CLICK", "COMPLAINT", "DELIVERY", "DELIVERY_DELAY", "OPEN", "REJECT", "RENDERING_FAILURE", "SEND", "SUBSCRIPTION" ], "type": "string" }, "Details": { "description": "

Details about bounce or complaint events.

", "$ref": "#/definitions/EventDetails" } }, "additionalProperties": false }, "EventDetails": { "description": "

\n Contains a Bounce object if the event type is BOUNCE.\n Contains a Complaint object if the event type is COMPLAINT.\n

", "type": "object", "properties": { "Bounce": { "description": "

Information about a Bounce event.

", "$ref": "#/definitions/Bounce" }, "Complaint": { "description": "

Information about a Complaint event.

", "$ref": "#/definitions/Complaint" } }, "additionalProperties": false }, "Bounce": { "description": "

Information about a Bounce event.

", "type": "object", "properties": { "BounceType": { "description": "

The type of the bounce, as determined by SES.\n Can be one of UNDETERMINED, TRANSIENT, or PERMANENT\n

", "enum": [ "PERMANENT", "TRANSIENT", "UNDETERMINED" ], "type": "string" }, "BounceSubType": { "description": "

The subtype of the bounce, as determined by SES.

", "type": "string" }, "DiagnosticCode": { "description": "

The status code issued by the reporting Message Transfer Authority (MTA).\n This field only appears if a delivery status notification (DSN) was attached to the bounce\n and the Diagnostic-Code was provided in the DSN.\n

", "type": "string" } }, "additionalProperties": false }, "Complaint": { "description": "

Information about a Complaint event.

", "type": "object", "properties": { "ComplaintSubType": { "description": "

\n Can either be null or OnAccountSuppressionList.\n If the value is OnAccountSuppressionList, SES accepted the message,\n but didn't attempt to send it because it was on the account-level suppression list.\n

", "type": "string" }, "ComplaintFeedbackType": { "description": "

\n The value of the Feedback-Type field from the feedback report received from the ISP.\n

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetMultiRegionEndpointResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "EndpointName": { "description": "

The name of the multi-region endpoint (global-endpoint).

", "type": "string" }, "EndpointId": { "description": "

The ID of the multi-region endpoint (global-endpoint).

", "type": "string" }, "Routes": { "description": "

Contains routes information for the multi-region endpoint (global-endpoint).

", "type": "array", "items": { "$ref": "#/definitions/Route" } }, "Status": { "description": "

The status of the multi-region endpoint (global-endpoint).

\n
    \n
  • \n

    \n CREATING – The resource is being provisioned.

    \n
    • \n
  • \n

    \n READY – The resource is ready to use.

    \n
    • \n
  • \n

    \n FAILED – The resource failed to be provisioned.

    \n
    • \n
  • \n

    \n DELETING – The resource is being deleted as requested.

    \n
    • \n
", "enum": [ "CREATING", "DELETING", "FAILED", "READY" ], "type": "string" }, "CreatedTimestamp": { "description": "

The time stamp of when the multi-region endpoint (global-endpoint) was created.

", "type": "string", "format": "date-time" }, "LastUpdatedTimestamp": { "description": "

The time stamp of when the multi-region endpoint (global-endpoint) was last updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false, "definitions": { "Route": { "description": "

An object which contains an AWS-Region and routing status.

", "type": "object", "properties": { "Region": { "description": "

The name of an AWS-Region.

", "type": "string" } }, "additionalProperties": false, "required": [ "Region" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetReputationEntityResponse": { "description": "

Information about the requested reputation entity.

", "type": "object", "properties": { "ReputationEntity": { "description": "

The reputation entity information, including status records, policy configuration,\n and reputation impact.

", "$ref": "#/definitions/ReputationEntity" } }, "additionalProperties": false, "definitions": { "ReputationEntity": { "description": "

An object that contains information about a reputation entity, including its\n reference, type, policy, status records, and reputation impact.

", "type": "object", "properties": { "ReputationEntityReference": { "description": "

The unique identifier for the reputation entity. For resource-type entities,\n this is the Amazon Resource Name (ARN) of the resource.

", "type": "string" }, "ReputationEntityType": { "description": "

The type of reputation entity. Currently, only RESOURCE type entities are supported.

", "const": "RESOURCE", "type": "string" }, "ReputationManagementPolicy": { "description": "

The Amazon Resource Name (ARN) of the reputation management policy applied to\n this entity. This is an Amazon Web Services Amazon SES-managed policy.

", "type": "string" }, "CustomerManagedStatus": { "description": "

The customer-managed status record for this reputation entity, including the\n current status, cause description, and last updated timestamp.

", "$ref": "#/definitions/StatusRecord" }, "AwsSesManagedStatus": { "description": "

The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the\n current status, cause description, and last updated timestamp.

", "$ref": "#/definitions/StatusRecord" }, "SendingStatusAggregate": { "description": "

The aggregate sending status that determines whether the entity is allowed to\n send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed\n statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is\n DISABLED, the aggregate status will be DISABLED and the entity\n will not be allowed to send emails. When the customer-managed status is set to\n REINSTATED, the entity can continue sending even if there are active\n reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending.\n The entity can only send emails when both statuses permit sending.

", "enum": [ "DISABLED", "ENABLED", "REINSTATED" ], "type": "string" }, "ReputationImpact": { "description": "

The reputation impact level for this entity, representing the highest impact\n reputation finding currently active. Reputation findings can be retrieved using\n the ListRecommendations operation.

", "enum": [ "HIGH", "LOW" ], "type": "string" } }, "additionalProperties": false }, "StatusRecord": { "description": "

An object that contains status information for a reputation entity, including\n the current status, cause description, and timestamp.

", "type": "object", "properties": { "Status": { "description": "

The current sending status. This can be one of the following:

\n
    \n
  • \n

    \n ENABLED – Sending is allowed.

    \n
    • \n
  • \n

    \n DISABLED – Sending is prevented.

    \n
    • \n
  • \n

    \n REINSTATED – Sending is allowed even with active reputation findings.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED", "REINSTATED" ], "type": "string" }, "Cause": { "description": "

A description of the reason for the current status, or null if no specific\n cause is available.

", "type": "string" }, "LastUpdatedTimestamp": { "description": "

The timestamp when this status was last updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetSuppressedDestinationResponse": { "description": "

Information about the suppressed email address.

", "type": "object", "properties": { "SuppressedDestination": { "description": "

An object containing information about the suppressed email address.

", "$ref": "#/definitions/SuppressedDestination" } }, "additionalProperties": false, "required": [ "SuppressedDestination" ], "definitions": { "SuppressedDestination": { "description": "

An object that contains information about an email address that is on the suppression\n list for your account.

", "type": "object", "properties": { "EmailAddress": { "description": "

The email address that is on the suppression list for your account.

", "type": "string" }, "Reason": { "description": "

The reason that the address was added to the suppression list for your account.

", "enum": [ "BOUNCE", "COMPLAINT" ], "type": "string" }, "LastUpdateTime": { "description": "

The date and time when the suppressed destination was last updated, shown in Unix time\n format.

", "type": "string", "format": "date-time" }, "Attributes": { "description": "

An optional value that can contain additional information about the reasons that the\n address was added to the suppression list for your account.

", "$ref": "#/definitions/SuppressedDestinationAttributes" } }, "additionalProperties": false, "required": [ "EmailAddress", "LastUpdateTime", "Reason" ] }, "SuppressedDestinationAttributes": { "description": "

An object that contains additional attributes that are related an email address that\n is on the suppression list for your account.

", "type": "object", "properties": { "MessageId": { "description": "

The unique identifier of the email message that caused the email address to be added\n to the suppression list for your account.

", "type": "string" }, "FeedbackId": { "description": "

A unique identifier that's generated when an email address is added to the suppression\n list for your account.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetTenantResponse": { "description": "

Information about a specific tenant.

", "type": "object", "properties": { "Tenant": { "description": "

A structure that contains details about the tenant.

", "$ref": "#/definitions/Tenant" } }, "additionalProperties": false, "definitions": { "Tenant": { "description": "

A structure that contains details about a tenant.

", "type": "object", "properties": { "TenantName": { "description": "

The name of the tenant.

", "type": "string" }, "TenantId": { "description": "

A unique identifier for the tenant.

", "type": "string" }, "TenantArn": { "description": "

The Amazon Resource Name (ARN) of the tenant.

", "type": "string" }, "CreatedTimestamp": { "description": "

The date and time when the tenant was created.

", "type": "string", "format": "date-time" }, "Tags": { "description": "

An array of objects that define the tags (keys and values) associated with the tenant.

", "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "SendingStatus": { "description": "

The status of sending capability for the tenant.

", "enum": [ "DISABLED", "ENABLED", "REINSTATED" ], "type": "string" } }, "additionalProperties": false }, "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListConfigurationSetsResponse": { "description": "

A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.

", "type": "object", "properties": { "ConfigurationSets": { "description": "

An array that contains all of the configuration sets in your Amazon SES account in the\n current Amazon Web Services Region.

", "type": "array", "items": { "type": "string" } }, "NextToken": { "description": "

A token that indicates that there are additional configuration sets to list. To view\n additional configuration sets, issue another request to\n ListConfigurationSets, and pass this token in the\n NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListContactListsResponse": { "type": "object", "properties": { "ContactLists": { "description": "

The available contact lists.

", "type": "array", "items": { "$ref": "#/definitions/ContactList" } }, "NextToken": { "description": "

A string token indicating that there might be additional contact lists available to be\n listed. Copy this token to a subsequent call to ListContactLists with the\n same parameters to retrieve the next page of contact lists.

", "type": "string" } }, "additionalProperties": false, "definitions": { "ContactList": { "description": "

A list that contains contacts that have subscribed to a particular topic or\n topics.

", "type": "object", "properties": { "ContactListName": { "description": "

The name of the contact list.

", "type": "string" }, "LastUpdatedTimestamp": { "description": "

A timestamp noting the last time the contact list was updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListContactsResponse": { "type": "object", "properties": { "Contacts": { "description": "

The contacts present in a specific contact list.

", "type": "array", "items": { "$ref": "#/definitions/Contact" } }, "NextToken": { "description": "

A string token indicating that there might be additional contacts available to be\n listed. Copy this token to a subsequent call to ListContacts with the same\n parameters to retrieve the next page of contacts.

", "type": "string" } }, "additionalProperties": false, "definitions": { "Contact": { "description": "

A contact is the end-user who is receiving the email.

", "type": "object", "properties": { "EmailAddress": { "description": "

The contact's email address.

", "type": "string" }, "TopicPreferences": { "description": "

The contact's preference for being opted-in to or opted-out of a topic.

", "type": "array", "items": { "$ref": "#/definitions/TopicPreference" } }, "TopicDefaultPreferences": { "description": "

The default topic preferences applied to the contact.

", "type": "array", "items": { "$ref": "#/definitions/TopicPreference" } }, "UnsubscribeAll": { "description": "

A boolean value status noting if the contact is unsubscribed from all contact list\n topics.

", "type": "boolean" }, "LastUpdatedTimestamp": { "description": "

A timestamp noting the last time the contact's information was updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TopicPreference": { "description": "

The contact's preference for being opted-in to or opted-out of a topic.

", "type": "object", "properties": { "TopicName": { "description": "

The name of the topic.

", "type": "string" }, "SubscriptionStatus": { "description": "

The contact's subscription status to a topic which is either OPT_IN or\n OPT_OUT.

", "enum": [ "OPT_IN", "OPT_OUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "SubscriptionStatus", "TopicName" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListCustomVerificationEmailTemplatesResponse": { "description": "

The following elements are returned by the service.

", "type": "object", "properties": { "CustomVerificationEmailTemplates": { "description": "

A list of the custom verification email templates that exist in your account.

", "type": "array", "items": { "$ref": "#/definitions/CustomVerificationEmailTemplateMetadata" } }, "NextToken": { "description": "

A token indicating that there are additional custom verification email templates\n available to be listed. Pass this token to a subsequent call to\n ListCustomVerificationEmailTemplates to retrieve the next 50 custom\n verification email templates.

", "type": "string" } }, "additionalProperties": false, "definitions": { "CustomVerificationEmailTemplateMetadata": { "description": "

Contains information about a custom verification email template.

", "type": "object", "properties": { "TemplateName": { "description": "

The name of the custom verification email template.

", "type": "string" }, "FromEmailAddress": { "description": "

The email address that the custom verification email is sent from.

", "type": "string" }, "TemplateSubject": { "description": "

The subject line of the custom verification email.

", "type": "string" }, "SuccessRedirectionURL": { "description": "

The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

", "type": "string" }, "FailureRedirectionURL": { "description": "

The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListDedicatedIpPoolsResponse": { "description": "

A list of dedicated IP pools.

", "type": "object", "properties": { "DedicatedIpPools": { "description": "

A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in\n the current Region.

", "type": "array", "items": { "type": "string" } }, "NextToken": { "description": "

A token that indicates that there are additional IP pools to list. To view additional\n IP pools, issue another request to ListDedicatedIpPools, passing this token\n in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListDeliverabilityTestReportsResponse": { "description": "

A list of the predictive inbox placement test reports that are available for your account, regardless of\n whether or not those tests are complete.

", "type": "object", "properties": { "DeliverabilityTestReports": { "description": "

An object that contains a lists of predictive inbox placement tests that you've performed.

", "type": "array", "items": { "$ref": "#/definitions/DeliverabilityTestReport" } }, "NextToken": { "description": "

A token that indicates that there are additional predictive inbox placement tests to list. To view additional\n predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass\n this token in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "required": [ "DeliverabilityTestReports" ], "definitions": { "DeliverabilityTestReport": { "description": "

An object that contains metadata related to a predictive inbox placement test.

", "type": "object", "properties": { "ReportId": { "description": "

A unique string that identifies the predictive inbox placement test.

", "type": "string" }, "ReportName": { "description": "

A name that helps you identify a predictive inbox placement test report.

", "type": "string" }, "Subject": { "description": "

The subject line for an email that you submitted in a predictive inbox placement test.

", "type": "string" }, "FromEmailAddress": { "description": "

The sender address that you specified for the predictive inbox placement test.

", "type": "string" }, "CreateDate": { "description": "

The date and time when the predictive inbox placement test was created.

", "type": "string", "format": "date-time" }, "DeliverabilityTestStatus": { "description": "

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

", "enum": [ "COMPLETED", "IN_PROGRESS" ], "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListDomainDeliverabilityCampaignsResponse": { "description": "

An array of objects that provide deliverability data for all the campaigns that used a\n specific domain to send email during a specified time range. This data is available for\n a domain only if you enabled the Deliverability dashboard for the domain.

", "type": "object", "properties": { "DomainDeliverabilityCampaigns": { "description": "

An array of responses, one for each campaign that used the domain to send email during\n the specified time range.

", "type": "array", "items": { "$ref": "#/definitions/DomainDeliverabilityCampaign" } }, "NextToken": { "description": "

A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of the campaign in the list of campaigns.

", "type": "string" } }, "additionalProperties": false, "required": [ "DomainDeliverabilityCampaigns" ], "definitions": { "DomainDeliverabilityCampaign": { "description": "

An object that contains the deliverability data for a specific campaign. This data is\n available for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption\n operation).

", "type": "object", "properties": { "CampaignId": { "description": "

The unique identifier for the campaign. The Deliverability dashboard automatically generates\n and assigns this identifier to a campaign.

", "type": "string" }, "ImageUrl": { "description": "

The URL of an image that contains a snapshot of the email message that was\n sent.

", "type": "string" }, "Subject": { "description": "

The subject line, or title, of the email message.

", "type": "string" }, "FromAddress": { "description": "

The verified email address that the email message was sent from.

", "type": "string" }, "SendingIps": { "description": "

The IP addresses that were used to send the email message.

", "type": "array", "items": { "type": "string" } }, "FirstSeenDateTime": { "description": "

The first time when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

", "type": "string", "format": "date-time" }, "LastSeenDateTime": { "description": "

The last time when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

", "type": "string", "format": "date-time" }, "InboxCount": { "description": "

The number of email messages that were delivered to recipients’ inboxes.

", "type": "integer" }, "SpamCount": { "description": "

The number of email messages that were delivered to recipients' spam or junk mail\n folders.

", "type": "integer" }, "ReadRate": { "description": "

The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.

", "type": "integer" }, "DeleteRate": { "description": "

The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.

", "type": "integer" }, "ReadDeleteRate": { "description": "

The percentage of email messages that were opened and then deleted by recipients. Due\n to technical limitations, this value only includes recipients who opened the message by\n using an email client that supports images.

", "type": "integer" }, "ProjectedVolume": { "description": "

The projected number of recipients that the email message was sent to.

", "type": "integer" }, "Esps": { "description": "

The major email providers who handled the email message.

", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListEmailIdentitiesResponse": { "description": "

A list of all of the identities that you've attempted to verify, regardless of whether\n or not those identities were successfully verified.

", "type": "object", "properties": { "EmailIdentities": { "description": "

An array that includes all of the email identities associated with your Amazon Web Services\n account.

", "type": "array", "items": { "$ref": "#/definitions/IdentityInfo" } }, "NextToken": { "description": "

A token that indicates that there are additional configuration sets to list. To view\n additional configuration sets, issue another request to\n ListEmailIdentities, and pass this token in the NextToken\n parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "IdentityInfo": { "description": "

Information about an email identity.

", "type": "object", "properties": { "IdentityType": { "description": "

The email identity type. Note: the MANAGED_DOMAIN type is not supported\n for email identity types.

", "enum": [ "DOMAIN", "EMAIL_ADDRESS", "MANAGED_DOMAIN" ], "type": "string" }, "IdentityName": { "description": "

The address or domain of the identity.

", "type": "string" }, "SendingEnabled": { "description": "

Indicates whether or not you can send email from the identity.

\n

An identity is an email address or domain that you send email\n from. Before you can send email from an identity, you have to demostrate that you own\n the identity, and that you authorize Amazon SES to send email from that identity.

", "type": "boolean" }, "VerificationStatus": { "description": "

The verification status of the identity. The status can be one of the\n following:

\n
    \n
  • \n

    \n PENDING – The verification process was initiated, but Amazon SES\n hasn't yet been able to verify the identity.

    \n
    • \n
  • \n

    \n SUCCESS – The verification process completed\n successfully.

    \n
    • \n
  • \n

    \n FAILED – The verification process failed.

    \n
    • \n
  • \n

    \n TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES\n from determining the verification status of the identity.

    \n
    • \n
  • \n

    \n NOT_STARTED – The verification process hasn't been\n initiated for the identity.

    \n
    • \n
", "enum": [ "FAILED", "NOT_STARTED", "PENDING", "SUCCESS", "TEMPORARY_FAILURE" ], "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListEmailTemplatesResponse": { "description": "

The following elements are returned by the service.

", "type": "object", "properties": { "TemplatesMetadata": { "description": "

An array the contains the name and creation time stamp for each template in your Amazon SES\n account.

", "type": "array", "items": { "$ref": "#/definitions/EmailTemplateMetadata" } }, "NextToken": { "description": "

A token indicating that there are additional email templates available to be listed.\n Pass this token to a subsequent ListEmailTemplates call to retrieve the\n next 10 email templates.

", "type": "string" } }, "additionalProperties": false, "definitions": { "EmailTemplateMetadata": { "description": "

Contains information about an email template.

", "type": "object", "properties": { "TemplateName": { "description": "

The name of the template.

", "type": "string" }, "CreatedTimestamp": { "description": "

The time and date the template was created.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListExportJobsResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "ExportJobs": { "description": "

A list of the export job summaries.

", "type": "array", "items": { "$ref": "#/definitions/ExportJobSummary" } }, "NextToken": { "description": "

A string token indicating that there might be additional export jobs available to be\n listed. Use this token to a subsequent call to ListExportJobs with the same\n parameters to retrieve the next page of export jobs.

", "type": "string" } }, "additionalProperties": false, "definitions": { "ExportJobSummary": { "description": "

A summary of the export job.

", "type": "object", "properties": { "JobId": { "description": "

The export job ID.

", "type": "string" }, "ExportSourceType": { "description": "

The source type of the export job.

", "enum": [ "MESSAGE_INSIGHTS", "METRICS_DATA" ], "type": "string" }, "JobStatus": { "description": "

The status of the export job.

", "enum": [ "CANCELLED", "COMPLETED", "CREATED", "FAILED", "PROCESSING" ], "type": "string" }, "CreatedTimestamp": { "description": "

The timestamp of when the export job was created.

", "type": "string", "format": "date-time" }, "CompletedTimestamp": { "description": "

The timestamp of when the export job was completed.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListImportJobsResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "properties": { "ImportJobs": { "description": "

A list of the import job summaries.

", "type": "array", "items": { "$ref": "#/definitions/ImportJobSummary" } }, "NextToken": { "description": "

A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to ListImportJobs with the\n same parameters to retrieve the next page of import jobs.

", "type": "string" } }, "additionalProperties": false, "definitions": { "ImportJobSummary": { "description": "

A summary of the import job.

", "type": "object", "properties": { "JobId": { "description": "

A string that represents a job ID.

", "type": "string" }, "ImportDestination": { "description": "

An object that contains details about the resource destination the import job is going\n to target.

", "$ref": "#/definitions/ImportDestination" }, "JobStatus": { "description": "

The status of a job.

\n
    \n
  • \n

    \n CREATED – Job has just been created.

    \n
    • \n
  • \n

    \n PROCESSING – Job is processing.

    \n
    • \n
  • \n

    \n ERROR – An error occurred during processing.

    \n
    • \n
  • \n

    \n COMPLETED – Job has completed processing successfully.

    \n
    • \n
", "enum": [ "CANCELLED", "COMPLETED", "CREATED", "FAILED", "PROCESSING" ], "type": "string" }, "CreatedTimestamp": { "description": "

The date and time when the import job was created.

", "type": "string", "format": "date-time" }, "ProcessedRecordsCount": { "description": "

The current number of records processed.

", "type": "integer" }, "FailedRecordsCount": { "description": "

The number of records that failed processing because of invalid input or other\n reasons.

", "type": "integer" } }, "additionalProperties": false }, "ImportDestination": { "description": "

An object that contains details about the resource destination the import job is going\n to target.

", "type": "object", "properties": { "SuppressionListDestination": { "description": "

An object that contains the action of the import job towards suppression list.

", "$ref": "#/definitions/SuppressionListDestination" }, "ContactListDestination": { "description": "

An object that contains the action of the import job towards a contact list.

", "$ref": "#/definitions/ContactListDestination" } }, "additionalProperties": false }, "SuppressionListDestination": { "description": "

An object that contains details about the action of suppression list.

", "type": "object", "properties": { "SuppressionListImportAction": { "description": "

The type of action to perform on the address. The following are possible values:

\n
    \n
  • \n

    PUT: add the addresses to the suppression list. If the record already exists,\n it will override it with the new value.

    \n
    • \n
  • \n

    DELETE: remove the addresses from the suppression list.

    \n
    • \n
", "enum": [ "DELETE", "PUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "SuppressionListImportAction" ] }, "ContactListDestination": { "description": "

An object that contains details about the action of a contact list.

", "type": "object", "properties": { "ContactListName": { "description": "

The name of the contact list.

", "type": "string" }, "ContactListImportAction": { "description": "

>The type of action to perform on the addresses. The following are the possible\n values:

\n
    \n
  • \n

    PUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.

    \n
    • \n
  • \n

    DELETE: remove the addresses from the contact list.

    \n
    • \n
", "enum": [ "DELETE", "PUT" ], "type": "string" } }, "additionalProperties": false, "required": [ "ContactListImportAction", "ContactListName" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListMultiRegionEndpointsResponse": { "description": "

The following elements are returned by the service.

", "type": "object", "properties": { "MultiRegionEndpoints": { "description": "

An array that contains key multi-region endpoint (global-endpoint) properties.

", "type": "array", "items": { "$ref": "#/definitions/MultiRegionEndpoint" } }, "NextToken": { "description": "

A token indicating that there are additional multi-region endpoints (global-endpoints) available to be listed.\n Pass this token to a subsequent ListMultiRegionEndpoints call to retrieve the\n next page.

", "type": "string" } }, "additionalProperties": false, "definitions": { "MultiRegionEndpoint": { "description": "

An object that contains multi-region endpoint (global-endpoint) properties.

", "type": "object", "properties": { "EndpointName": { "description": "

The name of the multi-region endpoint (global-endpoint).

", "type": "string" }, "Status": { "description": "

The status of the multi-region endpoint (global-endpoint).

\n
    \n
  • \n

    \n CREATING – The resource is being provisioned.

    \n
    • \n
  • \n

    \n READY – The resource is ready to use.

    \n
    • \n
  • \n

    \n FAILED – The resource failed to be provisioned.

    \n
    • \n
  • \n

    \n DELETING – The resource is being deleted as requested.

    \n
    • \n
", "enum": [ "CREATING", "DELETING", "FAILED", "READY" ], "type": "string" }, "EndpointId": { "description": "

The ID of the multi-region endpoint (global-endpoint).

", "type": "string" }, "Regions": { "description": "

Primary and secondary regions between which multi-region endpoint splits sending traffic.

", "type": "array", "items": { "type": "string" } }, "CreatedTimestamp": { "description": "

The time stamp of when the multi-region endpoint (global-endpoint) was created.

", "type": "string", "format": "date-time" }, "LastUpdatedTimestamp": { "description": "

The time stamp of when the multi-region endpoint (global-endpoint) was last updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListRecommendationsResponse": { "description": "

Contains the response to your request to retrieve the list of recommendations for your account.

", "type": "object", "properties": { "Recommendations": { "description": "

The recommendations applicable to your account.

", "type": "array", "items": { "$ref": "#/definitions/Recommendation" } }, "NextToken": { "description": "

A string token indicating that there might be additional recommendations available to be\n listed. Use the token provided in the ListRecommendationsResponse to use in the\n subsequent call to ListRecommendations with the same parameters to retrieve the\n next page of recommendations.

", "type": "string" } }, "additionalProperties": false, "definitions": { "Recommendation": { "description": "

A recommendation generated for your account.

", "type": "object", "properties": { "ResourceArn": { "description": "

The resource affected by the recommendation,\n with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.

", "type": "string" }, "Type": { "description": "

The recommendation type, with values like DKIM,\n SPF, DMARC, BIMI, or COMPLAINT.

", "enum": [ "BIMI", "BOUNCE", "COMPLAINT", "DKIM", "DMARC", "FEEDBACK_3P", "IP_LISTING", "SPF" ], "type": "string" }, "Description": { "description": "

The recommendation description / disambiguator - e.g. DKIM1 and DKIM2\n are different recommendations about your DKIM setup.

", "type": "string" }, "Status": { "description": "

The recommendation status, with values like\n OPEN or FIXED.

", "enum": [ "FIXED", "OPEN" ], "type": "string" }, "CreatedTimestamp": { "description": "

The first time this issue was encountered and the recommendation was generated.

", "type": "string", "format": "date-time" }, "LastUpdatedTimestamp": { "description": "

The last time the recommendation was updated.

", "type": "string", "format": "date-time" }, "Impact": { "description": "

The recommendation impact, with values like\n HIGH or LOW.

", "enum": [ "HIGH", "LOW" ], "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListReputationEntitiesResponse": { "description": "

A list of reputation entities in your account.

", "type": "object", "properties": { "ReputationEntities": { "description": "

An array that contains information about the reputation entities in your account.

", "type": "array", "items": { "$ref": "#/definitions/ReputationEntity" } }, "NextToken": { "description": "

A token that indicates that there are additional reputation entities to list.\n To view additional reputation entities, issue another request to ListReputationEntities,\n and pass this token in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "ReputationEntity": { "description": "

An object that contains information about a reputation entity, including its\n reference, type, policy, status records, and reputation impact.

", "type": "object", "properties": { "ReputationEntityReference": { "description": "

The unique identifier for the reputation entity. For resource-type entities,\n this is the Amazon Resource Name (ARN) of the resource.

", "type": "string" }, "ReputationEntityType": { "description": "

The type of reputation entity. Currently, only RESOURCE type entities are supported.

", "const": "RESOURCE", "type": "string" }, "ReputationManagementPolicy": { "description": "

The Amazon Resource Name (ARN) of the reputation management policy applied to\n this entity. This is an Amazon Web Services Amazon SES-managed policy.

", "type": "string" }, "CustomerManagedStatus": { "description": "

The customer-managed status record for this reputation entity, including the\n current status, cause description, and last updated timestamp.

", "$ref": "#/definitions/StatusRecord" }, "AwsSesManagedStatus": { "description": "

The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the\n current status, cause description, and last updated timestamp.

", "$ref": "#/definitions/StatusRecord" }, "SendingStatusAggregate": { "description": "

The aggregate sending status that determines whether the entity is allowed to\n send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed\n statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is\n DISABLED, the aggregate status will be DISABLED and the entity\n will not be allowed to send emails. When the customer-managed status is set to\n REINSTATED, the entity can continue sending even if there are active\n reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending.\n The entity can only send emails when both statuses permit sending.

", "enum": [ "DISABLED", "ENABLED", "REINSTATED" ], "type": "string" }, "ReputationImpact": { "description": "

The reputation impact level for this entity, representing the highest impact\n reputation finding currently active. Reputation findings can be retrieved using\n the ListRecommendations operation.

", "enum": [ "HIGH", "LOW" ], "type": "string" } }, "additionalProperties": false }, "StatusRecord": { "description": "

An object that contains status information for a reputation entity, including\n the current status, cause description, and timestamp.

", "type": "object", "properties": { "Status": { "description": "

The current sending status. This can be one of the following:

\n
    \n
  • \n

    \n ENABLED – Sending is allowed.

    \n
    • \n
  • \n

    \n DISABLED – Sending is prevented.

    \n
    • \n
  • \n

    \n REINSTATED – Sending is allowed even with active reputation findings.

    \n
    • \n
", "enum": [ "DISABLED", "ENABLED", "REINSTATED" ], "type": "string" }, "Cause": { "description": "

A description of the reason for the current status, or null if no specific\n cause is available.

", "type": "string" }, "LastUpdatedTimestamp": { "description": "

The timestamp when this status was last updated.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListResourceTenantsResponse": { "description": "

Information about tenants associated with a specific resource.

", "type": "object", "properties": { "ResourceTenants": { "description": "

An array that contains information about each tenant associated with the resource.

", "type": "array", "items": { "$ref": "#/definitions/ResourceTenantMetadata" } }, "NextToken": { "description": "

A token that indicates that there are additional tenants to list. To view additional tenants,\n issue another request to ListResourceTenants, and pass this token in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "ResourceTenantMetadata": { "description": "

A structure that contains information about a tenant associated with a resource.

", "type": "object", "properties": { "TenantName": { "description": "

The name of the tenant associated with the resource.

", "type": "string" }, "TenantId": { "description": "

A unique identifier for the tenant associated with the resource.

", "type": "string" }, "ResourceArn": { "description": "

The Amazon Resource Name (ARN) of the resource.

", "type": "string" }, "AssociatedTimestamp": { "description": "

The date and time when the resource was associated with the tenant.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListSuppressedDestinationsResponse": { "description": "

A list of suppressed email addresses.

", "type": "object", "properties": { "SuppressedDestinationSummaries": { "description": "

A list of summaries, each containing a summary for a suppressed email\n destination.

", "type": "array", "items": { "$ref": "#/definitions/SuppressedDestinationSummary" } }, "NextToken": { "description": "

A token that indicates that there are additional email addresses on the suppression\n list for your account. To view additional suppressed addresses, issue another request to\n ListSuppressedDestinations, and pass this token in the\n NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "SuppressedDestinationSummary": { "description": "

A summary that describes the suppressed email address.

", "type": "object", "properties": { "EmailAddress": { "description": "

The email address that's on the suppression list for your account.

", "type": "string" }, "Reason": { "description": "

The reason that the address was added to the suppression list for your account.

", "enum": [ "BOUNCE", "COMPLAINT" ], "type": "string" }, "LastUpdateTime": { "description": "

The date and time when the suppressed destination was last updated, shown in Unix time\n format.

", "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "EmailAddress", "LastUpdateTime", "Reason" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListTagsForResourceResponse": { "type": "object", "properties": { "Tags": { "description": "

An array that lists all the tags that are associated with the resource. Each tag\n consists of a required tag key (Key) and an associated tag value\n (Value)

", "type": "array", "items": { "$ref": "#/definitions/Tag" } } }, "additionalProperties": false, "required": [ "Tags" ], "definitions": { "Tag": { "description": "

An object that defines the tags that are associated with a resource.\n A tag is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix don’t count\n against the limit of 50 tags per resource.

    \n
    • \n
  • \n

    You can associate tags with public or shared resources, but the tags are\n available only for your Amazon Web Services account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified Amazon Web Services Region for your Amazon Web Services account.

    \n
    • \n
", "type": "object", "properties": { "Key": { "description": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "type": "string" }, "Value": { "description": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.

", "type": "string" } }, "additionalProperties": false, "required": [ "Key", "Value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListTenantResourcesResponse": { "description": "

Information about resources associated with a specific tenant.

", "type": "object", "properties": { "TenantResources": { "description": "

An array that contains information about each resource associated with the tenant.

", "type": "array", "items": { "$ref": "#/definitions/TenantResource" } }, "NextToken": { "description": "

A token that indicates that there are additional resources to list. To view additional resources,\n issue another request to ListTenantResources, and pass this token in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "TenantResource": { "description": "

A structure that contains information about a resource associated with a tenant.

", "type": "object", "properties": { "ResourceType": { "description": "

The type of resource associated with the tenant. Valid values are EMAIL_IDENTITY,\n CONFIGURATION_SET, or EMAIL_TEMPLATE.

", "enum": [ "CONFIGURATION_SET", "EMAIL_IDENTITY", "EMAIL_TEMPLATE" ], "type": "string" }, "ResourceArn": { "description": "

The Amazon Resource Name (ARN) of the resource associated with the tenant.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListTenantsResponse": { "description": "

Information about tenants associated with your account.

", "type": "object", "properties": { "Tenants": { "description": "

An array that contains basic information about each tenant.

", "type": "array", "items": { "$ref": "#/definitions/TenantInfo" } }, "NextToken": { "description": "

A token that indicates that there are additional tenants to list. To view additional tenants,\n issue another request to ListTenants, and pass this token in the NextToken parameter.

", "type": "string" } }, "additionalProperties": false, "definitions": { "TenantInfo": { "description": "

A structure that contains basic information about a tenant.

", "type": "object", "properties": { "TenantName": { "description": "

The name of the tenant.

", "type": "string" }, "TenantId": { "description": "

A unique identifier for the tenant.

", "type": "string" }, "TenantArn": { "description": "

The Amazon Resource Name (ARN) of the tenant.

", "type": "string" }, "CreatedTimestamp": { "description": "

The date and time when the tenant was created.

", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SendBulkEmailResponse": { "description": "

The following data is returned in JSON format by the service.

", "type": "object", "properties": { "BulkEmailEntryResults": { "description": "

One object per intended recipient. Check each response object and retry any messages\n with a failure status.

", "type": "array", "items": { "$ref": "#/definitions/BulkEmailEntryResult" } } }, "additionalProperties": false, "required": [ "BulkEmailEntryResults" ], "definitions": { "BulkEmailEntryResult": { "description": "

The result of the SendBulkEmail operation of each specified\n BulkEmailEntry.

", "type": "object", "properties": { "Status": { "description": "

The status of a message sent using the SendBulkTemplatedEmail\n operation.

\n

Possible values for this parameter include:

\n
    \n
  • \n

    SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to\n the recipients.

    \n
    • \n
  • \n

    MESSAGE_REJECTED: The message was rejected because it contained a\n virus.

    \n
    • \n
  • \n

    MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not\n verified.

    \n
    • \n
  • \n

    CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not\n exist.

    \n
    • \n
  • \n

    TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.

    \n
    • \n
  • \n

    ACCOUNT_SUSPENDED: Your account has been shut down because of issues related\n to your email sending practices.

    \n
    • \n
  • \n

    ACCOUNT_THROTTLED: The number of emails you can send has been reduced because\n your account has exceeded its allocated sending limit.

    \n
    • \n
  • \n

    ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number\n of emails you can send from your account in a 24-hour period.

    \n
    • \n
  • \n

    INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP\n pool that does not exist.

    \n
    • \n
  • \n

    ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled\n using the UpdateAccountSendingEnabled operation.

    \n
    • \n
  • \n

    CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was\n disabled using the UpdateConfigurationSetSendingEnabled operation.

    \n
    • \n
  • \n

    INVALID_PARAMETER_VALUE: One or more of the parameters you specified when\n calling this operation was invalid. See the error message for additional\n information.

    \n
    • \n
  • \n

    TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a\n temporary issue.

    \n
    • \n
  • \n

    FAILED: Amazon SES was unable to process your request. See the error message\n for additional information.

    \n
    • \n
", "enum": [ "ACCOUNT_DAILY_QUOTA_EXCEEDED", "ACCOUNT_SENDING_PAUSED", "ACCOUNT_SUSPENDED", "ACCOUNT_THROTTLED", "CONFIGURATION_SET_NOT_FOUND", "CONFIGURATION_SET_SENDING_PAUSED", "FAILED", "INVALID_PARAMETER", "INVALID_SENDING_POOL_NAME", "MAIL_FROM_DOMAIN_NOT_VERIFIED", "MESSAGE_REJECTED", "SUCCESS", "TEMPLATE_NOT_FOUND", "TRANSIENT_FAILURE" ], "type": "string" }, "Error": { "description": "

A description of an error that prevented a message being sent using the\n SendBulkTemplatedEmail operation.

", "type": "string" }, "MessageId": { "description": "

The unique message identifier returned from the SendBulkTemplatedEmail\n operation.

", "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SendCustomVerificationEmailResponse": { "description": "

The following element is returned by the service.

", "type": "object", "properties": { "MessageId": { "description": "

The unique message identifier returned from the\n SendCustomVerificationEmail operation.

", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "SendEmailResponse": { "description": "

A unique message ID that you receive when an email is accepted for sending.

", "type": "object", "properties": { "MessageId": { "description": "

A unique identifier for the message that is generated when the message is\n accepted.

\n \n

It's possible for Amazon SES to accept a message without sending it. For example, this\n can happen when the message that you're trying to send has an attachment that\n contains a virus, or when you send a templated email that contains invalid\n personalization content.

\n ", "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "TagResourceResponse": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "TestRenderEmailTemplateResponse": { "description": "

The following element is returned by the service.

", "type": "object", "properties": { "RenderedTemplate": { "description": "

The complete MIME message rendered by applying the data in the\n TemplateData parameter to the template specified in the TemplateName\n parameter.

", "type": "string" } }, "additionalProperties": false, "required": [ "RenderedTemplate" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UntagResourceResponse": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateConfigurationSetEventDestinationResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateContactResponse": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateContactListResponse": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateCustomVerificationEmailTemplateResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateEmailIdentityPolicyResponse": { "description": "

An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateEmailTemplateResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateReputationEntityCustomerManagedStatusResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateReputationEntityPolicyResponse": { "description": "

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

", "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIWebhook": { "type": "object", "properties": { "url": { "type": "string" }, "urls": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "WebhookResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" }, "webhook": { "type": "object", "properties": { "url": { "type": "string" }, "urls": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "message", "webhook" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "WebhookValidationResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "message" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CreatedUpdatedDomainCredentialsResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MessageResponse": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ConnectionSettingsResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "require_tls": { "type": "boolean" }, "skip_verification": { "type": "boolean" } }, "additionalProperties": false }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdatedDKIMAuthorityResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "changed": { "type": "boolean" }, "message": { "type": "string" }, "sending_dns_records": { "type": "array", "items": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/Domains\",{with:{\"resolution-mode\":\"import\"}}).DNSRecord" } } }, "additionalProperties": false, "required": [ "changed", "message", "sending_dns_records" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "definitions": { "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/Domains\",{with:{\"resolution-mode\":\"import\"}}).DNSRecord": { "type": "object", "properties": { "cached": { "type": "array", "items": {} }, "name": { "type": "string" }, "record_type": { "type": "string" }, "valid": { "type": "string" }, "value": { "type": "string" }, "priority": { "type": "string" } }, "additionalProperties": false, "required": [ "cached", "name", "record_type", "valid", "value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdatedDKIMSelectorResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdatedWebPrefixResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": {} }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIErrorOptions": { "type": "object", "properties": { "headers": { "type": "object", "additionalProperties": {} }, "status": { "type": "integer" }, "message": { "type": "string" }, "body": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false }, "url": { "type": "string" }, "statusText": { "type": "string" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIErrorType": { "type": "object", "properties": { "stack": { "type": "string" }, "status": { "type": "integer" }, "message": { "type": "string" }, "details": { "type": "string" } }, "additionalProperties": false, "required": [ "details", "message", "stack", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MessagesSendAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "message" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateRouteResponse": { "additionalProperties": false, "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" }, "description": { "type": "string" }, "expression": { "type": "string" }, "id": { "type": "string" }, "priority": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "actions", "created_at", "description", "expression", "id", "message", "priority" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsTestResultAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "result_id": { "type": "string" }, "links": { "type": "object", "properties": { "results": { "type": "string" } }, "additionalProperties": false, "required": [ "results" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "links", "result_id", "status" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsAttributesApiResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "object", "properties": { "attribute": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "attribute", "values" ] } }, "additionalProperties": false, "required": [ "items" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsValuesApiResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": {}, "additionalProperties": true }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsFiltersApiResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "supported_filters": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "parameter" ] } } }, "additionalProperties": false, "required": [ "filters" ] } }, "additionalProperties": false, "required": [ "supported_filters" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SeedsListsAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string" }, "kid": { "type": "string" }, "ID": { "type": "string" }, "AccountID": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_result_at": { "type": "string" }, "Seeds": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "AccountID": { "type": "string" }, "id": { "type": "string" }, "token": { "type": "string" }, "email": { "type": "string" }, "provider": { "type": "string" }, "sync_state": { "type": "string" }, "local_state": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "message_count": { "type": "integer" }, "max_email_count_hit_at": { "type": "string" }, "total_msgs": { "type": "integer" }, "matched_msgs": { "type": "integer" }, "spam_message": { "type": "integer" }, "expected_msgs": { "type": "integer" }, "last_sent_to_at": { "type": "string" }, "last_delivered_at": { "type": "string" }, "account_quality": { "type": "integer" }, "quality_label": { "type": "string" }, "password": { "type": "string" }, "phone_number": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": {} }, "totp": { "type": "object", "properties": { "secret": { "type": "string" } }, "additionalProperties": false, "required": [ "secret" ] } }, "additionalProperties": false, "required": [ "AccountID", "account_quality", "attributes", "created_at", "email", "expected_msgs", "id", "last_delivered_at", "last_sent_to_at", "local_state", "matched_msgs", "max_email_count_hit_at", "message_count", "password", "phone_number", "provider", "quality_label", "spam_message", "sync_state", "token", "total_msgs", "totp", "updated_at" ] } }, { "type": "null" } ] }, "target_email": { "type": "string" }, "sending_domains": { "type": "array", "items": { "type": "string" } }, "has_results": { "type": "boolean" }, "name": { "type": "string" }, "seed_filter": { "type": "string" }, "mailing_list": { "type": "string" }, "CreatedTS": { "type": "integer" }, "tags": { "type": "object", "additionalProperties": {}, "properties": { "sfmc_remote_id": { "type": "string" } } }, "delivery_stats": { "type": "object", "properties": { "all": { "type": "object", "properties": { "delivered": { "type": "integer" }, "missing": { "type": "integer" }, "pending": { "type": "integer" }, "spam": { "type": "integer" }, "inbox": { "type": "integer" }, "total": { "type": "integer" }, "provider": { "type": "string" }, "categories": { "type": "object", "properties": { "primary": { "type": "integer" }, "promotions": { "type": "integer" }, "updates": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary", "promotions", "updates" ] } }, "additionalProperties": false, "required": [ "categories", "delivered", "inbox", "missing", "pending", "provider", "spam", "total" ] } }, "additionalProperties": false, "required": [ "all" ] }, "SeedQuality": { "type": "integer" }, "is_auto_generated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "AccountID", "CreatedTS", "ID", "Id", "SeedQuality", "Seeds", "created_at", "delivery_stats", "has_results", "is_auto_generated", "kid", "last_result_at", "mailing_list", "name", "seed_filter", "sending_domains", "tags", "target_email", "updated_at" ] } }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "paging", "total" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SeedListAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "Id": { "type": "string" }, "kid": { "type": "string" }, "ID": { "type": "string" }, "AccountID": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_result_at": { "type": "string" }, "Seeds": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "AccountID": { "type": "string" }, "id": { "type": "string" }, "token": { "type": "string" }, "email": { "type": "string" }, "provider": { "type": "string" }, "sync_state": { "type": "string" }, "local_state": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "message_count": { "type": "integer" }, "max_email_count_hit_at": { "type": "string" }, "total_msgs": { "type": "integer" }, "matched_msgs": { "type": "integer" }, "spam_message": { "type": "integer" }, "expected_msgs": { "type": "integer" }, "last_sent_to_at": { "type": "string" }, "last_delivered_at": { "type": "string" }, "account_quality": { "type": "integer" }, "quality_label": { "type": "string" }, "password": { "type": "string" }, "phone_number": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": {} }, "totp": { "type": "object", "properties": { "secret": { "type": "string" } }, "additionalProperties": false, "required": [ "secret" ] } }, "additionalProperties": false, "required": [ "AccountID", "account_quality", "attributes", "created_at", "email", "expected_msgs", "id", "last_delivered_at", "last_sent_to_at", "local_state", "matched_msgs", "max_email_count_hit_at", "message_count", "password", "phone_number", "provider", "quality_label", "spam_message", "sync_state", "token", "total_msgs", "totp", "updated_at" ] } }, { "type": "null" } ] }, "target_email": { "type": "string" }, "sending_domains": { "type": "array", "items": { "type": "string" } }, "has_results": { "type": "boolean" }, "name": { "type": "string" }, "seed_filter": { "type": "string" }, "mailing_list": { "type": "string" }, "CreatedTS": { "type": "integer" }, "tags": { "type": "object", "additionalProperties": {}, "properties": { "sfmc_remote_id": { "type": "string" } } }, "delivery_stats": { "type": "object", "properties": { "all": { "type": "object", "properties": { "delivered": { "type": "integer" }, "missing": { "type": "integer" }, "pending": { "type": "integer" }, "spam": { "type": "integer" }, "inbox": { "type": "integer" }, "total": { "type": "integer" }, "provider": { "type": "string" }, "categories": { "type": "object", "properties": { "primary": { "type": "integer" }, "promotions": { "type": "integer" }, "updates": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary", "promotions", "updates" ] } }, "additionalProperties": false, "required": [ "categories", "delivered", "inbox", "missing", "pending", "provider", "spam", "total" ] } }, "additionalProperties": false, "required": [ "all" ] }, "SeedQuality": { "type": "integer" }, "is_auto_generated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "AccountID", "CreatedTS", "ID", "Id", "SeedQuality", "Seeds", "created_at", "delivery_stats", "has_results", "is_auto_generated", "kid", "last_result_at", "mailing_list", "name", "seed_filter", "sending_domains", "tags", "target_email", "updated_at" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SeedListGetAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "seedlist": { "type": "object", "properties": { "Id": { "type": "string" }, "kid": { "type": "string" }, "ID": { "type": "string" }, "AccountID": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_result_at": { "type": "string" }, "Seeds": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "AccountID": { "type": "string" }, "id": { "type": "string" }, "token": { "type": "string" }, "email": { "type": "string" }, "provider": { "type": "string" }, "sync_state": { "type": "string" }, "local_state": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "message_count": { "type": "integer" }, "max_email_count_hit_at": { "type": "string" }, "total_msgs": { "type": "integer" }, "matched_msgs": { "type": "integer" }, "spam_message": { "type": "integer" }, "expected_msgs": { "type": "integer" }, "last_sent_to_at": { "type": "string" }, "last_delivered_at": { "type": "string" }, "account_quality": { "type": "integer" }, "quality_label": { "type": "string" }, "password": { "type": "string" }, "phone_number": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": {} }, "totp": { "type": "object", "properties": { "secret": { "type": "string" } }, "additionalProperties": false, "required": [ "secret" ] } }, "additionalProperties": false, "required": [ "AccountID", "account_quality", "attributes", "created_at", "email", "expected_msgs", "id", "last_delivered_at", "last_sent_to_at", "local_state", "matched_msgs", "max_email_count_hit_at", "message_count", "password", "phone_number", "provider", "quality_label", "spam_message", "sync_state", "token", "total_msgs", "totp", "updated_at" ] } }, { "type": "null" } ] }, "target_email": { "type": "string" }, "sending_domains": { "type": "array", "items": { "type": "string" } }, "has_results": { "type": "boolean" }, "name": { "type": "string" }, "seed_filter": { "type": "string" }, "mailing_list": { "type": "string" }, "CreatedTS": { "type": "integer" }, "tags": { "type": "object", "additionalProperties": {}, "properties": { "sfmc_remote_id": { "type": "string" } } }, "delivery_stats": { "type": "object", "properties": { "all": { "type": "object", "properties": { "delivered": { "type": "integer" }, "missing": { "type": "integer" }, "pending": { "type": "integer" }, "spam": { "type": "integer" }, "inbox": { "type": "integer" }, "total": { "type": "integer" }, "provider": { "type": "string" }, "categories": { "type": "object", "properties": { "primary": { "type": "integer" }, "promotions": { "type": "integer" }, "updates": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary", "promotions", "updates" ] } }, "additionalProperties": false, "required": [ "categories", "delivered", "inbox", "missing", "pending", "provider", "spam", "total" ] } }, "additionalProperties": false, "required": [ "all" ] }, "SeedQuality": { "type": "integer" }, "is_auto_generated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "AccountID", "CreatedTS", "ID", "Id", "SeedQuality", "Seeds", "created_at", "delivery_stats", "has_results", "is_auto_generated", "kid", "last_result_at", "mailing_list", "name", "seed_filter", "sending_domains", "tags", "target_email", "updated_at" ] } }, "additionalProperties": false, "required": [ "seedlist" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SeedsListsDestroyApiResponse": { "type": "object", "properties": { "body": { "type": "null" }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsResultAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "result": { "type": "object", "properties": { "Id": { "type": "string" }, "rid": { "type": "string" }, "result_id": { "type": "string" }, "AccountID": { "type": "string" }, "KeyBoxID": { "type": "string" }, "keybox_email": { "type": "string" }, "subject": { "type": "string" }, "sender": { "type": "string" }, "seedlist_name": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "CreatedTS": { "type": "integer" }, "attributes": { "type": "object", "additionalProperties": {} }, "campaign_id": { "type": "string" }, "sharing_enabled": { "type": "boolean" }, "sharing_id": { "type": "string" }, "sharing_expires_at": { "type": "string" }, "Box": { "type": "object", "properties": { "Id": { "type": "string" }, "kid": { "type": "string" }, "ID": { "type": "string" }, "AccountID": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_result_at": { "type": "string" }, "Seeds": { "type": "null" }, "target_email": { "type": "string" }, "sending_domains": { "type": "null" }, "has_results": { "type": "boolean" }, "name": { "type": "string" }, "seed_filter": { "type": "string" }, "mailing_list": { "type": "string" }, "CreatedTS": { "type": "integer" }, "tags": { "type": "array", "items": { "type": "string" } }, "SeedQuality": { "type": "integer" }, "is_auto_generated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "AccountID", "CreatedTS", "ID", "Id", "SeedQuality", "Seeds", "created_at", "has_results", "is_auto_generated", "kid", "last_result_at", "mailing_list", "name", "seed_filter", "sending_domains", "tags", "target_email", "updated_at" ] }, "seed_results": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "provider": { "type": "string" }, "destination": { "type": "string" }, "state": { "type": "string" }, "originating_ip": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "dkim": { "type": "string" }, "spf": { "type": "string" }, "dmarc": { "type": "string" }, "headers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false, "required": [ "key", "value" ] } }, "extensions": { "type": "object", "properties": { "category": { "type": "string" } }, "additionalProperties": false, "required": [ "category" ] } }, "additionalProperties": false, "required": [ "destination", "dkim", "dmarc", "email", "extensions", "headers", "originating_ip", "provider", "spf", "state", "tags" ] } }, "spamassassin": { "type": "object", "properties": { "is_spam": { "type": "boolean" }, "score": { "type": "integer" }, "required": { "type": "integer" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "points": { "type": "integer" }, "short_description": { "type": "string" }, "long_description": { "type": "string" } }, "additionalProperties": false, "required": [ "long_description", "name", "points", "short_description" ] } } }, "additionalProperties": false, "required": [ "is_spam", "required", "rules", "score" ] }, "delivery_stats": { "type": "object", "additionalProperties": { "type": "object", "properties": { "delivered": { "type": "integer" }, "missing": { "type": "integer" }, "pending": { "type": "integer" }, "spam": { "type": "integer" }, "inbox": { "type": "integer" }, "total": { "type": "integer" }, "provider": { "type": "string" }, "categories": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "primary": { "type": "integer" }, "updates": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary", "updates" ] } ] } }, "additionalProperties": false, "required": [ "categories", "delivered", "inbox", "missing", "pending", "provider", "spam", "total" ] } } }, "additionalProperties": false, "required": [ "AccountID", "Box", "CreatedTS", "Id", "KeyBoxID", "attributes", "campaign_id", "created_at", "delivery_stats", "keybox_email", "result_id", "rid", "seed_results", "seedlist_name", "sender", "sharing_enabled", "sharing_expires_at", "sharing_id", "spamassassin", "status", "subject", "updated_at" ] } }, "additionalProperties": false, "required": [ "result" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsResultsListAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string" }, "rid": { "type": "string" }, "result_id": { "type": "string" }, "AccountID": { "type": "string" }, "KeyBoxID": { "type": "string" }, "keybox_email": { "type": "string" }, "subject": { "type": "string" }, "sender": { "type": "string" }, "seedlist_name": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "CreatedTS": { "type": "integer" }, "attributes": { "type": "object", "additionalProperties": {} }, "campaign_id": { "type": "string" }, "sharing_enabled": { "type": "boolean" }, "sharing_id": { "type": "string" }, "sharing_expires_at": { "type": "string" }, "Box": { "type": "object", "properties": { "Id": { "type": "string" }, "kid": { "type": "string" }, "ID": { "type": "string" }, "AccountID": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_result_at": { "type": "string" }, "Seeds": { "type": "null" }, "target_email": { "type": "string" }, "sending_domains": { "type": "null" }, "has_results": { "type": "boolean" }, "name": { "type": "string" }, "seed_filter": { "type": "string" }, "mailing_list": { "type": "string" }, "CreatedTS": { "type": "integer" }, "tags": { "type": "array", "items": { "type": "string" } }, "SeedQuality": { "type": "integer" }, "is_auto_generated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "AccountID", "CreatedTS", "ID", "Id", "SeedQuality", "Seeds", "created_at", "has_results", "is_auto_generated", "kid", "last_result_at", "mailing_list", "name", "seed_filter", "sending_domains", "tags", "target_email", "updated_at" ] }, "seed_results": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "provider": { "type": "string" }, "destination": { "type": "string" }, "state": { "type": "string" }, "originating_ip": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "dkim": { "type": "string" }, "spf": { "type": "string" }, "dmarc": { "type": "string" }, "headers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false, "required": [ "key", "value" ] } }, "extensions": { "type": "object", "properties": { "category": { "type": "string" } }, "additionalProperties": false, "required": [ "category" ] } }, "additionalProperties": false, "required": [ "destination", "dkim", "dmarc", "email", "extensions", "headers", "originating_ip", "provider", "spf", "state", "tags" ] } }, "spamassassin": { "type": "object", "properties": { "is_spam": { "type": "boolean" }, "score": { "type": "integer" }, "required": { "type": "integer" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "points": { "type": "integer" }, "short_description": { "type": "string" }, "long_description": { "type": "string" } }, "additionalProperties": false, "required": [ "long_description", "name", "points", "short_description" ] } } }, "additionalProperties": false, "required": [ "is_spam", "required", "rules", "score" ] }, "delivery_stats": { "type": "object", "additionalProperties": { "type": "object", "properties": { "delivered": { "type": "integer" }, "missing": { "type": "integer" }, "pending": { "type": "integer" }, "spam": { "type": "integer" }, "inbox": { "type": "integer" }, "total": { "type": "integer" }, "provider": { "type": "string" }, "categories": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "primary": { "type": "integer" }, "updates": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary", "updates" ] } ] } }, "additionalProperties": false, "required": [ "categories", "delivered", "inbox", "missing", "pending", "provider", "spam", "total" ] } } }, "additionalProperties": false, "required": [ "AccountID", "Box", "CreatedTS", "Id", "KeyBoxID", "attributes", "campaign_id", "created_at", "delivery_stats", "keybox_email", "result_id", "rid", "seed_results", "seedlist_name", "sender", "sharing_enabled", "sharing_expires_at", "sharing_id", "spamassassin", "status", "subject", "updated_at" ] } }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "paging", "total" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsDestroyAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "Message": { "type": "string" } }, "additionalProperties": false, "required": [ "Message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "IPRSharingAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "sharing": { "type": "object", "properties": { "result_id": { "type": "string" }, "expires_at": { "type": "string" }, "enabled": { "type": "boolean" }, "url_id": { "type": "string" }, "url": { "type": "string" }, "api_url": { "type": "string" } }, "additionalProperties": false, "required": [ "api_url", "enabled", "expires_at", "result_id", "url", "url_id" ] } }, "additionalProperties": false, "required": [ "sharing" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "IPRSharingUpdateAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "sharing": { "type": "object", "properties": { "result_id": { "type": "string" }, "expires_at": { "type": "string" }, "enabled": { "type": "boolean" }, "url_id": { "type": "string" }, "url": { "type": "string" }, "api_url": { "type": "string" } }, "additionalProperties": false, "required": [ "api_url", "enabled", "expires_at", "result_id", "url", "url_id" ] } }, "additionalProperties": false, "required": [ "sharing" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InboxPlacementsProvidersListAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "display_name": { "type": "string" }, "region": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "max_email_count": { "type": "integer" }, "unsupported_authentications": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false, "required": [ "created_at", "display_name", "domain", "region", "updated_at" ] } } }, "additionalProperties": false, "required": [ "items" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MultipleValidationJobsListResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] }, "jobs": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer" }, "id": { "type": "string" }, "quantity": { "type": "integer" }, "records_processed": { "type": [ "null", "integer" ] }, "status": { "type": "string" }, "download_url": { "type": "object", "properties": { "csv": { "type": "string" }, "json": { "type": "string" } }, "additionalProperties": false, "required": [ "csv", "json" ] }, "summary": { "type": "object", "properties": { "result": { "type": "object", "properties": { "catch_all": { "type": "integer" }, "deliverable": { "type": "integer" }, "do_not_send": { "type": "integer" }, "undeliverable": { "type": "integer" }, "unknown": { "type": "integer" } }, "additionalProperties": false, "required": [ "catch_all", "deliverable", "do_not_send", "undeliverable", "unknown" ] }, "risk": { "type": "object", "properties": { "high": { "type": "integer" }, "low": { "type": "integer" }, "medium": { "type": "integer" }, "unknown": { "type": "integer" } }, "additionalProperties": false, "required": [ "high", "low", "medium", "unknown" ] } }, "additionalProperties": false, "required": [ "result", "risk" ] } }, "additionalProperties": false, "required": [ "created_at", "id", "quantity", "records_processed", "status" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "jobs", "paging", "total" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ValidationResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "address": { "type": "string" }, "is_disposable_address": { "type": "boolean" }, "is_role_address": { "type": "boolean" }, "reason": { "type": "array", "items": { "type": "string" } }, "result": { "type": "string" }, "risk": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "is_disposable_address", "is_role_address", "reason", "result", "risk" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "IpPoolListResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "ip_pools": { "type": "object", "properties": { "description": { "type": "string" }, "ips": { "type": "array", "items": { "type": "string" } }, "is_linked": { "type": "boolean" }, "name": { "type": "string" }, "pool_id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "ips", "is_linked", "name", "pool_id" ] }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "ip_pools", "message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "IpPoolMessageResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "IpPoolCreateResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "message": { "type": "string" }, "pool_id": { "type": "string" } }, "additionalProperties": false, "required": [ "message", "pool_id" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MetricsAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "dimensions": { "type": "array", "items": { "type": "object", "properties": { "dimension": { "type": "string" }, "value": { "type": "string" }, "display_value": { "type": "string" } }, "additionalProperties": false, "required": [ "dimension", "display_value", "value" ] } }, "metrics": { "type": "object", "properties": { "accepted_outgoing_count": { "type": "integer" }, "delivered_smtp_count": { "type": "integer" }, "accepted_count": { "type": "integer" }, "delivered_http_count": { "type": "integer" }, "accepted_incoming_count": { "type": "integer" }, "delivered_optimized_count": { "type": "integer" }, "stored_count": { "type": "integer" }, "delivered_count": { "type": "integer" }, "processed_count": { "type": "integer" }, "sent_count": { "type": "integer" }, "opened_count": { "type": "integer" }, "unique_opened_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "unique_clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "permanent_failed_count": { "type": "integer" }, "failed_count": { "type": "integer" }, "rate_limit_count": { "type": "integer" }, "unsubscribed_count": { "type": "integer" }, "temporary_failed_count": { "type": "integer" }, "permanent_failed_optimized_count": { "type": "integer" }, "bounced_count": { "type": "integer" }, "esp_block_count": { "type": "integer" }, "webhook_count": { "type": "integer" }, "delayed_bounce_count": { "type": "integer" }, "soft_bounces_count": { "type": "integer" }, "permanent_failed_old_count": { "type": "integer" }, "suppressed_bounces_count": { "type": "integer" }, "delivered_subsequent_count": { "type": "integer" }, "delivered_rate": { "type": "string" }, "delayed_first_attempt_count": { "type": "integer" }, "unsubscribed_rate": { "type": "string" }, "delivered_first_attempt_count": { "type": "integer" }, "opened_rate": { "type": "string" }, "suppressed_complaints_count": { "type": "integer" }, "delivered_two_plus_attempts_count": { "type": "integer" }, "hard_bounces_count": { "type": "integer" }, "suppressed_unsubscribed_count": { "type": "integer" }, "unique_opened_rate": { "type": "string" }, "fail_rate": { "type": "string" }, "complained_rate": { "type": "string" }, "clicked_rate": { "type": "string" }, "unique_clicked_rate": { "type": "string" }, "bounce_rate": { "type": "string" }, "delayed_rate": { "type": "string" }, "permanent_fail_rate": { "type": "string" }, "temporary_fail_rate": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "dimensions", "metrics" ] } }, "resolution": { "type": "string" }, "start": { "type": "string" }, "aggregates": { "type": "object", "properties": { "metrics": { "type": "object", "properties": { "accepted_outgoing_count": { "type": "integer" }, "delivered_smtp_count": { "type": "integer" }, "accepted_count": { "type": "integer" }, "delivered_http_count": { "type": "integer" }, "accepted_incoming_count": { "type": "integer" }, "delivered_optimized_count": { "type": "integer" }, "stored_count": { "type": "integer" }, "delivered_count": { "type": "integer" }, "processed_count": { "type": "integer" }, "sent_count": { "type": "integer" }, "opened_count": { "type": "integer" }, "unique_opened_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "unique_clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "permanent_failed_count": { "type": "integer" }, "failed_count": { "type": "integer" }, "rate_limit_count": { "type": "integer" }, "unsubscribed_count": { "type": "integer" }, "temporary_failed_count": { "type": "integer" }, "permanent_failed_optimized_count": { "type": "integer" }, "bounced_count": { "type": "integer" }, "esp_block_count": { "type": "integer" }, "webhook_count": { "type": "integer" }, "delayed_bounce_count": { "type": "integer" }, "soft_bounces_count": { "type": "integer" }, "permanent_failed_old_count": { "type": "integer" }, "suppressed_bounces_count": { "type": "integer" }, "delivered_subsequent_count": { "type": "integer" }, "delivered_rate": { "type": "string" }, "delayed_first_attempt_count": { "type": "integer" }, "unsubscribed_rate": { "type": "string" }, "delivered_first_attempt_count": { "type": "integer" }, "opened_rate": { "type": "string" }, "suppressed_complaints_count": { "type": "integer" }, "delivered_two_plus_attempts_count": { "type": "integer" }, "hard_bounces_count": { "type": "integer" }, "suppressed_unsubscribed_count": { "type": "integer" }, "unique_opened_rate": { "type": "string" }, "fail_rate": { "type": "string" }, "complained_rate": { "type": "string" }, "clicked_rate": { "type": "string" }, "unique_clicked_rate": { "type": "string" }, "bounce_rate": { "type": "string" }, "delayed_rate": { "type": "string" }, "permanent_fail_rate": { "type": "string" }, "temporary_fail_rate": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "metrics" ] }, "dimensions": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "limit", "skip", "sort", "total" ] }, "end": { "type": "string" }, "duration": { "type": "string" } }, "additionalProperties": false, "required": [ "aggregates", "dimensions", "end", "items", "pagination", "resolution", "start" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "DomainTagStatAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "tag": { "type": "string" }, "description": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "resolution": { "$ref": "#/definitions/Resolution" }, "stats": { "type": "array", "items": { "type": "object", "properties": { "time": { "type": "string" }, "accepted": { "type": "object", "properties": { "incoming": { "type": "integer" }, "outgoing": { "type": "integer" }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "incoming", "outgoing", "total" ] }, "delivered": { "type": "object", "properties": { "smtp": { "type": "integer" }, "http": { "type": "integer" }, "optimized": { "type": "integer" }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "http", "optimized", "smtp", "total" ] }, "opened": { "type": "object", "properties": { "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "total" ] }, "failed": { "type": "object", "properties": { "temporary": { "type": "object", "properties": { "espblock": { "type": "integer" }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "espblock", "total" ] }, "permanent": { "type": "object", "properties": { "suppress-bounce": { "type": "integer" }, "suppress-unsubscribe": { "type": "integer" }, "suppress-complaint": { "type": "integer" }, "bounce": { "type": "integer" }, "delayed-bounce": { "type": "integer" }, "webhook": { "type": "integer" }, "optimized": { "type": "integer" }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "bounce", "delayed-bounce", "optimized", "suppress-bounce", "suppress-complaint", "suppress-unsubscribe", "total", "webhook" ] } }, "additionalProperties": false, "required": [ "permanent", "temporary" ] }, "clicked": { "type": "object", "properties": { "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "total" ] }, "unsubscribed": { "type": "object", "properties": { "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "total" ] }, "complained": { "type": "object", "properties": { "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "total" ] }, "stored": { "type": "object", "properties": { "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "total" ] } }, "additionalProperties": false, "required": [ "time" ] } } }, "additionalProperties": false, "required": [ "description", "end", "resolution", "start", "stats", "tag" ] } }, "additionalProperties": false, "required": [ "body" ], "definitions": { "Resolution": { "type": "string", "enum": [ "hour", "day", "month" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "DomainTagCountriesAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "tag": { "type": "string" }, "country": { "type": "object", "additionalProperties": { "type": "object", "properties": { "clicked": { "type": "integer" }, "complained": { "type": "integer" }, "opened": { "type": "integer" }, "unique_clicked": { "type": "integer" }, "unique_opened": { "type": "integer" }, "unsubscribed": { "type": "integer" } }, "additionalProperties": false, "required": [ "clicked", "complained", "opened", "unique_clicked", "unique_opened", "unsubscribed" ] } } }, "additionalProperties": false, "required": [ "country", "tag" ] } }, "additionalProperties": false, "required": [ "body" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "DomainTagProvidersAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "tag": { "type": "string" }, "provider": { "type": "object", "additionalProperties": { "type": "object", "properties": { "accepted": { "type": "integer" }, "clicked": { "type": "integer" }, "complained": { "type": "integer" }, "delivered": { "type": "integer" }, "opened": { "type": "integer" }, "unique_clicked": { "type": "integer" }, "unique_opened": { "type": "integer" }, "unsubscribed": { "type": "integer" } }, "additionalProperties": false, "required": [ "accepted", "clicked", "complained", "delivered", "opened", "unique_clicked", "unique_opened", "unsubscribed" ] } } }, "additionalProperties": false, "required": [ "provider", "tag" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "DomainTagDevicesAPIResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "tag": { "type": "string" }, "device": { "type": "object", "properties": { "desktop": { "type": "object", "properties": { "clicked": { "type": "integer" }, "complained": { "type": "integer" }, "opened": { "type": "integer" }, "unique_clicked": { "type": "integer" }, "unique_opened": { "type": "integer" }, "unsubscribed": { "type": "integer" } }, "additionalProperties": false, "required": [ "clicked", "complained", "opened", "unique_clicked", "unique_opened", "unsubscribed" ] }, "mobile": { "type": "object", "properties": { "clicked": { "type": "integer" }, "complained": { "type": "integer" }, "opened": { "type": "integer" }, "unique_clicked": { "type": "integer" }, "unique_opened": { "type": "integer" }, "unsubscribed": { "type": "integer" } }, "additionalProperties": false, "required": [ "clicked", "complained", "opened", "unique_clicked", "unique_opened", "unsubscribed" ] }, "tablet": { "type": "object", "properties": { "clicked": { "type": "integer" }, "complained": { "type": "integer" }, "opened": { "type": "integer" }, "unique_clicked": { "type": "integer" }, "unique_opened": { "type": "integer" }, "unsubscribed": { "type": "integer" } }, "additionalProperties": false, "required": [ "clicked", "complained", "opened", "unique_clicked", "unique_opened", "unsubscribed" ] }, "unknown": { "type": "object", "properties": { "clicked": { "type": "integer" }, "complained": { "type": "integer" }, "opened": { "type": "integer" }, "unique_clicked": { "type": "integer" }, "unique_opened": { "type": "integer" }, "unsubscribed": { "type": "integer" } }, "additionalProperties": false, "required": [ "clicked", "complained", "opened", "unique_clicked", "unique_opened", "unsubscribed" ] } }, "additionalProperties": false, "required": [ "desktop", "mobile", "tablet", "unknown" ] } }, "additionalProperties": false, "required": [ "device", "tag" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateDomainTemplateAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" }, "template": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate" } }, "additionalProperties": false, "required": [ "message", "template" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "definitions": { "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "createdBy": { "type": "string" }, "id": { "type": "string" }, "version": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag" ] } } }, "additionalProperties": false, "required": [ "createdAt", "createdBy", "description", "id", "name" ] }, "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion": { "additionalProperties": false, "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "template": { "type": "string" }, "headers": { "type": "object", "properties": { "From": { "type": "string" }, "Reply-To": { "type": "string" }, "Subject": { "type": "string" } }, "additionalProperties": false } }, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag", "template" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListDomainTemplatesAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate" } }, "paging": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" }, "previous": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] } }, "additionalProperties": false, "required": [ "items", "paging" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "definitions": { "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "createdBy": { "type": "string" }, "id": { "type": "string" }, "version": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag" ] } } }, "additionalProperties": false, "required": [ "createdAt", "createdBy", "description", "id", "name" ] }, "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion": { "additionalProperties": false, "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "template": { "type": "string" }, "headers": { "type": "object", "properties": { "From": { "type": "string" }, "Reply-To": { "type": "string" }, "Subject": { "type": "string" } }, "additionalProperties": false } }, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag", "template" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDomainTemplateAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "template": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate" } }, "additionalProperties": false, "required": [ "template" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "definitions": { "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "createdBy": { "type": "string" }, "id": { "type": "string" }, "version": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag" ] } } }, "additionalProperties": false, "required": [ "createdAt", "createdBy", "description", "id", "name" ] }, "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion": { "additionalProperties": false, "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "template": { "type": "string" }, "headers": { "type": "object", "properties": { "From": { "type": "string" }, "Reply-To": { "type": "string" }, "Subject": { "type": "string" } }, "additionalProperties": false } }, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag", "template" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateOrDeleteDomainTemplateAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" }, "template": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ] } }, "additionalProperties": false, "required": [ "message", "template" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "NotificationAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateDomainTemplateVersionAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" }, "template": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate" } }, "additionalProperties": false, "required": [ "message", "template" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "definitions": { "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Interfaces/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).IDomainTemplate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "createdBy": { "type": "string" }, "id": { "type": "string" }, "version": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag" ] } } }, "additionalProperties": false, "required": [ "createdAt", "createdBy", "description", "id", "name" ] }, "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Domains/DomainTemplates\",{with:{\"resolution-mode\":\"import\"}}).TemplateVersion": { "additionalProperties": false, "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" }, "template": { "type": "string" }, "headers": { "type": "object", "properties": { "From": { "type": "string" }, "Reply-To": { "type": "string" }, "Subject": { "type": "string" } }, "additionalProperties": false } }, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag", "template" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MutateDomainTemplateVersionAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" }, "template": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "object", "properties": { "tag": { "type": "string" } }, "additionalProperties": false, "required": [ "tag" ] } }, "additionalProperties": false, "required": [ "name", "version" ] } }, "additionalProperties": false, "required": [ "message", "template" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ListDomainTemplateVersionsAPIResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "template": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "string" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "engine": { "type": "string" }, "mjml": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "comment": { "type": "string" }, "active": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "comment", "createdAt", "engine", "id", "mjml", "tag" ] } } }, "additionalProperties": false, "required": [ "createdAt", "createdBy", "description", "id", "name", "versions" ] }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] } }, "additionalProperties": false, "required": [ "paging", "template" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "DomainTrackingResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "tracking": { "type": "object", "properties": { "click": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false, "required": [ "active" ] }, "open": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false, "required": [ "active" ] }, "unsubscribe": { "type": "object", "properties": { "active": { "type": "boolean" }, "html_footer": { "type": "string" }, "text_footer": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "html_footer", "text_footer" ] } }, "additionalProperties": false, "required": [ "click", "open", "unsubscribe" ] } }, "additionalProperties": false, "required": [ "tracking" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdateDomainTrackingResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "body": { "type": "object", "properties": { "message": { "type": "string" }, "open": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false, "required": [ "active" ] }, "click": { "type": "object", "properties": { "active": { "enum": [ false, "htmlonly", true ] } }, "additionalProperties": false, "required": [ "active" ] }, "unsubscribe": { "type": "object", "properties": { "active": { "type": "boolean" }, "html_footer": { "type": "string" }, "text_footer": { "type": "string" } }, "additionalProperties": false, "required": [ "active", "html_footer", "text_footer" ] } }, "additionalProperties": false, "required": [ "message" ] } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GetDomainTrackingCertificateResponse": { "type": "object", "properties": { "responseStatusCode": { "type": "integer" }, "status": { "type": "string" }, "error": { "type": "string" }, "certificate": { "type": "string" } }, "additionalProperties": false, "required": [ "certificate", "error", "responseStatusCode", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GenerateDomainTrackingCertificateResponse": { "type": "object", "properties": { "message": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "location", "message", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "RegenerateDomainTrackingCertificateResponse": { "type": "object", "properties": { "message": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "location", "message", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "EventsResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "array", "minItems": 0, "maxItems": 0 }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] } }, "additionalProperties": false, "required": [ "items", "paging" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MailingListValidationResponse": { "type": "object", "properties": { "status": { "type": "string" }, "download_url": { "type": "object", "properties": { "csv": { "type": "string" }, "json": { "type": "string" } }, "additionalProperties": false, "required": [ "csv", "json" ] }, "id": { "type": "string" }, "quantity": { "type": "integer" }, "records_processed": { "type": "integer" }, "summary": { "type": "object", "properties": { "result": { "type": "object", "properties": { "catch_all": { "type": "integer" }, "deliverable": { "type": "integer" }, "do_not_send": { "type": "integer" }, "undeliverable": { "type": "integer" }, "unknown": { "type": "integer" } }, "additionalProperties": false, "required": [ "catch_all", "deliverable", "do_not_send", "undeliverable", "unknown" ] }, "risk": { "type": "object", "properties": { "high": { "type": "integer" }, "low": { "type": "integer" }, "medium": { "type": "integer" }, "unknown": { "type": "integer" } }, "additionalProperties": false, "required": [ "high", "low", "medium", "unknown" ] } }, "additionalProperties": false, "required": [ "result", "risk" ] } }, "additionalProperties": false, "required": [ "download_url", "id", "quantity", "records_processed", "status", "summary" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MailingListValidationApiResponse": { "additionalProperties": false, "type": "object", "properties": { "status": { "type": "string" }, "download_url": { "type": "object", "properties": { "csv": { "type": "string" }, "json": { "type": "string" } }, "additionalProperties": false, "required": [ "csv", "json" ] }, "id": { "type": "string" }, "quantity": { "type": "integer" }, "records_processed": { "type": "integer" }, "summary": { "type": "object", "properties": { "result": { "type": "object", "properties": { "catch_all": { "type": "integer" }, "deliverable": { "type": "integer" }, "do_not_send": { "type": "integer" }, "undeliverable": { "type": "integer" }, "unknown": { "type": "integer" } }, "additionalProperties": false, "required": [ "catch_all", "deliverable", "do_not_send", "undeliverable", "unknown" ] }, "risk": { "type": "object", "properties": { "high": { "type": "integer" }, "low": { "type": "integer" }, "medium": { "type": "integer" }, "unknown": { "type": "integer" } }, "additionalProperties": false, "required": [ "high", "low", "medium", "unknown" ] } }, "additionalProperties": false, "required": [ "result", "risk" ] }, "created_at": { "type": "integer" } }, "required": [ "created_at", "download_url", "id", "quantity", "records_processed", "status", "summary" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MailingListApiResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "access_level": { "type": "string" }, "address": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "members_count": { "type": "integer" }, "name": { "type": "string" }, "reply_preference": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "access_level", "address", "created_at", "description", "members_count", "name", "reply_preference" ] } }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] } }, "additionalProperties": false, "required": [ "items", "paging" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "NewMultipleMembersResponse": { "type": "object", "properties": { "list": { "type": "object", "properties": { "access_level": { "type": "string" }, "address": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "members_count": { "type": "integer" }, "name": { "type": "string" }, "reply_preference": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "access_level", "address", "created_at", "description", "members_count", "name", "reply_preference" ] }, "message": { "type": "string" }, "task-id": { "type": "string" } }, "additionalProperties": false, "required": [ "list", "message", "task-id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MailListMembersResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "name": { "type": "string" }, "subscribed": { "type": "boolean" }, "vars": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "address", "name", "subscribed", "vars" ] } }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] } }, "additionalProperties": false, "required": [ "items", "paging" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SuppressionListResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "items": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "code": { "type": "integer" }, "error": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "address", "code", "created_at", "error" ] } }, { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "address", "created_at" ] } }, { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "tags": {}, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "address", "created_at", "tags" ] } }, { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "reason": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "createdAt", "reason", "type", "value" ] } } ] }, "paging": { "type": "object", "properties": { "previous": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" } }, "additionalProperties": false, "required": [ "first", "last", "next", "previous" ] } }, "additionalProperties": false, "required": [ "items", "paging" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SuppressionResponse": { "type": "object", "properties": { "body": { "$ref": "#/definitions/import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Suppressions/Suppressions\",{with:{\"resolution-mode\":\"import\"}}).SuppressionDataType" }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "definitions": { "import(\"/home/cyber/Dokumenty/git-projects/private/spacebar-test-station/server/node_modules/mailgun.js/Types/Types/Suppressions/Suppressions\",{with:{\"resolution-mode\":\"import\"}}).SuppressionDataType": { "anyOf": [ { "type": "object", "properties": { "address": { "type": "string" }, "code": { "type": "integer" }, "error": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "address", "code", "created_at", "error" ] }, { "type": "object", "properties": { "address": { "type": "string" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "address", "created_at" ] }, { "type": "object", "properties": { "address": { "type": "string" }, "tags": {}, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "address", "created_at", "tags" ] }, { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "reason": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ] } }, "additionalProperties": false, "required": [ "createdAt", "reason", "type", "value" ] } ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SuppressionDestroyResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "message": { "type": "string" }, "value": { "type": "string" }, "address": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SuppressionCreationResponse": { "type": "object", "properties": { "body": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] }, "status": { "type": "integer" } }, "additionalProperties": false, "required": [ "body", "status" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "LibraryResponse": { "type": "object", "properties": { "response": { "$ref": "#/definitions/AxiosResponse" }, "body": { "$ref": "#/definitions/Body" } }, "additionalProperties": false, "required": [ "body", "response" ], "definitions": { "AxiosResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/Body" }, "status": { "type": "integer" }, "statusText": { "type": "string" }, "headers": { "anyOf": [ { "$ref": "#/definitions/Partial" }, { "$ref": "#/definitions/AxiosResponseHeaders" } ] }, "config": { "$ref": "#/definitions/InternalAxiosRequestConfig" }, "request": {} }, "additionalProperties": false, "required": [ "config", "data", "headers", "status", "statusText" ] }, "Body": { "type": "object", "additionalProperties": false }, "Partial": { "type": "object", "properties": { "Cache-Control": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Content-Encoding": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Content-Length": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Content-Type": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Server": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "set-cookie": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AxiosHeaders": { "type": "object", "additionalProperties": {} }, "AxiosResponseHeaders": { "additionalProperties": false, "properties": {} }, "InternalAxiosRequestConfig": { "type": "object", "properties": { "headers": { "$ref": "#/definitions/AxiosRequestHeaders" }, "url": { "type": "string" }, "method": { "type": "string" }, "baseURL": { "type": "string" }, "allowAbsoluteUrls": { "type": "boolean" }, "transformRequest": { "anyOf": [ { "$ref": "#/definitions/AxiosRequestTransformer" }, { "type": "array", "items": { "$ref": "#/definitions/AxiosRequestTransformer" } } ] }, "transformResponse": { "anyOf": [ { "$ref": "#/definitions/AxiosResponseTransformer" }, { "type": "array", "items": { "$ref": "#/definitions/AxiosResponseTransformer" } } ] }, "params": {}, "paramsSerializer": { "anyOf": [ { "$ref": "#/definitions/CustomParamsSerializer" }, { "$ref": "#/definitions/ParamsSerializerOptions" } ] }, "data": {}, "timeout": { "type": "integer" }, "timeoutErrorMessage": { "type": "string" }, "withCredentials": { "type": "boolean" }, "adapter": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": {} }, { "$ref": "#/definitions/AxiosAdapter" }, { "type": "array", "items": { "$ref": "#/definitions/AxiosAdapterConfig" } }, { "enum": [ "fetch", "http", "xhr" ], "type": "string" } ] }, "auth": { "$ref": "#/definitions/AxiosBasicCredentials" }, "responseType": { "enum": [ "arraybuffer", "blob", "document", "formdata", "json", "stream", "text" ], "type": "string" }, "responseEncoding": { "type": "string" }, "xsrfCookieName": { "type": "string" }, "xsrfHeaderName": { "type": "string" }, "onUploadProgress": { "type": "object", "additionalProperties": false }, "onDownloadProgress": { "type": "object", "additionalProperties": false }, "maxContentLength": { "type": "integer" }, "validateStatus": { "anyOf": [ { "type": "object", "additionalProperties": false }, { "type": "null" } ] }, "maxBodyLength": { "type": "integer" }, "maxRedirects": { "type": "integer" }, "maxRate": { "anyOf": [ { "type": "array", "items": [ { "type": "integer" }, { "type": "integer" } ], "minItems": 2, "maxItems": 2 }, { "type": "integer" } ] }, "beforeRedirect": { "type": "object", "additionalProperties": false }, "socketPath": { "type": [ "null", "string" ] }, "transport": {}, "httpAgent": {}, "httpsAgent": {}, "proxy": { "anyOf": [ { "$ref": "#/definitions/AxiosProxyConfig" }, { "const": false, "type": "boolean" } ] }, "cancelToken": { "$ref": "#/definitions/CancelToken" }, "decompress": { "type": "boolean" }, "transitional": { "$ref": "#/definitions/TransitionalOptions" }, "signal": { "$ref": "#/definitions/GenericAbortSignal" }, "insecureHTTPParser": { "type": "boolean" }, "env": { "type": "object", "properties": { "FormData": { "type": "object", "additionalProperties": false }, "fetch": { "type": "object", "additionalProperties": false }, "Request": { "type": "object", "additionalProperties": false }, "Response": { "type": "object", "additionalProperties": false } }, "additionalProperties": false }, "formSerializer": { "$ref": "#/definitions/FormSerializerOptions" }, "family": { "$ref": "#/definitions/AddressFamily" }, "lookup": { "anyOf": [ { "type": "object", "additionalProperties": false }, { "type": "object", "additionalProperties": false } ] }, "withXSRFToken": { "anyOf": [ { "type": "object", "additionalProperties": false }, { "type": "boolean" } ] }, "fetchOptions": { "anyOf": [ { "$ref": "#/definitions/Record" }, { "$ref": "#/definitions/Omit" } ] } }, "additionalProperties": false, "required": [ "headers" ] }, "AxiosRequestHeaders": { "additionalProperties": false, "properties": { "Accept": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Authorization": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Content-Encoding": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Content-Length": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "User-Agent": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] }, "Content-Type": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/definitions/AxiosHeaders" }, { "type": [ "null", "string", "integer", "boolean" ] } ] } } }, "AxiosRequestTransformer": { "type": "object", "additionalProperties": false }, "AxiosResponseTransformer": { "type": "object", "additionalProperties": false }, "CustomParamsSerializer": { "type": "object", "additionalProperties": false }, "ParamsSerializerOptions": { "type": "object", "properties": { "encode": { "$ref": "#/definitions/ParamEncoder" }, "serialize": { "$ref": "#/definitions/CustomParamsSerializer" }, "visitor": { "$ref": "#/definitions/SerializerVisitor" }, "dots": { "type": "boolean" }, "metaTokens": { "type": "boolean" }, "indexes": { "type": [ "null", "boolean" ] } }, "additionalProperties": false }, "ParamEncoder": { "type": "object", "additionalProperties": false }, "SerializerVisitor": { "type": "object", "additionalProperties": false }, "AxiosAdapter": { "type": "object", "additionalProperties": false }, "AxiosAdapterConfig": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": {} }, { "$ref": "#/definitions/AxiosAdapter" }, { "enum": [ "fetch", "http", "xhr" ], "type": "string" } ] }, "AxiosBasicCredentials": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false, "required": [ "password", "username" ] }, "AxiosProxyConfig": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "auth": { "$ref": "#/definitions/AxiosBasicCredentials" }, "protocol": { "type": "string" } }, "additionalProperties": false, "required": [ "host", "port" ] }, "CancelToken": { "type": "object", "properties": { "promise": { "$ref": "#/definitions/Promise" }, "reason": { "$ref": "#/definitions/Cancel" } }, "additionalProperties": false, "required": [ "promise" ] }, "Promise": { "type": "object", "properties": { "__@toStringTag@1311": { "type": "string" } }, "additionalProperties": false, "required": [ "__@toStringTag@1311" ] }, "Cancel": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] }, "TransitionalOptions": { "type": "object", "properties": { "silentJSONParsing": { "type": "boolean" }, "forcedJSONParsing": { "type": "boolean" }, "clarifyTimeoutError": { "type": "boolean" } }, "additionalProperties": false }, "GenericAbortSignal": { "type": "object", "properties": { "aborted": { "type": "boolean" }, "onabort": { "anyOf": [ { "type": "object", "additionalProperties": false }, { "type": "null" } ] }, "addEventListener": { "type": "object", "additionalProperties": false }, "removeEventListener": { "type": "object", "additionalProperties": false } }, "additionalProperties": false, "required": [ "aborted" ] }, "FormSerializerOptions": { "type": "object", "properties": { "visitor": { "$ref": "#/definitions/SerializerVisitor" }, "dots": { "type": "boolean" }, "metaTokens": { "type": "boolean" }, "indexes": { "type": [ "null", "boolean" ] } }, "additionalProperties": false }, "AddressFamily": { "enum": [ 4, 6 ], "type": "number" }, "Record": { "type": "object", "additionalProperties": false }, "Omit": { "type": "object", "properties": { "credentials": { "enum": [ "include", "omit", "same-origin" ], "type": "string" }, "cache": { "enum": [ "default", "force-cache", "no-cache", "no-store", "only-if-cached", "reload" ], "type": "string" }, "dispatcher": { "description": "Dispatcher is the core API used to dispatch requests.", "$ref": "#/definitions/default" }, "duplex": { "const": "half", "type": "string" }, "integrity": { "type": "string" }, "keepalive": { "type": "boolean" }, "mode": { "enum": [ "cors", "navigate", "no-cors", "same-origin" ], "type": "string" }, "redirect": { "enum": [ "error", "follow", "manual" ], "type": "string" }, "referrer": { "type": "string" }, "referrerPolicy": { "enum": [ "", "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url" ], "type": "string" }, "window": { "type": "null" } }, "additionalProperties": false }, "default": { "description": "Dispatcher is the core API used to dispatch requests.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "LibraryLocalResponse": { "type": "object", "properties": { "body": { "$ref": "#/definitions/Data" }, "params": { "$ref": "#/definitions/Params" }, "url": { "type": "string" } }, "additionalProperties": false, "required": [ "body", "params", "url" ], "definitions": { "Data": { "type": "object", "additionalProperties": false }, "Params": { "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "JobResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/BulkContactManagement.Job" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "BulkContactManagement.Job": { "type": "object", "properties": { "JobID": { "type": "integer" } }, "additionalProperties": false, "required": [ "JobID" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CSVImportResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/BulkContactManagement.CSVImport" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "BulkContactManagement.CSVImport": { "type": "object", "properties": { "ID": { "type": "integer" }, "ErrTreshold": { "type": "integer" }, "ImportOptions": { "type": "string" }, "Method": { "$ref": "#/definitions/BulkContactManagement.ImportCSVMethod" }, "AliveAt": { "type": "string" }, "ContactsListID": { "type": "integer" }, "Count": { "type": "integer" }, "Current": { "type": "integer" }, "DataID": { "type": "integer" }, "Errcount": { "type": "integer" }, "JobEnd": { "type": "string" }, "JobStart": { "type": "string" }, "RequestAt": { "type": "string" }, "Status": { "$ref": "#/definitions/BulkContactManagement.CSVImportStatus" } }, "additionalProperties": false, "required": [ "AliveAt", "ContactsListID", "Count", "Current", "DataID", "ErrTreshold", "Errcount", "ID", "ImportOptions", "JobEnd", "JobStart", "Method", "RequestAt", "Status" ] }, "BulkContactManagement.ImportCSVMethod": { "type": "string", "enum": [ "addforce", "addnoforce", "remove", "unsub", "excludemarketing", "includemarketing" ] }, "BulkContactManagement.CSVImportStatus": { "type": "string", "enum": [ "Upload", "Completed", "Abort" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ListRecipientResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ContactSubscription.ListRecipient" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "ContactSubscription.ListRecipient": { "type": "object", "properties": { "ID": { "type": "integer" }, "IsUnsubscribed": { "type": "boolean" }, "ContactID": { "type": "integer" }, "ListID": { "type": "integer" }, "ListName": { "type": "string" }, "SubscribedAt": { "type": "string" }, "UnsubscribedAt": { "type": "string" } }, "additionalProperties": false, "required": [ "ContactID", "ID", "IsUnsubscribed", "ListID", "ListName", "SubscribedAt", "UnsubscribedAt" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TemplateResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "additionalProperties": false, "type": "array", "properties": { "Author": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/definitions/Template.Categories" } }, "Copyright": { "type": "string" }, "Description": { "type": "string" }, "EditMode": { "$ref": "#/definitions/Template.EditMode" }, "IsStarred": { "type": "boolean" }, "IsTextPartGenerationEnabled": { "type": "boolean" }, "Locale": { "type": "string" }, "Name": { "type": "string" }, "OwnerType": { "$ref": "#/definitions/Template.OwnerType" }, "Presets": { "type": "string" }, "Purposes": { "type": "array", "items": { "$ref": "#/definitions/Template.Purposes" } }, "ID": { "type": "integer" }, "OwnerId": { "type": "integer" }, "Previews": { "type": "string" }, "CreatedAt": { "type": "string" }, "LastUpdatedAt": { "type": "string" } }, "required": [ "Author", "Categories", "Copyright", "CreatedAt", "Description", "EditMode", "ID", "IsStarred", "IsTextPartGenerationEnabled", "LastUpdatedAt", "Locale", "Name", "OwnerId", "OwnerType", "Presets", "Previews", "Purposes" ] } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "Template.Categories": { "type": "string", "enum": [ "full", "basic", "newsletter", "e-commerce", "events", "travel", "sports", "welcome", "contact-property-update", "support", "invoice", "anniversary", "account", "activation" ] }, "Template.EditMode": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "Template.OwnerType": { "type": "string", "enum": [ "apikey", "user", "global" ] }, "Template.Purposes": { "type": "string", "enum": [ "marketing", "transactional", "automation" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TemplateDetailContentResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "type": "object", "properties": { "Headers": { "$ref": "#/definitions/Template.Headers" }, "Html-part": { "type": "string" }, "Text-part": { "type": "string" }, "MJMLContent": { "type": "string" } }, "additionalProperties": false, "required": [ "Headers", "Html-part", "MJMLContent", "Text-part" ] } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "Template.Headers": { "type": "object", "properties": { "From": { "type": "string" }, "Subject": { "type": "string" }, "Reply-to": { "type": "string" } }, "additionalProperties": false, "required": [ "From", "Reply-to", "Subject" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "EventCallbackUrlResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/Webhook.EventCallbackUrl" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "Webhook.EventCallbackUrl": { "type": "object", "properties": { "ID": { "type": "integer" }, "EventType": { "$ref": "#/definitions/Webhook.EventType" }, "IsBackup": { "type": "boolean" }, "Status": { "$ref": "#/definitions/Webhook.Status" }, "APIKeyID": { "type": "integer" }, "Version": { "$ref": "#/definitions/Webhook.Version" }, "Url": { "type": "string" } }, "additionalProperties": false, "required": [ "APIKeyID", "EventType", "ID", "IsBackup", "Status", "Url", "Version" ] }, "Webhook.EventType": { "type": "string", "enum": [ "open", "click", "bounce", "spam", "blocked", "unsub", "sent" ] }, "Webhook.Status": { "type": "string", "enum": [ "dead", "alive" ] }, "Webhook.Version": { "enum": [ 1, 2 ], "type": "number" } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ParseRouteResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/Parse.ParseRoute" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "Parse.ParseRoute": { "type": "object", "properties": { "ID": { "type": "integer" }, "APIKeyID": { "type": "integer" }, "Email": { "type": "string" }, "Url": { "type": "string" } }, "additionalProperties": false, "required": [ "APIKeyID", "Email", "ID", "Url" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SenderResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/Sender.Sender" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "Sender.Sender": { "type": "object", "properties": { "ID": { "type": "integer" }, "EmailType": { "$ref": "#/definitions/Sender.EmailType" }, "IsDefaultSender": { "type": "boolean" }, "Name": { "type": "string" }, "CreatedAt": { "type": "string" }, "DNSID": { "type": "integer" }, "Email": { "type": "string" }, "Filename": { "type": "string" }, "Status": { "$ref": "#/definitions/Sender.SenderStatus" } }, "additionalProperties": false, "required": [ "CreatedAt", "DNSID", "Email", "EmailType", "Filename", "ID", "IsDefaultSender", "Name", "Status" ] }, "Sender.EmailType": { "type": "string", "enum": [ "transactional", "bulk", "unknown" ] }, "Sender.SenderStatus": { "type": "string", "enum": [ "Inactive", "Active", "Deleted" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MetaSenderResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/Metasender.MetaSender" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "Metasender.MetaSender": { "type": "object", "properties": { "ID": { "type": "integer" }, "Description": { "type": "string" }, "CreatedAt": { "type": "string" }, "Email": { "type": "string" }, "Filename": { "type": "string" }, "IsEnabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "CreatedAt", "Description", "Email", "Filename", "ID", "IsEnabled" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ApiKeyResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/APIKeyConfiguration.ApiKey" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "APIKeyConfiguration.ApiKey": { "type": "object", "properties": { "ID": { "type": "integer" }, "ACL": { "type": "string" }, "IsActive": { "type": "boolean" }, "APIKey": { "type": "string" }, "CreatedAt": { "type": "string" }, "IsMaster": { "type": "boolean" }, "Name": { "type": "string" }, "QuarantineValue": { "type": "integer" }, "Runlevel": { "$ref": "#/definitions/APIKeyConfiguration.RunLevel" }, "SecretKey": { "type": "string" }, "TrackHost": { "type": "string" }, "UserID": { "type": "integer" } }, "additionalProperties": false, "required": [ "ACL", "APIKey", "CreatedAt", "ID", "IsActive", "IsMaster", "Name", "QuarantineValue", "Runlevel", "SecretKey", "TrackHost", "UserID" ] }, "APIKeyConfiguration.RunLevel": { "type": "string", "enum": [ "Normal", "Softlock", "Hardlock" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MyProfileResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/AccountSetting.MyProfile" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "AccountSetting.MyProfile": { "type": "object", "properties": { "ID": { "type": "integer" }, "AddressCity": { "type": "string" }, "AddressCountry": { "type": "string" }, "AddressPostalCode": { "type": "string" }, "AddressState": { "type": "string" }, "AddressStreet": { "type": "string" }, "BillingEmail": { "type": "string" }, "BirthdayAt": { "type": "string" }, "CompanyName": { "type": "string" }, "CompanyNumOfEmployees": { "type": "string" }, "ContactPhone": { "type": "string" }, "EstimatedVolume": { "type": "integer" }, "Features": { "type": "string" }, "Firstname": { "type": "string" }, "Industry": { "type": "integer" }, "JobTitle": { "type": "string" }, "Lastname": { "type": "string" }, "VATNumber": { "type": "string" }, "Website": { "type": "string" }, "VAT": { "type": "integer" }, "UserID": { "type": "integer" } }, "additionalProperties": false, "required": [ "AddressCity", "AddressCountry", "AddressPostalCode", "AddressState", "AddressStreet", "BillingEmail", "BirthdayAt", "CompanyName", "CompanyNumOfEmployees", "ContactPhone", "EstimatedVolume", "Features", "Firstname", "ID", "Industry", "JobTitle", "Lastname", "UserID", "VAT", "VATNumber", "Website" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserResponse": { "type": "object", "properties": { "Count": { "type": "integer" }, "Total": { "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/AccountSetting.User" } } }, "additionalProperties": false, "required": [ "Count", "Data", "Total" ], "definitions": { "AccountSetting.User": { "type": "object", "properties": { "ID": { "type": "integer" }, "ACL": { "type": "string" }, "Email": { "type": "string" }, "LastLoginAt": { "type": "string" }, "Locale": { "type": "string" }, "Timezone": { "type": "string" }, "CreatedAt": { "type": "string" }, "FirstIp": { "type": "string" }, "LastIp": { "type": "string" }, "MaxAllowedAPIKeys": { "type": "integer" }, "Username": { "type": "string" }, "WarnedRatelimitAt": { "type": "string" } }, "additionalProperties": false, "required": [ "ACL", "CreatedAt", "Email", "FirstIp", "ID", "LastIp", "LastLoginAt", "Locale", "MaxAllowedAPIKeys", "Timezone", "Username", "WarnedRatelimitAt" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "FieldErrorResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "errors": { "$ref": "#/definitions/Record" } }, "additionalProperties": false, "required": [ "code", "errors", "message" ], "definitions": { "Record": { "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "team_id": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationModifySchema": { "type": "object", "properties": { "description": { "type": "string" }, "icon": { "type": "string" }, "cover_image": { "type": "string" }, "interactions_endpoint_url": { "type": "string" }, "max_participants": { "type": [ "null", "integer" ] }, "name": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "role_connections_verification_url": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "terms_of_service_url": { "type": "string" }, "bot_public": { "type": "boolean" }, "bot_require_code_grant": { "type": "boolean" }, "flags": { "type": "integer" }, "custom_install_url": { "type": "string" }, "guild_id": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "SendableApplicationCommandDataSchema": { "type": "object", "properties": { "id": { "$ref": "#/definitions/Snowflake" }, "type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "name": { "type": "string" }, "version": { "$ref": "#/definitions/Snowflake" }, "application_command": { "type": "object", "properties": {}, "additionalProperties": true }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } }, "target_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "attachments": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "required": [ "id", "name", "version" ], "definitions": { "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false }, "ApplicationCommandOption": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ApplicationCommandOptionType" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "choices": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOptionChoice" } }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } } }, "additionalProperties": false, "required": [ "description", "name", "type" ] }, "ApplicationCommandOptionType": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ] }, "ApplicationCommandOptionChoice": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": [ "string", "integer" ] } }, "additionalProperties": false, "required": [ "name", "value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SendableMessageComponentDataSchema": { "type": "object", "properties": { "component_type": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "number" }, "type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "custom_id": { "type": "string" }, "values": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "$ref": "#/definitions/Snowflake" } } ] } }, "additionalProperties": false, "required": [ "custom_id" ], "definitions": { "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SendableModalSubmitDataSchema": { "type": "object", "properties": { "id": { "$ref": "#/definitions/Snowflake" }, "custom_id": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/UploadAttachmentRequestSchema" } } }, "additionalProperties": false, "required": [ "custom_id", "id" ], "definitions": { "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false }, "UploadAttachmentRequestSchema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/definitions/UploadAttachmentRequest" } } }, "additionalProperties": false, "required": [ "files" ] }, "UploadAttachmentRequest": { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "file_size": { "type": "integer" }, "is_clip": { "type": "boolean" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "file_size", "filename" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildProfileResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon_hash": { "type": [ "null", "string" ] }, "member_count": { "type": "integer" }, "online_count": { "type": "integer" }, "description": { "type": "string" }, "brand_color_primary": { "type": "string" }, "banner_hash": { "type": [ "null", "string" ] }, "game_application_ids": { "type": "array", "items": { "type": "string" } }, "game_activity": { "type": "object", "additionalProperties": { "$ref": "#/definitions/GameActivity" } }, "tag": { "type": [ "null", "string" ] }, "badge": { "$ref": "#/definitions/GuildBadgeType" }, "badge_color_primary": { "type": "string" }, "badge_color_secondary": { "type": "string" }, "badge_hash": { "type": "string" }, "traits": { "type": "array", "items": { "$ref": "#/definitions/GuildTrait" } }, "features": { "type": "array", "items": { "type": "string" } }, "visibility": { "$ref": "#/definitions/GuildVisibilityLevel" }, "custom_banner_hash": { "type": [ "null", "string" ] }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" } }, "additionalProperties": false, "required": [ "badge", "badge_color_primary", "badge_color_secondary", "badge_hash", "banner_hash", "brand_color_primary", "custom_banner_hash", "description", "features", "game_activity", "game_application_ids", "icon_hash", "id", "member_count", "name", "online_count", "premium_subscription_count", "premium_tier", "tag", "traits", "visibility" ], "definitions": { "GameActivity": { "type": "object", "properties": { "activity_level": { "type": "integer" }, "activity_score": { "type": "integer" } }, "additionalProperties": false, "required": [ "activity_level", "activity_score" ] }, "GuildBadgeType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 ] }, "GuildTrait": { "type": "object", "properties": { "emoji_id": { "type": [ "null", "string" ] }, "emoji_name": { "type": [ "null", "string" ] }, "emoji_animated": { "type": "boolean" }, "label": { "type": "string" }, "position": { "type": "integer" } }, "additionalProperties": false, "required": [ "emoji_animated", "emoji_id", "emoji_name", "label", "position" ] }, "GuildVisibilityLevel": { "type": "number", "enum": [ 1, 2, 3 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildAvailableSchema": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "available": { "type": "boolean" } }, "additionalProperties": false, "required": [ "available", "id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UserSettingsUpdateSchema": { "type": "object", "properties": { "afk_timeout": { "type": "integer" }, "allow_accessibility_detection": { "type": "boolean" }, "animate_emoji": { "type": "boolean" }, "animate_stickers": { "type": "integer" }, "contact_sync_enabled": { "type": "boolean" }, "convert_emoticons": { "type": "boolean" }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ] }, "default_guilds_restricted": { "type": "boolean" }, "detect_platform_accounts": { "type": "boolean" }, "developer_mode": { "type": "boolean" }, "disable_games_tab": { "type": "boolean" }, "enable_tts_command": { "type": "boolean" }, "explicit_content_filter": { "type": "integer" }, "friend_discovery_flags": { "type": "integer" }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean" }, "gif_auto_play": { "type": "boolean" }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" } }, "guild_positions": { "type": "array", "items": { "type": "string" } }, "inline_attachment_media": { "type": "boolean" }, "inline_embed_media": { "type": "boolean" }, "locale": { "type": "string" }, "message_display_compact": { "type": "boolean" }, "native_phone_integration_enabled": { "type": "boolean" }, "render_embeds": { "type": "boolean" }, "render_reactions": { "type": "boolean" }, "restricted_guilds": { "type": "array", "items": { "type": "string" } }, "show_current_game": { "type": "boolean" }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "stream_notifications_enabled": { "type": "boolean" }, "theme": { "enum": [ "dark", "light" ], "type": "string" }, "timezone_offset": { "type": "integer" }, "view_nsfw_guilds": { "type": "boolean" } }, "additionalProperties": false, "definitions": { "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserSettingsSchema": { "type": "object", "properties": { "afk_timeout": { "type": "integer" }, "allow_accessibility_detection": { "type": "boolean" }, "animate_emoji": { "type": "boolean" }, "animate_stickers": { "type": "integer" }, "contact_sync_enabled": { "type": "boolean" }, "convert_emoticons": { "type": "boolean" }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ] }, "default_guilds_restricted": { "type": "boolean" }, "detect_platform_accounts": { "type": "boolean" }, "developer_mode": { "type": "boolean" }, "disable_games_tab": { "type": "boolean" }, "enable_tts_command": { "type": "boolean" }, "explicit_content_filter": { "type": "integer" }, "friend_discovery_flags": { "type": "integer" }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean" }, "gif_auto_play": { "type": "boolean" }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" } }, "guild_positions": { "type": "array", "items": { "type": "string" } }, "inline_attachment_media": { "type": "boolean" }, "inline_embed_media": { "type": "boolean" }, "locale": { "type": "string" }, "message_display_compact": { "type": "boolean" }, "native_phone_integration_enabled": { "type": "boolean" }, "render_embeds": { "type": "boolean" }, "render_reactions": { "type": "boolean" }, "restricted_guilds": { "type": "array", "items": { "type": "string" } }, "show_current_game": { "type": "boolean" }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "stream_notifications_enabled": { "type": "boolean" }, "theme": { "enum": [ "dark", "light" ], "type": "string" }, "timezone_offset": { "type": "integer" }, "view_nsfw_guilds": { "type": "boolean" } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ], "definitions": { "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "IdentifySchema": { "type": "object", "properties": { "token": { "type": "string" }, "properties": { "type": "object", "properties": { "os": { "type": "string" }, "os_atch": { "type": "string" }, "browser": { "type": "string" }, "device": { "type": "string" }, "$os": { "type": "string" }, "$browser": { "type": "string" }, "$device": { "type": "string" }, "browser_user_agent": { "type": "string" }, "browser_version": { "type": "string" }, "os_version": { "type": "string" }, "referrer": { "type": "string" }, "referring_domain": { "type": "string" }, "referrer_current": { "type": "string" }, "referring_domain_current": { "type": "string" }, "release_channel": { "enum": [ "canary", "dev", "ptb", "stable" ], "type": "string" }, "client_build_number": { "type": "integer" }, "client_event_source": { "type": "string" }, "client_version": { "type": "string" }, "system_locale": { "type": "string" } }, "additionalProperties": false }, "intents": { "type": "bigint" }, "presence": { "$ref": "#/definitions/ActivitySchema" }, "compress": { "type": "boolean" }, "large_threshold": { "type": "integer" }, "largeThreshold": { "type": "integer" }, "shard": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "bigint" } }, "guild_subscriptions": { "type": "boolean" }, "capabilities": { "type": "integer" }, "client_state": { "type": "object", "properties": { "guild_hashes": {}, "highest_last_message_id": { "type": [ "string", "integer" ] }, "read_state_version": { "type": "integer" }, "user_guild_settings_version": { "type": "integer" }, "user_settings_version": { "type": "integer" }, "useruser_guild_settings_version": { "type": "integer" }, "private_channels_version": { "type": "integer" }, "guild_versions": {}, "api_code_version": { "type": "integer" }, "initial_guild_id": { "type": "string" } }, "additionalProperties": false }, "clientState": { "type": "object", "properties": { "guildHashes": {}, "highestLastMessageId": { "type": [ "string", "integer" ] }, "readStateVersion": { "type": "integer" }, "userGuildSettingsVersion": { "type": "integer" }, "useruserGuildSettingsVersion": { "type": "integer" }, "guildVersions": {}, "apiCodeVersion": { "type": "integer" }, "initialGuildId": { "type": "string" } }, "additionalProperties": false }, "v": { "type": "integer" } }, "additionalProperties": false, "required": [ "properties", "token" ], "definitions": { "ActivitySchema": { "type": "object", "properties": { "afk": { "type": "boolean" }, "status": { "$ref": "#/definitions/Status" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "since": { "type": "integer" } }, "additionalProperties": false, "required": [ "status" ] }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "StreamCreateSchema": { "type": "object", "properties": { "type": { "enum": [ "call", "guild" ], "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "preferred_region": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "type" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "StreamDeleteSchema": { "type": "object", "properties": { "stream_key": { "type": "string" } }, "additionalProperties": false, "required": [ "stream_key" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "StreamWatchSchema": { "type": "object", "properties": { "stream_key": { "type": "string" } }, "additionalProperties": false, "required": [ "stream_key" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIErrorResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "object", "properties": { "_errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "message" ] } } }, "additionalProperties": false, "required": [ "_errors" ] } } }, "additionalProperties": false, "required": [ "code", "errors", "message" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CaptchaRequiredResponse": { "type": "object", "properties": { "captcha_key": { "type": "string" }, "captcha_sitekey": { "type": "string" }, "captcha_service": { "type": "string" } }, "additionalProperties": false, "required": [ "captcha_key", "captcha_service", "captcha_sitekey" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIErrorOrCaptchaResponse": { "anyOf": [ { "$ref": "#/definitions/APIErrorResponse" }, { "$ref": "#/definitions/CaptchaRequiredResponse" } ], "definitions": { "APIErrorResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "object", "properties": { "_errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "message" ] } } }, "additionalProperties": false, "required": [ "_errors" ] } } }, "additionalProperties": false, "required": [ "code", "errors", "message" ] }, "CaptchaRequiredResponse": { "type": "object", "properties": { "captcha_key": { "type": "string" }, "captcha_sitekey": { "type": "string" }, "captcha_service": { "type": "string" } }, "additionalProperties": false, "required": [ "captcha_key", "captcha_service", "captcha_sitekey" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "AccountStandingResponse": { "type": "object", "properties": { "classifications": { "type": "array", "items": { "$ref": "#/definitions/Classification" } }, "guild_classifications": { "type": "array", "items": { "$ref": "#/definitions/GuildClassification" } }, "account_standing": { "type": "object", "properties": { "state": { "$ref": "#/definitions/AccountStandingState" } }, "additionalProperties": false, "required": [ "state" ] }, "is_dsa_eligible": { "type": "boolean" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "is_appeal_eligible": { "type": "boolean" }, "appeal_eligibility": { "type": "array", "items": { "$ref": "#/definitions/AppealEligibility" } } }, "additionalProperties": false, "required": [ "account_standing", "appeal_eligibility", "classifications", "discriminator", "guild_classifications", "is_appeal_eligible", "is_dsa_eligible", "username" ], "definitions": { "Classification": { "type": "object", "properties": { "id": { "type": "string" }, "classification_type": { "$ref": "#/definitions/ClassificationType" }, "description": { "type": "string" }, "explainer_link": { "type": "string" }, "actions": { "type": "array", "items": { "$ref": "#/definitions/ClassificationAction" } }, "max_expiration_time": { "type": "string" }, "flagged_content": { "type": "array", "items": {} }, "appeal_status": { "$ref": "#/definitions/AppealStatus" }, "is_coppa": { "type": "boolean" }, "is_spam": { "type": "boolean" }, "appeal_ingestion_type": { "$ref": "#/definitions/AppealIngestionType" } }, "additionalProperties": false, "required": [ "actions", "appeal_ingestion_type", "appeal_status", "classification_type", "description", "explainer_link", "flagged_content", "id", "is_coppa", "is_spam", "max_expiration_time" ] }, "ClassificationType": { "type": "number", "enum": [ 1, 100, 200, 210, 220, 230, 240, 250, 280, 290, 310, 320, 390, 600, 650, 711, 720, 3010, 3030, 4000, 4010, 4130, 4140, 5010, 5090, 5305, 5411, 5440, 5485 ] }, "ClassificationAction": { "type": "object", "properties": { "id": { "type": "string" }, "action_type": { "$ref": "#/definitions/ClassificationActionType" }, "descriptions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "action_type", "descriptions", "id" ] }, "ClassificationActionType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 20, 22 ] }, "AppealStatus": { "type": "object", "properties": { "status": { "$ref": "#/definitions/AppealStatusValue" } }, "additionalProperties": false, "required": [ "status" ] }, "AppealStatusValue": { "type": "number", "enum": [ 1, 2, 3 ] }, "AppealIngestionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "GuildClassification": { "type": "object", "properties": { "guild_metadata": { "$ref": "#/definitions/GuildMetadata" }, "id": { "type": "string" }, "classification_type": { "$ref": "#/definitions/ClassificationType" }, "description": { "type": "string" }, "explainer_link": { "type": "string" }, "actions": { "type": "array", "items": { "$ref": "#/definitions/ClassificationAction" } }, "max_expiration_time": { "type": "string" }, "flagged_content": { "type": "array", "items": {} }, "appeal_status": { "$ref": "#/definitions/AppealStatus" }, "is_coppa": { "type": "boolean" }, "is_spam": { "type": "boolean" }, "appeal_ingestion_type": { "$ref": "#/definitions/AppealIngestionType" } }, "additionalProperties": false, "required": [ "actions", "appeal_ingestion_type", "appeal_status", "classification_type", "description", "explainer_link", "flagged_content", "guild_metadata", "id", "is_coppa", "is_spam", "max_expiration_time" ] }, "GuildMetadata": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "member_type": { "$ref": "#/definitions/GuildMemberType" } }, "additionalProperties": false, "required": [ "member_type", "name" ] }, "GuildMemberType": { "type": "number", "enum": [ 1, 2 ] }, "AccountStandingState": { "type": "number", "enum": [ 100, 200, 300, 400, 500 ] }, "AppealEligibility": { "type": "number", "enum": [ 1, 2, 3 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "BackupCodesChallengeResponse": { "type": "object", "properties": { "nonce": { "type": "string" }, "regenerate_nonce": { "type": "string" } }, "additionalProperties": false, "required": [ "nonce", "regenerate_nonce" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CollectiblesCategoriesResponse": { "type": "array", "items": { "$ref": "#/definitions/CollectiblesCategoryItem" }, "definitions": { "CollectiblesCategoryItem": { "type": "object", "properties": { "sku_id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "store_listing_id": { "type": "string" }, "banner": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "styles": { "$ref": "#/definitions/CollectiblesCategoryStyle" }, "logo": { "type": "string" }, "hero_ranking": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "mobile_bg": { "type": [ "null", "string" ] }, "pdp_bg": { "type": [ "null", "string" ] }, "success_modal_bg": { "type": [ "null", "string" ] }, "mobile_banner": { "type": [ "null", "string" ] }, "featured_block": { "type": [ "null", "string" ] }, "hero_banner": { "type": [ "null", "string" ] }, "wide_banner": { "type": [ "null", "string" ] }, "hero_logo": { "type": [ "null", "string" ] }, "products": { "type": "array", "items": { "$ref": "#/definitions/CollectiblesCategoryProductItem" } }, "banner_asset": { "$ref": "#/definitions/StaticAnimatedAsset" }, "hero_banner_asset": { "$ref": "#/definitions/StaticAnimatedAsset" } }, "additionalProperties": false, "required": [ "banner", "featured_block", "hero_banner", "hero_logo", "hero_ranking", "logo", "mobile_banner", "mobile_bg", "name", "pdp_bg", "products", "sku_id", "store_listing_id", "styles", "success_modal_bg", "summary", "unpublished_at", "wide_banner" ] }, "CollectiblesCategoryStyle": { "type": "object", "properties": { "background_colors": { "type": "array", "items": { "type": "integer" } }, "button_colors": { "type": "array", "items": { "type": "integer" } }, "confetti_colors": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false, "required": [ "background_colors", "button_colors", "confetti_colors" ] }, "CollectiblesCategoryProductItem": { "type": "object", "properties": { "sku_id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "store_listing_id": { "type": "string" }, "banner": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "styles": { "$ref": "#/definitions/CollectiblesCategoryStyle" }, "prices": { "type": "object", "additionalProperties": { "type": "object", "properties": { "country_prices": { "$ref": "#/definitions/CountryPrice" } }, "additionalProperties": false, "required": [ "country_prices" ] } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ProductItem" } }, "type": { "type": "integer" }, "premium_type": { "type": "integer" }, "category_sku_id": { "type": "string" }, "google_sku_ids": { "type": "object", "additionalProperties": { "type": "string" } }, "variants": { "type": "array", "items": { "$ref": "#/definitions/ProductItemVariant" } } }, "additionalProperties": false, "required": [ "banner", "category_sku_id", "google_sku_ids", "items", "name", "premium_type", "prices", "sku_id", "store_listing_id", "styles", "summary", "type", "unpublished_at" ] }, "CountryPrice": { "type": "object", "properties": { "country_code": { "type": "string" }, "prices": { "type": "array", "items": { "$ref": "#/definitions/PriceEntry" } } }, "additionalProperties": false, "required": [ "country_code", "prices" ] }, "PriceEntry": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "exponent": { "type": "integer" } }, "additionalProperties": false, "required": [ "amount", "currency", "exponent" ] }, "ProductItem": { "type": "object", "properties": { "type": { "type": "integer" }, "id": { "type": "string" }, "sku_id": { "type": "string" }, "asset": { "type": "string" }, "label": { "type": "string" }, "palette": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "sku_id", "type" ] }, "ProductItemVariant": { "type": "object", "properties": { "sku_id": { "type": "string" }, "name": { "type": "string" }, "name_localizations": { "type": "null" }, "summary": { "type": "string" }, "summary_localizations": { "type": "null" }, "store_listing_id": { "type": "string" }, "banner": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "styles": { "$ref": "#/definitions/CollectiblesCategoryStyle" }, "prices": { "type": "object", "additionalProperties": { "type": "object", "properties": { "country_prices": { "$ref": "#/definitions/CountryPrice" } }, "additionalProperties": false, "required": [ "country_prices" ] } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ProductItem" } }, "type": { "type": "integer" }, "premium_type": { "type": "integer" }, "category_sku_id": { "type": "string" }, "google_sku_ids": { "type": "object", "additionalProperties": { "type": "string" } }, "base_variant_sku_id": { "type": "string" }, "base_variant_name": { "type": "string" }, "variant_label": { "type": "string" }, "variant_value": { "type": "string" } }, "additionalProperties": false, "required": [ "base_variant_name", "base_variant_sku_id", "category_sku_id", "items", "name", "name_localizations", "premium_type", "prices", "sku_id", "store_listing_id", "summary", "summary_localizations", "type", "variant_label", "variant_value" ] }, "StaticAnimatedAsset": { "type": "object", "properties": { "animated": { "type": [ "null", "string" ] }, "static": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "static" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CollectiblesMarketingResponse": { "type": "object", "properties": { "marketings": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CollectiblesMarketingItem" } } }, "additionalProperties": false, "required": [ "marketings" ], "definitions": { "CollectiblesMarketingItem": { "type": "object", "properties": { "type": { "type": "integer" }, "version": { "type": "integer" }, "title": { "type": "string" }, "body": { "type": "string" } }, "additionalProperties": false, "required": [ "body", "title", "type", "version" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CollectiblesShopResponse": { "type": "object", "properties": { "shop_blocks": { "type": "array", "items": { "$ref": "#/definitions/AnyShopBlock" } }, "categories": { "type": "array", "items": { "$ref": "#/definitions/CollectiblesCategoryItem" } } }, "additionalProperties": false, "required": [ "categories", "shop_blocks" ], "definitions": { "AnyShopBlock": { "anyOf": [ { "$ref": "#/definitions/ItemRowShopBlock" }, { "$ref": "#/definitions/BundleTileRowShopBlock" }, { "$ref": "#/definitions/ItemCollectionShopBlock" } ] }, "ItemRowShopBlock": { "type": "object", "properties": { "type": { "type": "integer", "const": 0 }, "category_sku_id": { "type": "string" }, "name": { "type": "string" }, "category_store_listing_id": { "type": "string" }, "banner_asset": { "$ref": "#/definitions/StaticAnimatedAsset" }, "logo_url": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "summary": { "type": "string" }, "ranked_sku_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "banner_asset", "category_sku_id", "category_store_listing_id", "logo_url", "name", "ranked_sku_ids", "summary", "type", "unpublished_at" ] }, "StaticAnimatedAsset": { "type": "object", "properties": { "animated": { "type": [ "null", "string" ] }, "static": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "static" ] }, "BundleTileRowShopBlock": { "type": "object", "properties": { "type": { "type": "integer", "const": 1 }, "subblocks": { "type": "array", "items": { "$ref": "#/definitions/ShopBlockSubBlock" } } }, "additionalProperties": false, "required": [ "subblocks", "type" ] }, "ShopBlockSubBlock": { "type": "object", "properties": { "type": { "type": "integer" }, "category_store_listing_id": { "type": "string" }, "name": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "banner_url": { "type": "string" }, "body_text": { "type": [ "null", "string" ] }, "banner_text_color": { "type": [ "null", "integer" ] } }, "additionalProperties": false, "required": [ "banner_text_color", "banner_url", "body_text", "category_store_listing_id", "name", "type", "unpublished_at" ] }, "ItemCollectionShopBlock": { "type": "object", "properties": { "type": { "type": "integer", "const": 2 }, "ranked_sku_ids": { "type": "array", "items": { "type": "string" } }, "sorted_sku_ids": { "type": "object", "properties": { "recommended": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "popular": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "popular", "recommended" ] } }, "additionalProperties": false, "required": [ "ranked_sku_ids", "sorted_sku_ids", "type" ] }, "CollectiblesCategoryItem": { "type": "object", "properties": { "sku_id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "store_listing_id": { "type": "string" }, "banner": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "styles": { "$ref": "#/definitions/CollectiblesCategoryStyle" }, "logo": { "type": "string" }, "hero_ranking": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "mobile_bg": { "type": [ "null", "string" ] }, "pdp_bg": { "type": [ "null", "string" ] }, "success_modal_bg": { "type": [ "null", "string" ] }, "mobile_banner": { "type": [ "null", "string" ] }, "featured_block": { "type": [ "null", "string" ] }, "hero_banner": { "type": [ "null", "string" ] }, "wide_banner": { "type": [ "null", "string" ] }, "hero_logo": { "type": [ "null", "string" ] }, "products": { "type": "array", "items": { "$ref": "#/definitions/CollectiblesCategoryProductItem" } }, "banner_asset": { "$ref": "#/definitions/StaticAnimatedAsset" }, "hero_banner_asset": { "$ref": "#/definitions/StaticAnimatedAsset" } }, "additionalProperties": false, "required": [ "banner", "featured_block", "hero_banner", "hero_logo", "hero_ranking", "logo", "mobile_banner", "mobile_bg", "name", "pdp_bg", "products", "sku_id", "store_listing_id", "styles", "success_modal_bg", "summary", "unpublished_at", "wide_banner" ] }, "CollectiblesCategoryStyle": { "type": "object", "properties": { "background_colors": { "type": "array", "items": { "type": "integer" } }, "button_colors": { "type": "array", "items": { "type": "integer" } }, "confetti_colors": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false, "required": [ "background_colors", "button_colors", "confetti_colors" ] }, "CollectiblesCategoryProductItem": { "type": "object", "properties": { "sku_id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "store_listing_id": { "type": "string" }, "banner": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "styles": { "$ref": "#/definitions/CollectiblesCategoryStyle" }, "prices": { "type": "object", "additionalProperties": { "type": "object", "properties": { "country_prices": { "$ref": "#/definitions/CountryPrice" } }, "additionalProperties": false, "required": [ "country_prices" ] } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ProductItem" } }, "type": { "type": "integer" }, "premium_type": { "type": "integer" }, "category_sku_id": { "type": "string" }, "google_sku_ids": { "type": "object", "additionalProperties": { "type": "string" } }, "variants": { "type": "array", "items": { "$ref": "#/definitions/ProductItemVariant" } } }, "additionalProperties": false, "required": [ "banner", "category_sku_id", "google_sku_ids", "items", "name", "premium_type", "prices", "sku_id", "store_listing_id", "styles", "summary", "type", "unpublished_at" ] }, "CountryPrice": { "type": "object", "properties": { "country_code": { "type": "string" }, "prices": { "type": "array", "items": { "$ref": "#/definitions/PriceEntry" } } }, "additionalProperties": false, "required": [ "country_code", "prices" ] }, "PriceEntry": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "exponent": { "type": "integer" } }, "additionalProperties": false, "required": [ "amount", "currency", "exponent" ] }, "ProductItem": { "type": "object", "properties": { "type": { "type": "integer" }, "id": { "type": "string" }, "sku_id": { "type": "string" }, "asset": { "type": "string" }, "label": { "type": "string" }, "palette": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "sku_id", "type" ] }, "ProductItemVariant": { "type": "object", "properties": { "sku_id": { "type": "string" }, "name": { "type": "string" }, "name_localizations": { "type": "null" }, "summary": { "type": "string" }, "summary_localizations": { "type": "null" }, "store_listing_id": { "type": "string" }, "banner": { "type": "string" }, "unpublished_at": { "type": [ "null", "string" ] }, "styles": { "$ref": "#/definitions/CollectiblesCategoryStyle" }, "prices": { "type": "object", "additionalProperties": { "type": "object", "properties": { "country_prices": { "$ref": "#/definitions/CountryPrice" } }, "additionalProperties": false, "required": [ "country_prices" ] } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ProductItem" } }, "type": { "type": "integer" }, "premium_type": { "type": "integer" }, "category_sku_id": { "type": "string" }, "google_sku_ids": { "type": "object", "additionalProperties": { "type": "string" } }, "base_variant_sku_id": { "type": "string" }, "base_variant_name": { "type": "string" }, "variant_label": { "type": "string" }, "variant_value": { "type": "string" } }, "additionalProperties": false, "required": [ "base_variant_name", "base_variant_sku_id", "category_sku_id", "items", "name", "name_localizations", "premium_type", "prices", "sku_id", "store_listing_id", "summary", "summary_localizations", "type", "variant_label", "variant_value" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "DiscoverableGuildsResponse": { "type": "object", "properties": { "total": { "type": "integer" }, "guilds": { "type": "array", "items": { "$ref": "#/definitions/Guild" } }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false, "required": [ "guilds", "limit", "offset", "total" ], "definitions": { "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "DmMessagesResponseSchema": { "type": "array", "items": { "$ref": "#/definitions/PartialMessage" }, "definitions": { "PartialMessage": { "description": "https://docs.discord.food/resources/message#partial-message-structure", "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "channel_id": { "type": "string" }, "type": { "$ref": "#/definitions/MessageType" }, "content": { "type": "string" }, "author": { "$ref": "#/definitions/PartialUser" }, "flags": { "type": "integer" }, "application_id": { "type": "string" } }, "additionalProperties": false, "required": [ "author", "channel_id", "content", "id", "type" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "PartialUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "global_name": { "type": [ "null", "string" ] }, "avatar": { "type": [ "null", "string" ] }, "avatar_decoration_data": { "anyOf": [ { "$ref": "#/definitions/AvatarDecorationData" }, { "type": "null" } ] }, "collectibles": { "anyOf": [ { "$ref": "#/definitions/Collectibles" }, { "type": "null" } ] }, "display_name_styles": { "anyOf": [ { "$ref": "#/definitions/DisplayNameStyle" }, { "type": "null" } ] }, "primary_guild": { "anyOf": [ { "$ref": "#/definitions/PrimaryGuild" }, { "type": "null" } ] }, "bot": { "type": "boolean" }, "system": { "type": "boolean" }, "banner": { "type": [ "null", "string" ] }, "accent_color": { "type": [ "null", "integer" ] }, "public_flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "avatar", "discriminator", "id", "username" ] }, "AvatarDecorationData": { "type": "object", "properties": { "asset": { "type": "string" }, "sku_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "expires_at": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "asset", "expires_at", "sku_id" ] }, "Collectibles": { "type": "object", "properties": { "nameplate": { "anyOf": [ { "$ref": "#/definitions/NameplateData" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "nameplate" ] }, "NameplateData": { "type": "object", "properties": { "asset": { "type": "string" }, "sku_id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "label": { "type": "string" }, "palette": { "type": "string" }, "expires_at": { "type": [ "null", "integer" ] } }, "additionalProperties": false, "required": [ "asset", "expires_at", "label", "palette", "sku_id" ] }, "DisplayNameStyle": { "type": "object", "properties": { "font_id": { "type": "integer" }, "effect_id": { "type": "integer" }, "colors": { "type": "integer" } }, "additionalProperties": false, "required": [ "colors", "effect_id", "font_id" ] }, "PrimaryGuild": { "type": "object", "properties": { "identity_enabled": { "type": [ "null", "boolean" ] }, "identity_guild_id": { "type": [ "null", "string" ] }, "tag": { "type": [ "null", "string" ] }, "badge": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "badge", "identity_enabled", "identity_guild_id", "tag" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "EmailDomainLookupResponse": { "type": "object", "properties": { "guilds_info": { "type": "array", "items": { "$ref": "#/definitions/HubGuild" } }, "has_matching_guild": { "type": "boolean" } }, "additionalProperties": false, "required": [ "guilds_info", "has_matching_guild" ], "definitions": { "HubGuild": { "type": "object", "properties": { "icon": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "icon", "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "EmailDomainLookupVerifyCodeResponse": { "type": "object", "properties": { "guild": { "$ref": "#/definitions/Guild" }, "joined": { "type": "boolean" } }, "additionalProperties": false, "required": [ "guild", "joined" ], "definitions": { "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "EmojiSourceResponse": { "type": "object", "properties": { "type": { "enum": [ "APPLICATION", "GUILD" ], "type": "string" }, "guild": { "anyOf": [ { "$ref": "#/definitions/EmojiGuild" }, { "type": "null" } ] }, "application": { "anyOf": [ { "$ref": "#/definitions/EmojiApplication" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "type" ], "definitions": { "EmojiGuild": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "features": { "type": "array", "items": { "type": "string" } }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "premium_tier": { "type": "integer" }, "premium_subscription_count": { "type": "integer" }, "approximate_member_count": { "type": "integer" }, "approximate_presence_count": { "type": "integer" } }, "additionalProperties": false, "required": [ "emojis", "features", "id", "name", "premium_tier" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "EmojiApplication": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GatewayBotResponse": { "type": "object", "properties": { "url": { "type": "string" }, "shards": { "type": "integer" }, "session_start_limit": { "type": "object", "properties": { "total": { "type": "integer" }, "remaining": { "type": "integer" }, "reset_after": { "type": "integer" }, "max_concurrency": { "type": "integer" } }, "additionalProperties": false, "required": [ "max_concurrency", "remaining", "reset_after", "total" ] } }, "additionalProperties": false, "required": [ "session_start_limit", "shards", "url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GatewayResponse": { "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": false, "required": [ "url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GenerateRegistrationTokensResponse": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "tokens" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildBansResponse": { "type": "object", "properties": { "reason": { "type": [ "null", "string" ] }, "user": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "id": { "type": "string" }, "avatar": { "type": [ "null", "string" ] }, "public_flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "avatar", "discriminator", "id", "public_flags", "username" ] } }, "additionalProperties": false, "required": [ "reason", "user" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildCreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "primary_category_id": { "type": "string" }, "large": { "type": "boolean" }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "template_id": { "type": "string" }, "mfa_level": { "type": "integer" }, "owner_id": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen" }, "widget_channel_id": { "type": "string" }, "widget_enabled": { "type": "boolean" }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean" }, "parent": { "type": "string" }, "region": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "banner": { "type": [ "null", "string" ] }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" }, "guild_template_code": { "type": "string" }, "staff_only": { "type": "boolean" }, "splash": { "type": [ "null", "string" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": "string" }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": "string" }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "safety_alerts_channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "id", "name", "nsfw", "welcome_screen", "widget_enabled" ], "definitions": { "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildDiscoveryRequirementsResponse": { "type": "object", "properties": { "guild_id": { "type": "string" }, "safe_environment": { "type": "boolean" }, "healthy": { "type": "boolean" }, "health_score_pending": { "type": "boolean" }, "size": { "type": "boolean" }, "nsfw_properties": {}, "protected": { "type": "boolean" }, "sufficient": { "type": "boolean" }, "sufficient_without_grace_period": { "type": "boolean" }, "valid_rules_channel": { "type": "boolean" }, "retention_healthy": { "type": "boolean" }, "engagement_healthy": { "type": "boolean" }, "age": { "type": "boolean" }, "minimum_age": { "type": "integer" }, "health_score": { "type": "object", "properties": { "avg_nonnew_participators": { "type": "integer" }, "avg_nonnew_communicators": { "type": "integer" }, "num_intentful_joiners": { "type": "integer" }, "perc_ret_w1_intentful": { "type": "integer" } }, "additionalProperties": false, "required": [ "avg_nonnew_communicators", "avg_nonnew_participators", "num_intentful_joiners", "perc_ret_w1_intentful" ] }, "minimum_size": { "type": "integer" } }, "additionalProperties": false, "required": [ "age", "engagement_healthy", "guild_id", "health_score", "health_score_pending", "healthy", "minimum_age", "minimum_size", "nsfw_properties", "protected", "retention_healthy", "safe_environment", "size", "sufficient", "sufficient_without_grace_period", "valid_rules_channel" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildMessagesSearchResponse": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/definitions/GuildMessagesSearchMessage" } }, "total_results": { "type": "integer" } }, "additionalProperties": false, "required": [ "messages", "total_results" ], "definitions": { "GuildMessagesSearchMessage": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/MessageType" }, "content": { "type": "string" }, "channel_id": { "type": "string" }, "author": { "$ref": "#/definitions/PublicUser" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/PublicUser" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "pinned": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "tts": { "type": "boolean" }, "timestamp": { "type": "string" }, "edited_timestamp": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "hit": { "type": "boolean", "const": true } }, "additionalProperties": false, "required": [ "attachments", "author", "channel_id", "components", "edited_timestamp", "embeds", "flags", "hit", "id", "mention_roles", "mentions", "pinned", "poll", "timestamp", "tts", "type" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildPruneResponse": { "type": "object", "properties": { "pruned": { "type": "integer" } }, "additionalProperties": false, "required": [ "pruned" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildPurgeResponse": { "type": "object", "properties": { "purged": { "type": "integer" } }, "additionalProperties": false, "required": [ "purged" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildRecommendationsResponse": { "type": "object", "properties": { "recommended_guilds": { "type": "array", "items": { "$ref": "#/definitions/Guild" } }, "load_id": { "type": "string" } }, "additionalProperties": false, "required": [ "load_id", "recommended_guilds" ], "definitions": { "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildVanityUrlResponse": { "anyOf": [ { "$ref": "#/definitions/GuildVanityUrl" }, { "$ref": "#/definitions/GuildVanityUrlNoInvite" }, { "type": "array", "items": { "$ref": "#/definitions/GuildVanityUrl" } } ], "definitions": { "GuildVanityUrl": { "type": "object", "properties": { "code": { "type": "string" }, "uses": { "type": "integer" } }, "additionalProperties": false, "required": [ "code", "uses" ] }, "GuildVanityUrlNoInvite": { "type": "object", "properties": { "code": { "type": "null" } }, "additionalProperties": false, "required": [ "code" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildVanityUrlCreateResponse": { "type": "object", "properties": { "code": { "type": "string" } }, "additionalProperties": false, "required": [ "code" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildWidgetJsonResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "instant_invite": { "type": "string" }, "channels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer" } }, "additionalProperties": false, "required": [ "id", "name", "position" ] } }, "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": [ "null", "string" ] }, "status": { "$ref": "#/definitions/ClientStatus" }, "avatar_url": { "type": "string" } }, "additionalProperties": false, "required": [ "avatar", "avatar_url", "discriminator", "id", "status", "username" ] } }, "presence_count": { "type": "integer" } }, "additionalProperties": false, "required": [ "channels", "id", "instant_invite", "members", "name", "presence_count" ], "definitions": { "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildWidgetSettingsResponse": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "channel_id": { "anyOf": [ { "$ref": "#/definitions/Snowflake" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "channel_id", "enabled" ], "definitions": { "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "HubDirectoryEntriesResponse": { "type": "array", "items": { "$ref": "#/definitions/HubDirectoryEntry" }, "definitions": { "HubDirectoryEntry": { "type": "object", "properties": { "author_id": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "directory_channel_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "primary_category_id": { "type": "integer" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "author_id", "created_at", "description", "directory_channel_id", "guild", "primary_category_id", "type" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "HubWaitlistSignupResponse": { "type": "object", "properties": { "email": { "type": "string" }, "email_domain": { "type": "string" }, "school": { "type": "string" }, "user_id": { "type": "string" } }, "additionalProperties": false, "required": [ "email", "email_domain", "school", "user_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InstanceDomainsResponse": { "type": "object", "properties": { "cdn": { "type": "string" }, "gateway": { "type": "string" }, "defaultApiVersion": { "type": "string" }, "apiEndpoint": { "type": "string" } }, "additionalProperties": false, "required": [ "apiEndpoint", "cdn", "defaultApiVersion", "gateway" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InstancePingResponse": { "type": "object", "properties": { "ping": { "type": "string", "const": "pong!" }, "instance": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "image": { "type": [ "null", "string" ] }, "correspondenceEmail": { "type": [ "null", "string" ] }, "correspondenceUserID": { "type": [ "null", "string" ] }, "frontPage": { "type": [ "null", "string" ] }, "tosPage": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "correspondenceEmail", "correspondenceUserID", "description", "frontPage", "id", "image", "name", "tosPage" ] } }, "additionalProperties": false, "required": [ "instance", "ping" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InstanceStatsResponse": { "type": "object", "properties": { "counts": { "type": "object", "properties": { "user": { "type": "integer" }, "guild": { "type": "integer" }, "message": { "type": "integer" }, "members": { "type": "integer" } }, "additionalProperties": false, "required": [ "guild", "members", "message", "user" ] } }, "additionalProperties": false, "required": [ "counts" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "LocationMetadataResponse": { "type": "object", "properties": { "consent_required": { "type": "boolean" }, "country_code": { "type": "string" }, "promotional_email_opt_in": { "type": "object", "properties": { "required": { "type": "boolean", "const": true }, "pre_checked": { "type": "boolean", "const": false } }, "additionalProperties": false, "required": [ "pre_checked", "required" ] } }, "additionalProperties": false, "required": [ "consent_required", "country_code", "promotional_email_opt_in" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MemberJoinGuildResponse": { "type": "object", "properties": { "guild": { "$ref": "#/definitions/GuildCreateResponse" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } } }, "additionalProperties": false, "required": [ "emojis", "guild", "roles", "stickers" ], "definitions": { "GuildCreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "primary_category_id": { "type": "string" }, "large": { "type": "boolean" }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "template_id": { "type": "string" }, "mfa_level": { "type": "integer" }, "owner_id": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen" }, "widget_channel_id": { "type": "string" }, "widget_enabled": { "type": "boolean" }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean" }, "parent": { "type": "string" }, "region": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "banner": { "type": [ "null", "string" ] }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" }, "guild_template_code": { "type": "string" }, "staff_only": { "type": "boolean" }, "splash": { "type": [ "null", "string" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": "string" }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": "string" }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "safety_alerts_channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "id", "name", "nsfw", "welcome_screen", "widget_enabled" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "OAuthAuthorizeResponse": { "type": "object", "properties": { "location": { "type": "string" } }, "additionalProperties": false, "required": [ "location" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "PreloadMessagesResponseSchema": { "type": "array", "items": { "$ref": "#/definitions/Message" }, "definitions": { "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "RefreshUrlsResponse": { "type": "object", "properties": { "refreshed_urls": { "type": "array", "items": { "$ref": "#/definitions/RefreshedUrl" } } }, "additionalProperties": false, "required": [ "refreshed_urls" ], "definitions": { "RefreshedUrl": { "type": "object", "properties": { "original": { "type": "string" }, "refreshed": { "type": "string" } }, "additionalProperties": false, "required": [ "original", "refreshed" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SettingsProtoResponse": { "type": "object", "properties": { "settings": { "type": "string" } }, "additionalProperties": false, "required": [ "settings" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SettingsProtoUpdateResponse": { "type": "object", "properties": { "out_of_date": { "type": "boolean" }, "settings": { "type": "string" } }, "additionalProperties": false, "required": [ "settings" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SettingsProtoJsonResponse": { "type": "object", "properties": { "settings": { "$ref": "#/definitions/JsonValue" } }, "additionalProperties": false, "required": [ "settings" ], "definitions": { "JsonValue": { "description": "Represents any possible JSON value:\n- number\n- string\n- boolean\n- null\n- object (with any JSON value as property)\n- array (with any JSON value as element)", "anyOf": [ { "description": "Represents a JSON object.", "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonValue" } }, { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9]+$": { "$ref": "#/definitions/JsonValue" } }, "properties": { "length": { "type": "integer" }, "__@unscopables@689": { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9]+$": { "type": "boolean" } }, "properties": { "length": { "type": "boolean" }, "toString": { "type": "boolean" }, "toLocaleString": { "type": "boolean" }, "pop": { "type": "boolean" }, "push": { "type": "boolean" }, "concat": { "type": "boolean" }, "join": { "type": "boolean" }, "reverse": { "type": "boolean" }, "shift": { "type": "boolean" }, "slice": { "type": "boolean" }, "sort": { "type": "boolean" }, "splice": { "type": "boolean" }, "unshift": { "type": "boolean" }, "indexOf": { "type": "boolean" }, "lastIndexOf": { "type": "boolean" }, "every": { "type": "boolean" }, "some": { "type": "boolean" }, "forEach": { "type": "boolean" }, "map": { "type": "boolean" }, "filter": { "type": "boolean" }, "reduce": { "type": "boolean" }, "reduceRight": { "type": "boolean" }, "find": { "type": "boolean" }, "findIndex": { "type": "boolean" }, "fill": { "type": "boolean" }, "copyWithin": { "type": "boolean" }, "entries": { "type": "boolean" }, "keys": { "type": "boolean" }, "values": { "type": "boolean" }, "includes": { "type": "boolean" }, "flatMap": { "type": "boolean" }, "flat": { "type": "boolean" }, "at": { "type": "boolean" }, "findLast": { "type": "boolean" }, "findLastIndex": { "type": "boolean" }, "toReversed": { "type": "boolean" }, "toSorted": { "type": "boolean" }, "toSpliced": { "type": "boolean" }, "with": { "type": "boolean" }, "containsAll": { "type": "boolean" }, "partition": { "type": "boolean" }, "single": { "type": "boolean" }, "forEachAsync": { "type": "boolean" }, "remove": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "distinct": { "type": "boolean" }, "distinctBy": { "type": "boolean" }, "intersect": { "type": "boolean" }, "except": { "type": "boolean" }, "__@iterator@687": { "type": "boolean" }, "__@unscopables@689": { "type": "boolean" } } } }, "required": [ "__@unscopables@689", "length" ] }, { "type": [ "null", "string", "integer", "boolean" ] } ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SettingsProtoUpdateJsonResponse": { "type": "object", "properties": { "out_of_date": { "type": "boolean" }, "settings": { "$ref": "#/definitions/JsonValue" } }, "additionalProperties": false, "required": [ "settings" ], "definitions": { "JsonValue": { "description": "Represents any possible JSON value:\n- number\n- string\n- boolean\n- null\n- object (with any JSON value as property)\n- array (with any JSON value as element)", "anyOf": [ { "description": "Represents a JSON object.", "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonValue" } }, { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9]+$": { "$ref": "#/definitions/JsonValue" } }, "properties": { "length": { "type": "integer" }, "__@unscopables@689": { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9]+$": { "type": "boolean" } }, "properties": { "length": { "type": "boolean" }, "toString": { "type": "boolean" }, "toLocaleString": { "type": "boolean" }, "pop": { "type": "boolean" }, "push": { "type": "boolean" }, "concat": { "type": "boolean" }, "join": { "type": "boolean" }, "reverse": { "type": "boolean" }, "shift": { "type": "boolean" }, "slice": { "type": "boolean" }, "sort": { "type": "boolean" }, "splice": { "type": "boolean" }, "unshift": { "type": "boolean" }, "indexOf": { "type": "boolean" }, "lastIndexOf": { "type": "boolean" }, "every": { "type": "boolean" }, "some": { "type": "boolean" }, "forEach": { "type": "boolean" }, "map": { "type": "boolean" }, "filter": { "type": "boolean" }, "reduce": { "type": "boolean" }, "reduceRight": { "type": "boolean" }, "find": { "type": "boolean" }, "findIndex": { "type": "boolean" }, "fill": { "type": "boolean" }, "copyWithin": { "type": "boolean" }, "entries": { "type": "boolean" }, "keys": { "type": "boolean" }, "values": { "type": "boolean" }, "includes": { "type": "boolean" }, "flatMap": { "type": "boolean" }, "flat": { "type": "boolean" }, "at": { "type": "boolean" }, "findLast": { "type": "boolean" }, "findLastIndex": { "type": "boolean" }, "toReversed": { "type": "boolean" }, "toSorted": { "type": "boolean" }, "toSpliced": { "type": "boolean" }, "with": { "type": "boolean" }, "containsAll": { "type": "boolean" }, "partition": { "type": "boolean" }, "single": { "type": "boolean" }, "forEachAsync": { "type": "boolean" }, "remove": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "distinct": { "type": "boolean" }, "distinctBy": { "type": "boolean" }, "intersect": { "type": "boolean" }, "except": { "type": "boolean" }, "__@iterator@687": { "type": "boolean" }, "__@unscopables@689": { "type": "boolean" } } } }, "required": [ "__@unscopables@689", "length" ] }, { "type": [ "null", "string", "integer", "boolean" ] } ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TeamListResponse": { "type": "array", "items": { "$ref": "#/definitions/Team" }, "definitions": { "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TenorGifResponse": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "src": { "type": "string" }, "gif_src": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "preview": { "type": "string" } }, "additionalProperties": false, "required": [ "gif_src", "height", "id", "preview", "src", "title", "url", "width" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TenorTrendingResponse": { "type": "object", "properties": { "categories": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "searchterm": { "type": "string" }, "path": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "image", "name", "path", "searchterm" ] } } }, "additionalProperties": false, "required": [ "tags" ] }, "gifs": { "type": "array", "items": { "$ref": "#/definitions/TenorGifResponse" } } }, "additionalProperties": false, "required": [ "categories", "gifs" ], "definitions": { "TenorGifResponse": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "src": { "type": "string" }, "gif_src": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "preview": { "type": "string" } }, "additionalProperties": false, "required": [ "gif_src", "height", "id", "preview", "src", "title", "url", "width" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TenorGifsResponse": { "type": "array", "items": { "$ref": "#/definitions/TenorGifResponse" }, "definitions": { "TenorGifResponse": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "src": { "type": "string" }, "gif_src": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "preview": { "type": "string" } }, "additionalProperties": false, "required": [ "gif_src", "height", "id", "preview", "src", "title", "url", "width" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TokenResponse": { "type": "object", "properties": { "token": { "type": "string" }, "settings": { "$ref": "#/definitions/UserSettings" } }, "additionalProperties": false, "required": [ "settings", "token" ], "definitions": { "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TokenOnlyResponse": { "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false, "required": [ "token" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TokenWithBackupCodesResponse": { "type": "object", "properties": { "token": { "type": "string" }, "backup_codes": { "type": "array", "items": { "$ref": "#/definitions/BackupCode" } } }, "additionalProperties": false, "required": [ "backup_codes", "token" ], "definitions": { "BackupCode": { "type": "object", "properties": { "user": { "$ref": "#/definitions/User" }, "code": { "type": "string" }, "consumed": { "type": "boolean" }, "expired": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "consumed", "expired", "id", "user" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIGuild": { "type": "object", "properties": { "name": { "type": "string" }, "region": { "type": "string" }, "id": { "type": "string" }, "icon": { "type": "string" }, "parent": { "type": "string" }, "owner_id": { "type": "string" }, "nsfw": { "type": "boolean" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "_do_validate": { "type": "object", "additionalProperties": false }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "banner": { "type": "string" }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "system_channel_id": { "type": [ "null", "string" ] }, "rules_channel_id": { "type": [ "null", "string" ] }, "splash": { "type": "string" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": [ "null", "string" ] }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "primary_category_id": { "type": "string" }, "large": { "type": "boolean" }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "template_id": { "type": "string" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "mfa_level": { "type": "integer" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "unavailable": { "type": "boolean" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_enabled": { "type": "boolean" }, "nsfw_level": { "type": "integer" }, "permissions": { "type": "integer" }, "channel_ordering": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "_do_validate", "assign", "bans", "channel_ordering", "channels", "emojis", "features", "hasId", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "recover", "reload", "remove", "roles", "save", "softRemove", "stickers", "toJSON", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ], "definitions": { "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIPublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIPrivateUser": { "type": "object", "properties": { "email": { "type": "string" }, "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "flags": { "type": "integer" }, "verified": { "type": "boolean" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "mfa_enabled": { "type": "boolean" }, "phone": { "type": "string" }, "nsfw_allowed": { "type": "boolean" }, "premium": { "type": "boolean" }, "purchased_flags": { "type": "integer" }, "premium_usage_flags": { "type": "integer" }, "disabled": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserSettingsSchema" } }, "additionalProperties": false, "required": [ "bio", "bot", "disabled", "discriminator", "flags", "id", "mfa_enabled", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "username", "verified" ], "definitions": { "UserSettingsSchema": { "type": "object", "properties": { "afk_timeout": { "type": "integer" }, "allow_accessibility_detection": { "type": "boolean" }, "animate_emoji": { "type": "boolean" }, "animate_stickers": { "type": "integer" }, "contact_sync_enabled": { "type": "boolean" }, "convert_emoticons": { "type": "boolean" }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ] }, "default_guilds_restricted": { "type": "boolean" }, "detect_platform_accounts": { "type": "boolean" }, "developer_mode": { "type": "boolean" }, "disable_games_tab": { "type": "boolean" }, "enable_tts_command": { "type": "boolean" }, "explicit_content_filter": { "type": "integer" }, "friend_discovery_flags": { "type": "integer" }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean" }, "gif_auto_play": { "type": "boolean" }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" } }, "guild_positions": { "type": "array", "items": { "type": "string" } }, "inline_attachment_media": { "type": "boolean" }, "inline_embed_media": { "type": "boolean" }, "locale": { "type": "string" }, "message_display_compact": { "type": "boolean" }, "native_phone_integration_enabled": { "type": "boolean" }, "render_embeds": { "type": "boolean" }, "render_reactions": { "type": "boolean" }, "restricted_guilds": { "type": "array", "items": { "type": "string" } }, "show_current_game": { "type": "boolean" }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "stream_notifications_enabled": { "type": "boolean" }, "theme": { "enum": [ "dark", "light" ], "type": "string" }, "timezone_offset": { "type": "integer" }, "view_nsfw_guilds": { "type": "boolean" } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIGuildArray": { "type": "array", "items": { "$ref": "#/definitions/APIGuild" }, "definitions": { "APIGuild": { "type": "object", "properties": { "name": { "type": "string" }, "region": { "type": "string" }, "reload": { "description": "Reloads entity data from the database.", "type": "object", "additionalProperties": false }, "id": { "type": "string" }, "remove": { "description": "Removes current entity from the database.", "type": "object", "additionalProperties": false }, "icon": { "type": "string" }, "parent": { "type": "string" }, "owner_id": { "type": "string" }, "nsfw": { "type": "boolean" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "toJSON": { "type": "object", "additionalProperties": false }, "_do_validate": { "type": "object", "additionalProperties": false }, "assign": { "type": "object", "additionalProperties": false }, "hasId": { "description": "Checks if entity has an id.\nIf entity composite compose ids, it will check them all.", "type": "object", "additionalProperties": false }, "save": { "description": "Saves current entity in the database.\nIf entity does not exist in the database then inserts, otherwise updates.", "type": "object", "additionalProperties": false }, "softRemove": { "description": "Records the delete date of current entity.", "type": "object", "additionalProperties": false }, "recover": { "description": "Recovers a given entity in the database.", "type": "object", "additionalProperties": false }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "banner": { "type": "string" }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "system_channel_id": { "type": [ "null", "string" ] }, "rules_channel_id": { "type": [ "null", "string" ] }, "splash": { "type": "string" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": [ "null", "string" ] }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "primary_category_id": { "type": "string" }, "large": { "type": "boolean" }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "template_id": { "type": "string" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "mfa_level": { "type": "integer" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "unavailable": { "type": "boolean" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_enabled": { "type": "boolean" }, "nsfw_level": { "type": "integer" }, "permissions": { "type": "integer" }, "channel_ordering": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "_do_validate", "assign", "bans", "channel_ordering", "channels", "emojis", "features", "hasId", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "recover", "reload", "remove", "roles", "save", "softRemove", "stickers", "toJSON", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIDMChannelArray": { "type": "array", "items": { "$ref": "#/definitions/DmChannelDTO" }, "definitions": { "DmChannelDTO": { "type": "object", "properties": { "icon": { "type": [ "null", "string" ] }, "id": { "type": "string" }, "last_message_id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "origin_channel_id": { "type": [ "null", "string" ] }, "owner_id": { "type": "string" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/MinimalPublicUserDTO" } }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "icon", "id", "last_message_id", "name", "origin_channel_id", "recipients", "type" ] }, "MinimalPublicUserDTO": { "type": "object", "properties": { "avatar": { "type": [ "null", "string" ] }, "discriminator": { "type": "string" }, "id": { "type": "string" }, "public_flags": { "type": "integer" }, "username": { "type": "string" }, "badge_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "discriminator", "id", "public_flags", "username" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIBackupCodeArray": { "type": "array", "items": { "$ref": "#/definitions/BackupCode" }, "definitions": { "BackupCode": { "type": "object", "properties": { "user": { "$ref": "#/definitions/User" }, "code": { "type": "string" }, "consumed": { "type": "boolean" }, "expired": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "consumed", "expired", "id", "user" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserUpdateResponse": { "type": "object", "properties": { "newToken": { "type": "string" }, "email": { "type": "string" }, "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "flags": { "type": "integer" }, "verified": { "type": "boolean" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "mfa_enabled": { "type": "boolean" }, "phone": { "type": "string" }, "nsfw_allowed": { "type": "boolean" }, "premium": { "type": "boolean" }, "purchased_flags": { "type": "integer" }, "premium_usage_flags": { "type": "integer" }, "disabled": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserSettingsSchema" } }, "additionalProperties": false, "required": [ "bio", "bot", "disabled", "discriminator", "flags", "id", "mfa_enabled", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "username", "verified" ], "definitions": { "UserSettingsSchema": { "type": "object", "properties": { "afk_timeout": { "type": "integer" }, "allow_accessibility_detection": { "type": "boolean" }, "animate_emoji": { "type": "boolean" }, "animate_stickers": { "type": "integer" }, "contact_sync_enabled": { "type": "boolean" }, "convert_emoticons": { "type": "boolean" }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ] }, "default_guilds_restricted": { "type": "boolean" }, "detect_platform_accounts": { "type": "boolean" }, "developer_mode": { "type": "boolean" }, "disable_games_tab": { "type": "boolean" }, "enable_tts_command": { "type": "boolean" }, "explicit_content_filter": { "type": "integer" }, "friend_discovery_flags": { "type": "integer" }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean" }, "gif_auto_play": { "type": "boolean" }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" } }, "guild_positions": { "type": "array", "items": { "type": "string" } }, "inline_attachment_media": { "type": "boolean" }, "inline_embed_media": { "type": "boolean" }, "locale": { "type": "string" }, "message_display_compact": { "type": "boolean" }, "native_phone_integration_enabled": { "type": "boolean" }, "render_embeds": { "type": "boolean" }, "render_reactions": { "type": "boolean" }, "restricted_guilds": { "type": "array", "items": { "type": "string" } }, "show_current_game": { "type": "boolean" }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "stream_notifications_enabled": { "type": "boolean" }, "theme": { "enum": [ "dark", "light" ], "type": "string" }, "timezone_offset": { "type": "integer" }, "view_nsfw_guilds": { "type": "boolean" } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationDetectableResponse": { "type": "array", "items": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationEntitlementsResponse": { "type": "array", "items": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationSkusResponse": { "type": "array", "items": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIApplicationArray": { "type": "array", "items": { "$ref": "#/definitions/Application" }, "definitions": { "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIBansArray": { "type": "array", "items": { "$ref": "#/definitions/GuildBansResponse" }, "definitions": { "GuildBansResponse": { "type": "object", "properties": { "reason": { "type": [ "null", "string" ] }, "user": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "id": { "type": "string" }, "avatar": { "type": [ "null", "string" ] }, "public_flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "avatar", "discriminator", "id", "public_flags", "username" ] } }, "additionalProperties": false, "required": [ "reason", "user" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIInviteArray": { "type": "array", "items": { "$ref": "#/definitions/Invite" }, "definitions": { "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIMessageArray": { "type": "array", "items": { "$ref": "#/definitions/Message" }, "definitions": { "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIWebhookArray": { "type": "array", "items": { "$ref": "#/definitions/Webhook" }, "definitions": { "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIDiscoveryCategoryArray": { "type": "array", "items": { "$ref": "#/definitions/Categories" }, "definitions": { "Categories": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "localizations": { "type": "string" }, "is_primary": { "type": "boolean" }, "icon": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "is_primary", "localizations", "name" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIGeneralConfiguration": { "type": "object", "properties": { "instanceName": { "type": "string", "default": "Spacebar Instance" }, "instanceDescription": { "type": [ "null", "string" ], "default": "This is a Spacebar instance made in the pre-release days" }, "frontPage": { "type": [ "null", "string" ], "default": null }, "tosPage": { "type": [ "null", "string" ], "default": null }, "correspondenceEmail": { "type": [ "null", "string" ], "default": null }, "correspondenceUserID": { "type": [ "null", "string" ], "default": null }, "image": { "type": [ "null", "string" ], "default": null }, "instanceId": { "type": "string" }, "autoCreateBotUsers": { "type": "boolean", "default": false } }, "additionalProperties": false, "required": [ "autoCreateBotUsers", "correspondenceEmail", "correspondenceUserID", "frontPage", "image", "instanceDescription", "instanceId", "instanceName", "tosPage" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "APIChannelArray": { "type": "array", "items": { "$ref": "#/definitions/Channel" }, "definitions": { "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIEmojiArray": { "type": "array", "items": { "$ref": "#/definitions/Emoji" }, "definitions": { "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIMemberArray": { "type": "array", "items": { "$ref": "#/definitions/Member" }, "definitions": { "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIPublicMember": { "additionalProperties": false, "type": "object", "properties": { "id": { "type": "string" }, "guild_id": { "type": "string" }, "mute": { "type": "boolean" }, "deaf": { "type": "boolean" }, "nick": { "type": "string" }, "joined_at": { "type": "string", "format": "date-time" }, "pending": { "type": "boolean" }, "premium_since": { "type": "integer" }, "avatar": { "type": "string" }, "user": { "$ref": "#/definitions/PublicUser" }, "roles": { "type": "array", "items": { "type": "string" } } }, "required": [ "deaf", "guild_id", "id", "joined_at", "mute", "pending", "roles", "user" ], "definitions": { "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIGuildWithJoinedAt": { "type": "object", "properties": { "joined_at": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "primary_category_id": { "type": "string" }, "large": { "type": "boolean" }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "template_id": { "type": "string" }, "mfa_level": { "type": "integer" }, "owner_id": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen" }, "widget_channel_id": { "type": "string" }, "widget_enabled": { "type": "boolean" }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean" }, "parent": { "type": "string" }, "region": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "banner": { "type": [ "null", "string" ] }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" }, "guild_template_code": { "type": "string" }, "staff_only": { "type": "boolean" }, "splash": { "type": [ "null", "string" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": "string" }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": "string" }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "safety_alerts_channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "id", "joined_at", "large", "max_members", "max_presences", "max_video_channel_users", "member_count", "mfa_level", "name", "nsfw", "nsfw_level", "owner_id", "parent", "premium_subscription_count", "premium_tier", "presence_count", "primary_category_id", "template_id", "welcome_screen", "widget_channel_id", "widget_enabled" ], "definitions": { "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIRoleArray": { "type": "array", "items": { "$ref": "#/definitions/Role" }, "definitions": { "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIStickerArray": { "type": "array", "items": { "$ref": "#/definitions/Sticker" }, "definitions": { "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APITemplateArray": { "type": "array", "items": { "$ref": "#/definitions/Template" }, "definitions": { "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIGuildVoiceRegion": { "type": "array", "items": { "$ref": "#/definitions/GuildVoiceRegion" }, "definitions": { "GuildVoiceRegion": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "custom": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "optimal": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom", "deprecated", "id", "name", "optimal" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APILimitsConfiguration": { "type": "object", "properties": { "user": { "$ref": "#/definitions/UserLimits" }, "guild": { "$ref": "#/definitions/GuildLimits" }, "message": { "$ref": "#/definitions/MessageLimits" }, "channel": { "$ref": "#/definitions/ChannelLimits" }, "rate": { "$ref": "#/definitions/RateLimits" }, "absoluteRate": { "$ref": "#/definitions/GlobalRateLimits" } }, "additionalProperties": false, "required": [ "absoluteRate", "channel", "guild", "message", "rate", "user" ], "definitions": { "UserLimits": { "type": "object", "properties": { "maxGuilds": { "type": "integer", "default": 1048576 }, "maxUsername": { "type": "integer", "default": 32 }, "maxFriends": { "type": "integer", "default": 5000 }, "maxBio": { "type": "integer", "default": 190 } }, "additionalProperties": false, "required": [ "maxBio", "maxFriends", "maxGuilds", "maxUsername" ] }, "GuildLimits": { "type": "object", "properties": { "maxRoles": { "type": "integer", "default": 1000 }, "maxEmojis": { "type": "integer", "default": 2000 }, "maxStickers": { "type": "integer", "default": 500 }, "maxMembers": { "type": "integer", "default": 25000000 }, "maxChannels": { "type": "integer", "default": 65535 }, "maxBulkBanUsers": { "type": "integer", "default": 200 }, "maxChannelsInCategory": { "type": "integer", "default": 65535 } }, "additionalProperties": false, "required": [ "maxBulkBanUsers", "maxChannels", "maxChannelsInCategory", "maxEmojis", "maxMembers", "maxRoles", "maxStickers" ] }, "MessageLimits": { "type": "object", "properties": { "maxCharacters": { "type": "integer", "default": 1048576 }, "maxTTSCharacters": { "type": "integer", "default": 160 }, "maxReactions": { "type": "integer", "default": 2048 }, "maxAttachmentSize": { "type": "integer", "default": 1073741824 }, "maxBulkDelete": { "type": "integer", "default": 1000 }, "maxEmbedDownloadSize": { "type": "integer", "default": 5242880 }, "maxPreloadCount": { "type": "integer", "default": 100 } }, "additionalProperties": false, "required": [ "maxAttachmentSize", "maxBulkDelete", "maxCharacters", "maxEmbedDownloadSize", "maxPreloadCount", "maxReactions", "maxTTSCharacters" ] }, "ChannelLimits": { "type": "object", "properties": { "maxPins": { "type": "integer", "default": 500 }, "maxTopic": { "type": "integer", "default": 1024 }, "maxWebhooks": { "type": "integer", "default": 100 } }, "additionalProperties": false, "required": [ "maxPins", "maxTopic", "maxWebhooks" ] }, "RateLimits": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "ip": { "$ref": "#/definitions/RateLimitOptions" }, "global": { "$ref": "#/definitions/RateLimitOptions" }, "error": { "$ref": "#/definitions/RateLimitOptions" }, "routes": { "$ref": "#/definitions/RouteRateLimit" } }, "additionalProperties": false, "required": [ "enabled", "error", "global", "ip", "routes" ] }, "RateLimitOptions": { "type": "object", "properties": { "bot": { "type": "integer" }, "count": { "type": "integer" }, "window": { "type": "integer" }, "onyIp": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "window" ] }, "RouteRateLimit": { "type": "object", "properties": { "guild": { "$ref": "#/definitions/RateLimitOptions" }, "webhook": { "$ref": "#/definitions/RateLimitOptions" }, "channel": { "$ref": "#/definitions/RateLimitOptions" }, "auth": { "$ref": "#/definitions/AuthRateLimit" } }, "additionalProperties": false, "required": [ "auth", "channel", "guild", "webhook" ] }, "AuthRateLimit": { "type": "object", "properties": { "login": { "$ref": "#/definitions/RateLimitOptions" }, "register": { "$ref": "#/definitions/RateLimitOptions" } }, "additionalProperties": false, "required": [ "login", "register" ] }, "GlobalRateLimits": { "type": "object", "properties": { "register": { "$ref": "#/definitions/GlobalRateLimit" }, "sendMessage": { "$ref": "#/definitions/GlobalRateLimit" } }, "additionalProperties": false, "required": [ "register", "sendMessage" ] }, "GlobalRateLimit": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100 }, "window": { "type": "integer", "default": 3600000 }, "enabled": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "enabled", "limit", "window" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIStickerPackArray": { "type": "array", "items": { "$ref": "#/definitions/StickerPack" }, "definitions": { "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "APIConnectionsConfiguration": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UpdatesResponse": { "type": "object", "properties": { "name": { "type": "string" }, "pub_date": { "type": "string" }, "url": { "type": "string" }, "notes": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "name", "notes", "pub_date", "url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UploadAttachmentResponseSchema": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "$ref": "#/definitions/UploadAttachmentResponse" } } }, "additionalProperties": false, "required": [ "attachments" ], "definitions": { "UploadAttachmentResponse": { "type": "object", "properties": { "id": { "type": "string" }, "upload_url": { "type": "string" }, "upload_filename": { "type": "string" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "upload_filename", "upload_url" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UploadAttachmentResponse": { "type": "object", "properties": { "id": { "type": "string" }, "upload_url": { "type": "string" }, "upload_filename": { "type": "string" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "upload_filename", "upload_url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UserNoteResponse": { "type": "object", "properties": { "note": { "type": "string" }, "note_user_id": { "type": "string" }, "user_id": { "type": "string" } }, "additionalProperties": false, "required": [ "note", "note_user_id", "user_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UserProfileResponse": { "type": "object", "properties": { "user": { "$ref": "#/definitions/PublicUser" }, "connected_accounts": { "$ref": "#/definitions/PublicConnectedAccount" }, "premium_guild_since": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "mutual_guilds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nick": { "type": "string" } }, "additionalProperties": false, "required": [ "id" ] } }, "premium_type": { "type": "integer" }, "profile_themes_experiment_bucket": { "type": "integer" }, "user_profile": { "$ref": "#/definitions/UserProfile" }, "guild_member": { "$ref": "#/definitions/PublicMember" }, "guild_member_profile": { "$ref": "#/definitions/PublicMemberProfile" }, "badges": { "type": "array", "items": { "$ref": "#/definitions/Badge" } } }, "additionalProperties": false, "required": [ "badges", "connected_accounts", "mutual_guilds", "premium_type", "profile_themes_experiment_bucket", "user", "user_profile" ], "definitions": { "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] }, "PublicConnectedAccount": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "verified": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "type" ] }, "UserProfile": { "type": "object", "properties": { "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" } }, "additionalProperties": false, "required": [ "bio" ] }, "PublicMember": { "additionalProperties": false, "type": "object", "properties": { "id": { "type": "string" }, "guild_id": { "type": "string" }, "mute": { "type": "boolean" }, "deaf": { "type": "boolean" }, "nick": { "type": "string" }, "joined_at": { "type": "string", "format": "date-time" }, "pending": { "type": "boolean" }, "premium_since": { "type": "integer" }, "avatar": { "type": "string" }, "user": { "$ref": "#/definitions/PublicUser" }, "roles": { "type": "array", "items": { "type": "string" } } }, "required": [ "deaf", "guild_id", "id", "joined_at", "mute", "pending", "roles", "user" ] }, "PublicMemberProfile": { "additionalProperties": false, "type": "object", "properties": { "guild_id": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "accent_color": { "type": "null" } }, "required": [ "accent_color", "banner", "bio", "guild_id" ] }, "Badge": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "link": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "icon", "id" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserRelationsResponse": { "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "public_flags": { "type": "integer" } }, "required": [ "discriminator", "id", "public_flags", "username" ] }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserRelationshipsResponse": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "nickname": { "type": "null" }, "user": { "$ref": "#/definitions/PublicUser" } }, "additionalProperties": false, "required": [ "id", "nickname", "type", "user" ], "definitions": { "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "WebAuthnCreateResponse": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "WebhookCreateResponse": { "type": "object", "properties": { "user": { "$ref": "#/definitions/User" }, "hook": { "$ref": "#/definitions/Webhook" } }, "additionalProperties": false, "required": [ "hook", "user" ], "definitions": { "User": { "type": "object", "properties": { "username": { "type": "string" }, "discriminator": { "type": "string" }, "avatar": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "phone": { "type": "string" }, "desktop": { "type": "boolean", "default": false }, "mobile": { "type": "boolean", "default": false }, "premium": { "type": "boolean" }, "premium_type": { "type": "integer" }, "bot": { "type": "boolean", "default": false }, "bio": { "type": "string", "default": "" }, "system": { "type": "boolean", "default": false }, "nsfw_allowed": { "type": "boolean", "default": true }, "mfa_enabled": { "type": "boolean", "default": false }, "webauthn_enabled": { "type": "boolean", "default": false }, "totp_secret": { "type": "string", "default": "" }, "totp_last_ticket": { "type": "string", "default": "" }, "created_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean" }, "disabled": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "email": { "type": "string" }, "flags": { "type": "integer", "default": 0 }, "public_flags": { "type": "integer", "default": 0 }, "purchased_flags": { "type": "integer", "default": 0 }, "premium_usage_flags": { "type": "integer", "default": 0 }, "rights": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/definitions/Session" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/Relationship" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/definitions/ConnectedAccount" } }, "data": { "type": "object", "properties": { "valid_tokens_since": { "type": "string", "format": "date-time" }, "hash": { "type": "string" } }, "additionalProperties": false, "required": [ "valid_tokens_since" ] }, "fingerprints": { "type": "array", "items": { "type": "string" }, "default": [] }, "settings": { "$ref": "#/definitions/UserSettings" }, "extended_settings": { "type": "string", "default": "{}" }, "security_keys": { "type": "array", "items": { "$ref": "#/definitions/SecurityKey" } }, "badge_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bio", "bot", "connected_accounts", "created_at", "data", "deleted", "desktop", "disabled", "discriminator", "extended_settings", "fingerprints", "flags", "id", "mfa_enabled", "mobile", "nsfw_allowed", "premium", "premium_since", "premium_type", "premium_usage_flags", "public_flags", "purchased_flags", "relationships", "rights", "security_keys", "sessions", "system", "username", "verified", "webauthn_enabled" ] }, "Session": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "session_id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "client_info": { "type": "object", "properties": { "client": { "type": "string" }, "os": { "type": "string" }, "version": { "type": "integer" } }, "additionalProperties": false, "required": [ "client", "os", "version" ] }, "client_status": { "$ref": "#/definitions/ClientStatus" }, "status": { "$ref": "#/definitions/Status" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "activities", "client_info", "client_status", "id", "session_id", "status", "user", "user_id" ] }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] }, "ClientStatus": { "type": "object", "properties": { "desktop": { "type": "string" }, "mobile": { "type": "string" }, "web": { "type": "string" }, "embedded": { "type": "string" } }, "additionalProperties": false }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Relationship": { "type": "object", "properties": { "from_id": { "type": "string" }, "from": { "$ref": "#/definitions/User" }, "to_id": { "type": "string" }, "to": { "$ref": "#/definitions/User" }, "nickname": { "type": "string" }, "type": { "$ref": "#/definitions/RelationshipType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "from_id", "id", "to", "to_id", "type" ] }, "RelationshipType": { "type": "number", "enum": [ 4, 3, 2, 1 ] }, "ConnectedAccount": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "friend_sync": { "type": "boolean", "default": false }, "name": { "type": "string" }, "revoked": { "type": "boolean", "default": false }, "show_activity": { "type": "integer", "default": 0 }, "type": { "type": "string" }, "verified": { "type": "boolean", "default": true }, "visibility": { "type": "integer", "default": 0 }, "integrations": { "type": "array", "items": { "type": "string" }, "default": [] }, "metadata_": {}, "metadata_visibility": { "type": "integer", "default": 0 }, "two_way_link": { "type": "boolean", "default": false }, "token_data": { "anyOf": [ { "$ref": "#/definitions/ConnectedAccountTokenData" }, { "type": "null" } ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "external_id", "id", "name", "type", "user", "user_id" ] }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "SecurityKey": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "key_id": { "type": "string" }, "public_key": { "type": "string" }, "counter": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "counter", "id", "key_id", "name", "public_key", "user", "user_id" ] }, "Webhook": { "type": "object", "properties": { "type": { "$ref": "#/definitions/WebhookType" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "token": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "source_channel_id": { "type": "string" }, "source_channel": { "$ref": "#/definitions/Channel" }, "url": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "application", "application_id", "avatar", "channel", "channel_id", "id", "name", "source_channel", "source_channel_id", "type", "url", "user", "user_id" ] }, "WebhookType": { "type": "number", "enum": [ 1, 2, 3 ] }, "Guild": { "type": "object", "properties": { "afk_channel_id": { "type": [ "null", "string" ] }, "afk_channel": { "$ref": "#/definitions/Channel" }, "afk_timeout": { "type": "integer" }, "bans": { "type": "array", "items": { "$ref": "#/definitions/Ban" } }, "banner": { "type": "string" }, "default_message_notifications": { "type": "integer" }, "description": { "type": "string" }, "discovery_splash": { "type": "string" }, "explicit_content_filter": { "type": "integer" }, "features": { "type": "array", "items": { "type": "string" }, "default": [] }, "primary_category_id": { "type": "string" }, "icon": { "type": "string" }, "large": { "type": "boolean", "default": false }, "max_members": { "type": "integer" }, "max_presences": { "type": "integer" }, "max_video_channel_users": { "type": "integer" }, "member_count": { "type": "integer" }, "presence_count": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/definitions/Member" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "template_id": { "type": "string" }, "template": { "$ref": "#/definitions/Template" }, "emojis": { "type": "array", "items": { "$ref": "#/definitions/Emoji" } }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "mfa_level": { "type": "integer" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "preferred_locale": { "type": "string" }, "premium_subscription_count": { "type": "integer" }, "premium_tier": { "type": "integer" }, "public_updates_channel_id": { "type": [ "null", "string" ] }, "public_updates_channel": { "$ref": "#/definitions/Channel" }, "rules_channel_id": { "type": [ "null", "string" ] }, "rules_channel": { "type": "string" }, "region": { "type": "string" }, "splash": { "type": "string" }, "system_channel_id": { "type": [ "null", "string" ] }, "system_channel": { "$ref": "#/definitions/Channel" }, "system_channel_flags": { "type": "integer" }, "unavailable": { "type": "boolean", "default": false }, "verification_level": { "type": "integer" }, "welcome_screen": { "$ref": "#/definitions/GuildWelcomeScreen", "description": "DEPRECATED: Look at the new Guild onboarding screens." }, "widget_channel_id": { "type": "string" }, "widget_channel": { "$ref": "#/definitions/Channel" }, "widget_enabled": { "type": "boolean", "default": true }, "nsfw_level": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "parent": { "type": "string" }, "permissions": { "type": "integer" }, "premium_progress_bar_enabled": { "type": "boolean", "default": false }, "channel_ordering": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "bans", "channel_ordering", "channels", "emojis", "features", "id", "invites", "members", "name", "nsfw", "premium_progress_bar_enabled", "public_updates_channel_id", "roles", "stickers", "template", "unavailable", "voice_states", "webhooks", "welcome_screen", "widget_enabled" ] }, "Channel": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "type": { "$ref": "#/definitions/ChannelType" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/Recipient" } }, "last_message_id": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "parent_id": { "type": [ "null", "string" ] }, "parent": { "$ref": "#/definitions/Channel" }, "owner_id": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "last_pin_timestamp": { "type": "integer" }, "default_auto_archive_duration": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "$ref": "#/definitions/ChannelPermissionOverwrite" } }, "video_quality_mode": { "type": "integer" }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "nsfw": { "type": "boolean", "default": false }, "rate_limit_per_user": { "type": "integer" }, "topic": { "type": "string" }, "invites": { "type": "array", "items": { "$ref": "#/definitions/Invite" } }, "retention_policy_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "voice_states": { "type": "array", "items": { "$ref": "#/definitions/VoiceState" } }, "read_states": { "type": "array", "items": { "$ref": "#/definitions/ReadState" } }, "webhooks": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "flags": { "type": "integer", "default": 0 }, "default_thread_rate_limit_per_user": { "type": "integer", "default": 0 }, "position": { "description": "Must be calculated Channel.calculatePosition", "type": "integer" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "created_at", "flags", "id", "nsfw", "owner", "parent_id", "position", "type" ] }, "ChannelType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 33, 34, 35, 64, 255 ] }, "Recipient": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "closed": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "closed", "id", "user", "user_id" ] }, "ChannelPermissionOverwrite": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] }, "Invite": { "type": "object", "properties": { "code": { "type": "string" }, "temporary": { "type": "boolean" }, "uses": { "type": "integer" }, "max_uses": { "type": "integer" }, "max_age": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "inviter_id": { "type": "string" }, "inviter": { "$ref": "#/definitions/User" }, "target_user_id": { "type": "string" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "vanity_url": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "code", "created_at", "flags", "guild", "guild_id", "inviter", "max_age", "max_uses", "target_user_id", "temporary", "uses" ] }, "Message": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "author_id": { "type": "string" }, "author": { "$ref": "#/definitions/User" }, "member_id": { "type": "string" }, "member": { "$ref": "#/definitions/Member" }, "webhook_id": { "type": "string" }, "webhook": { "$ref": "#/definitions/Webhook" }, "application_id": { "type": "string" }, "application": { "$ref": "#/definitions/Application" }, "content": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "edited_timestamp": { "type": "string", "format": "date-time" }, "tts": { "type": "boolean" }, "mention_everyone": { "type": "boolean" }, "mentions": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "mention_roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "mention_channels": { "type": "array", "items": { "$ref": "#/definitions/Channel" } }, "sticker_items": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/Reaction" } }, "nonce": { "type": "string" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "type": { "$ref": "#/definitions/MessageType" }, "activity": { "type": "object", "properties": { "type": { "type": "integer" }, "party_id": { "type": "string" } }, "additionalProperties": false, "required": [ "party_id", "type" ] }, "flags": { "type": "integer" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "type": { "type": "integer" } }, "additionalProperties": false, "required": [ "message_id" ] }, "referenced_message": { "anyOf": [ { "$ref": "#/definitions/Message" }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "interaction_metadata": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "user_id": { "type": "string" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "name": { "type": "string" }, "command_type": { "$ref": "#/definitions/ApplicationCommandType" } }, "additionalProperties": false, "required": [ "authorizing_integration_owners", "command_type", "id", "name", "type", "user_id" ] }, "components": { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, "poll": { "$ref": "#/definitions/Poll" }, "username": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "embeds", "flags", "id", "mention_channels", "mention_roles", "mentions", "pinned", "reactions", "timestamp", "type" ] }, "Member": { "type": "object", "properties": { "index": { "type": "string" }, "id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "nick": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "joined_at": { "type": "string", "format": "date-time" }, "premium_since": { "type": "integer" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "pending": { "type": "boolean" }, "settings": { "$ref": "#/definitions/UserGuildSettings" }, "last_message_id": { "type": "string" }, "joined_by": { "type": "string" }, "avatar": { "type": "string" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "communication_disabled_until": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "banner", "bio", "communication_disabled_until", "deaf", "guild", "guild_id", "id", "index", "joined_at", "joined_by", "mute", "pending", "roles", "settings", "user" ] }, "Role": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "managed": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "type": "string" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "tags": { "type": "object", "properties": { "bot_id": { "type": "string" }, "integration_id": { "type": "string" }, "premium_subscriber": { "type": "boolean" } }, "additionalProperties": false }, "flags": { "type": "integer" }, "colors": { "$ref": "#/definitions/RoleColors" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "colors", "flags", "guild", "guild_id", "hoist", "id", "managed", "mentionable", "name", "permissions", "position" ] }, "RoleColors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": "integer" }, "tertiary_color": { "type": "integer" } }, "additionalProperties": false, "required": [ "primary_color" ] }, "UserGuildSettings": { "type": "object", "properties": { "channel_overrides": { "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, { "type": "null" } ] }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "version": { "type": "integer" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "type": "integer", "const": 0 } }, "additionalProperties": false, "required": [ "channel_overrides", "flags", "guild_id", "hide_muted_channels", "message_notifications", "mobile_push", "mute_config", "mute_scheduled_events", "muted", "notify_highlights", "suppress_everyone", "suppress_roles", "version" ] }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] }, "Application": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string", "default": "" }, "type": { "type": "object", "properties": {}, "additionalProperties": true }, "hook": { "type": "boolean", "default": true }, "bot_public": { "type": "boolean", "default": true }, "bot_require_code_grant": { "type": "boolean", "default": false }, "verify_key": { "type": "string" }, "owner": { "$ref": "#/definitions/User" }, "flags": { "type": "integer", "default": 0 }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "default": [] }, "rpc_application_state": { "type": "integer", "default": 0 }, "store_application_state": { "type": "integer", "default": 1 }, "verification_state": { "type": "integer", "default": 1 }, "interactions_endpoint_url": { "type": "string" }, "integration_public": { "type": "boolean", "default": true }, "integration_require_code_grant": { "type": "boolean", "default": false }, "discoverability_state": { "type": "integer", "default": 1 }, "discovery_eligibility_flags": { "type": "integer", "default": 2240 }, "bot": { "$ref": "#/definitions/User" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover_image": { "type": "string" }, "install_params": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "string" } }, "additionalProperties": false, "required": [ "permissions", "scopes" ] }, "terms_of_service_url": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "custom_install_url": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "description", "discoverability_state", "discovery_eligibility_flags", "flags", "hook", "id", "integration_public", "integration_require_code_grant", "name", "owner", "redirect_uris", "rpc_application_state", "store_application_state", "summary", "verification_state", "verify_key" ] }, "Team": { "type": "object", "properties": { "icon": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/definitions/TeamMember" } }, "name": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "members", "name", "owner_user", "owner_user_id" ] }, "TeamMember": { "type": "object", "properties": { "membership_state": { "$ref": "#/definitions/TeamMemberState" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "$ref": "#/definitions/TeamMemberRole" }, "team_id": { "type": "string" }, "team": { "$ref": "#/definitions/Team" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "membership_state", "permissions", "role", "team", "team_id", "user", "user_id" ] }, "TeamMemberState": { "type": "number", "enum": [ 1, 2 ] }, "TeamMemberRole": { "type": "string", "enum": [ "admin", "developer", "read_only" ] }, "Sticker": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "tags": { "type": "string" }, "pack_id": { "type": "string" }, "pack": { "$ref": "#/definitions/StickerPack" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "type": { "$ref": "#/definitions/StickerType" }, "format_type": { "$ref": "#/definitions/StickerFormatType" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "format_type", "id", "name", "pack", "type" ] }, "StickerPack": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "banner_asset_id": { "type": "string" }, "stickers": { "type": "array", "items": { "$ref": "#/definitions/Sticker" } }, "cover_sticker_id": { "type": "string" }, "cover_sticker": { "$ref": "#/definitions/Sticker" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "name", "stickers" ] }, "StickerType": { "type": "number", "enum": [ 1, 2 ] }, "StickerFormatType": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "Attachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "content_type": { "type": "string" }, "message_id": { "type": "string" }, "message": { "$ref": "#/definitions/Message" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id", "message", "message_id", "proxy_url", "size", "url" ] }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "count": { "type": "integer" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "user_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "count", "emoji", "user_ids" ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "MessageType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20, 41, 42, 43, 50, 63, 255 ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "ApplicationCommandType": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "Poll": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "expiry": { "type": "string", "format": "date-time" }, "allow_multiselect": { "type": "boolean" }, "results": { "$ref": "#/definitions/PollResult" } }, "additionalProperties": false, "required": [ "allow_multiselect", "answers", "expiry", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "PollResult": { "type": "object", "properties": { "is_finalized": { "type": "boolean" }, "answer_counts": { "type": "array", "items": { "$ref": "#/definitions/PollAnswerCount" } } }, "additionalProperties": false, "required": [ "answer_counts", "is_finalized" ] }, "PollAnswerCount": { "type": "object", "properties": { "id": { "type": "string" }, "count": { "type": "integer" }, "me_voted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "count", "id", "me_voted" ] }, "VoiceState": { "type": "object", "properties": { "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "member": { "$ref": "#/definitions/Member" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "deaf": { "type": "boolean" }, "mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_mute": { "type": "boolean" }, "self_stream": { "type": "boolean" }, "self_video": { "type": "boolean" }, "suppress": { "type": "boolean" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "deaf", "guild_id", "id", "member", "mute", "self_deaf", "self_mute", "self_video", "session_id", "suppress", "token", "user", "user_id" ] }, "ReadState": { "type": "object", "properties": { "channel_id": { "type": "string" }, "channel": { "$ref": "#/definitions/Channel" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "last_message_id": { "type": "string" }, "public_ack": { "type": "string" }, "notifications_cursor": { "type": "string" }, "last_pin_timestamp": { "type": "string", "format": "date-time" }, "mention_count": { "type": "integer" }, "manual": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel", "channel_id", "id", "last_message_id", "manual", "mention_count", "notifications_cursor", "public_ack", "user", "user_id" ] }, "Ban": { "type": "object", "properties": { "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "executor_id": { "type": "string" }, "executor": { "$ref": "#/definitions/User" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "executor", "executor_id", "guild", "guild_id", "id", "ip", "user", "user_id" ] }, "Template": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "usage_count": { "type": "integer" }, "creator_id": { "type": "string" }, "creator": { "$ref": "#/definitions/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source_guild_id": { "type": "string" }, "source_guild": { "$ref": "#/definitions/Guild" }, "serialized_source_guild": { "$ref": "#/definitions/Guild" }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "created_at", "creator", "creator_id", "id", "name", "serialized_source_guild", "source_guild", "source_guild_id", "updated_at" ] }, "Emoji": { "type": "object", "properties": { "animated": { "type": "boolean" }, "available": { "type": "boolean" }, "guild_id": { "type": "string" }, "guild": { "$ref": "#/definitions/Guild" }, "user_id": { "type": "string" }, "user": { "$ref": "#/definitions/User" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "require_colons": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "animated", "available", "groups", "guild", "guild_id", "id", "managed", "name", "require_colons", "roles", "user", "user_id" ] }, "GuildWelcomeScreen": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "description": { "type": "string" }, "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } } }, "additionalProperties": false, "required": [ "description", "enabled", "welcome_channels" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "AckBulkSchema": { "type": "object", "properties": { "read_states": { "type": "array", "items": { "type": "object", "properties": { "channel_id": { "type": "string" }, "message_id": { "type": "string" }, "read_state_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel_id", "message_id", "read_state_type" ] } } }, "additionalProperties": false, "required": [ "read_states" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ActivitySchema": { "type": "object", "properties": { "afk": { "type": "boolean" }, "status": { "$ref": "#/definitions/Status" }, "activities": { "type": "array", "items": { "$ref": "#/definitions/Activity" } }, "since": { "type": "integer" } }, "additionalProperties": false, "required": [ "status" ], "definitions": { "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/definitions/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "additionalProperties": false, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "type": "number", "enum": [ 0, 1, 2, 4, 5 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationAuthorizeSchema": { "type": "object", "properties": { "authorize": { "type": "boolean" }, "guild_id": { "type": "string" }, "permissions": { "type": "string" }, "captcha_key": { "type": "string" }, "code": { "minLength": 6, "maxLength": 6, "type": "string" } }, "additionalProperties": false, "required": [ "authorize", "guild_id", "permissions" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "AutomodMentionSpamRuleSchema": { "type": "object", "properties": { "mention_total_limit": { "type": "integer" }, "mention_raid_protection_enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "mention_raid_protection_enabled", "mention_total_limit" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "AutomodSuspectedSpamRuleSchema": { "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "AutomodCommonlyFlaggedWordsRuleSchema": { "type": "object", "properties": { "allow_list": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "presets": { "type": "array", "items": [ { "type": "integer" } ], "minItems": 1, "maxItems": 1 } }, "additionalProperties": false, "required": [ "allow_list", "presets" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "AutomodCustomWordsRuleSchema": { "type": "object", "properties": { "allow_list": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "keyword_filter": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "regex_patterns": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 } }, "additionalProperties": false, "required": [ "allow_list", "keyword_filter", "regex_patterns" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "AutomodRuleSchema": { "type": "object", "properties": { "creator_id": { "type": "string" }, "enabled": { "type": "boolean" }, "event_type": { "type": "integer" }, "exempt_channels": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "exempt_roles": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "guild_id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer" }, "trigger_type": { "type": "integer" }, "trigger_metadata": { "anyOf": [ { "$ref": "#/definitions/AutomodMentionSpamRuleSchema" }, { "$ref": "#/definitions/AutomodSuspectedSpamRuleSchema" }, { "$ref": "#/definitions/AutomodCommonlyFlaggedWordsRuleSchema" }, { "$ref": "#/definitions/AutomodCustomWordsRuleSchema" } ] } }, "additionalProperties": false, "required": [ "creator_id", "enabled", "event_type", "exempt_channels", "exempt_roles", "guild_id", "name", "position", "trigger_metadata", "trigger_type" ], "definitions": { "AutomodMentionSpamRuleSchema": { "type": "object", "properties": { "mention_total_limit": { "type": "integer" }, "mention_raid_protection_enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "mention_raid_protection_enabled", "mention_total_limit" ] }, "AutomodSuspectedSpamRuleSchema": { "type": "object", "additionalProperties": false }, "AutomodCommonlyFlaggedWordsRuleSchema": { "type": "object", "properties": { "allow_list": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "presets": { "type": "array", "items": [ { "type": "integer" } ], "minItems": 1, "maxItems": 1 } }, "additionalProperties": false, "required": [ "allow_list", "presets" ] }, "AutomodCustomWordsRuleSchema": { "type": "object", "properties": { "allow_list": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "keyword_filter": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, "regex_patterns": { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 } }, "additionalProperties": false, "required": [ "allow_list", "keyword_filter", "regex_patterns" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "BackupCodesChallengeSchema": { "type": "object", "properties": { "password": { "minLength": 1, "maxLength": 72, "type": "string" } }, "additionalProperties": false, "required": [ "password" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "BanCreateSchema": { "type": "object", "properties": { "delete_message_seconds": { "type": "string" }, "delete_message_days": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "BanModeratorSchema": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "guild_id": { "type": "string" }, "executor_id": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "executor_id", "guild_id", "id", "user_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "BanRegistrySchema": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "guild_id": { "type": "string" }, "executor_id": { "type": "string" }, "ip": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "executor_id", "guild_id", "id", "user_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "BotModifySchema": { "type": "object", "properties": { "avatar": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "BulkBanSchema": { "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "string" } }, "delete_message_seconds": { "type": "integer" } }, "additionalProperties": false, "required": [ "user_ids" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "BulkDeleteSchema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "messages" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ChannelModifySchema": { "type": "object", "properties": { "name": { "maxLength": 100, "type": "string" }, "type": { "enum": [ 0, 1, 10, 11, 12, 13, 14, 15, 2, 255, 3, 33, 34, 35, 4, 5, 6, 64, 7, 8, 9 ], "type": "number" }, "topic": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "rate_limit_per_user": { "type": "integer" }, "position": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" }, "allow": { "type": "string" }, "deny": { "type": "string" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] } }, "parent_id": { "type": "string" }, "id": { "type": "string" }, "nsfw": { "type": "boolean" }, "rtc_region": { "type": "string" }, "default_auto_archive_duration": { "type": "integer" }, "default_reaction_emoji": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "default_thread_rate_limit_per_user": { "type": "integer" }, "video_quality_mode": { "type": "integer" } }, "additionalProperties": false, "definitions": { "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ChannelPermissionOverwriteSchema": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ], "definitions": { "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ChannelReorderSchema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" }, "lock_permissions": { "type": "boolean" }, "parent_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "id" ] }, "$schema": "http://json-schema.org/draft-07/schema#" }, "CodesVerificationSchema": { "type": "object", "properties": { "key": { "type": "string" }, "nonce": { "type": "string" }, "regenerate": { "type": "boolean" } }, "additionalProperties": false, "required": [ "key", "nonce" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ConnectedAccountSchema": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "token_data": { "$ref": "#/definitions/ConnectedAccountTokenData" }, "friend_sync": { "type": "boolean" }, "name": { "type": "string" }, "revoked": { "type": "boolean" }, "show_activity": { "type": "integer" }, "type": { "type": "string" }, "verified": { "type": "boolean" }, "visibility": { "type": "integer" }, "integrations": { "type": "array", "items": { "type": "string" } }, "metadata_": {}, "metadata_visibility": { "type": "integer" }, "two_way_link": { "type": "boolean" } }, "additionalProperties": false, "required": [ "external_id", "name", "type", "user_id" ], "definitions": { "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "additionalProperties": false, "required": [ "access_token", "fetched_at" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "ConnectionCallbackSchema": { "type": "object", "properties": { "code": { "type": "string" }, "state": { "type": "string" }, "insecure": { "type": "boolean" }, "friend_sync": { "type": "boolean" }, "openid_params": {} }, "additionalProperties": false, "required": [ "friend_sync", "insecure", "state" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ConnectionUpdateSchema": { "type": "object", "properties": { "visibility": { "type": "boolean" }, "show_activity": { "type": "boolean" }, "metadata_visibility": { "type": "boolean" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "DmChannelCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "recipients" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "EmailDomainLookupSchema": { "type": "object", "properties": { "allow_multiple_guilds": { "type": "boolean" }, "email": { "type": "string" }, "use_verification_code": { "type": "boolean" }, "guild_id": { "type": "string" } }, "additionalProperties": false, "required": [ "allow_multiple_guilds", "email", "use_verification_code" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "EmailDomainLookupVerifyCodeSchema": { "type": "object", "properties": { "email": { "type": "string" }, "guild_id": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "email", "guild_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "EmojiCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "require_colons": { "type": [ "null", "boolean" ] }, "roles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "image" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "EmojiModifySchema": { "type": "object", "properties": { "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "ForgotPasswordSchema": { "type": "object", "properties": { "login": { "type": "string" }, "captcha_key": { "type": "string" } }, "additionalProperties": false, "required": [ "login" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GreetRequestSchema": { "type": "object", "properties": { "sticker_ids": { "type": "array", "items": { "type": "string" } }, "allowed_mentions": { "$ref": "#/definitions/AllowedMentions" }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "message_id" ] } }, "additionalProperties": false, "required": [ "sticker_ids" ], "definitions": { "AllowedMentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "enum": [ "everyone", "roles", "users" ], "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildCreateSchema": { "type": "object", "properties": { "name": { "maxLength": 100, "type": "string" }, "region": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "channels": { "type": "array", "items": { "$ref": "#/definitions/ChannelModifySchema" } }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" }, "guild_template_code": { "type": "string" }, "staff_only": { "type": "boolean" } }, "additionalProperties": false, "definitions": { "ChannelModifySchema": { "type": "object", "properties": { "name": { "maxLength": 100, "type": "string" }, "type": { "enum": [ 0, 1, 10, 11, 12, 13, 14, 15, 2, 255, 3, 33, 34, 35, 4, 5, 6, 64, 7, 8, 9 ], "type": "number" }, "topic": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "rate_limit_per_user": { "type": "integer" }, "position": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/ChannelPermissionOverwriteType" }, "allow": { "type": "string" }, "deny": { "type": "string" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] } }, "parent_id": { "type": "string" }, "id": { "type": "string" }, "nsfw": { "type": "boolean" }, "rtc_region": { "type": "string" }, "default_auto_archive_duration": { "type": "integer" }, "default_reaction_emoji": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "default_thread_rate_limit_per_user": { "type": "integer" }, "video_quality_mode": { "type": "integer" } }, "additionalProperties": false }, "ChannelPermissionOverwriteType": { "type": "number", "enum": [ 0, 1, 2 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildSubscriptionsBulkSchema": { "type": "object", "properties": { "subscriptions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/GuildSubscriptionSchema" } } }, "additionalProperties": false, "required": [ "subscriptions" ], "definitions": { "GuildSubscriptionSchema": { "type": "object", "properties": { "channels": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } } } }, "members": { "type": "array", "items": { "type": "string" } }, "activities": { "type": "boolean" }, "threads": { "type": "boolean" }, "typing": { "const": true, "type": "boolean" }, "member_updates": { "type": "boolean" }, "thread_member_lists": { "type": "array", "items": {} } }, "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildSubscriptionSchema": { "type": "object", "properties": { "channels": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } } } }, "members": { "type": "array", "items": { "type": "string" } }, "activities": { "type": "boolean" }, "threads": { "type": "boolean" }, "typing": { "const": true, "type": "boolean" }, "member_updates": { "type": "boolean" }, "thread_member_lists": { "type": "array", "items": {} } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildTemplateCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "avatar": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildUpdateSchema": { "type": "object", "properties": { "banner": { "type": [ "null", "string" ] }, "splash": { "type": [ "null", "string" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": "string" }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": "string" }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "safety_alerts_channel_id": { "type": [ "null", "string" ] }, "name": { "maxLength": 100, "type": "string" }, "region": { "type": "string" }, "icon": { "type": [ "null", "string" ] }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" }, "guild_template_code": { "type": "string" }, "staff_only": { "type": "boolean" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "GuildUpdateWelcomeScreenSchema": { "type": "object", "properties": { "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "channel_id": { "type": "string" }, "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } }, "enabled": { "type": "boolean" }, "description": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "HubWaitlistSignupSchema": { "type": "object", "properties": { "email": { "type": "string" }, "school": { "type": "string" } }, "additionalProperties": false, "required": [ "email", "school" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "InviteCreateSchema": { "type": "object", "properties": { "target_user_id": { "type": "string" }, "target_type": { "type": "string" }, "validate": { "type": "string" }, "max_age": { "type": "integer" }, "max_uses": { "type": "integer" }, "temporary": { "type": "boolean" }, "unique": { "type": "boolean" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" }, "flags": { "type": "integer" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "MFAResponse": { "type": "object", "properties": { "ticket": { "type": "string" }, "mfa": { "type": "boolean", "const": true }, "sms": { "type": "boolean", "const": false }, "token": { "type": "null" } }, "additionalProperties": false, "required": [ "mfa", "sms", "ticket", "token" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "WebAuthnResponse": { "type": "object", "properties": { "webauthn": { "type": "string" }, "ticket": { "type": "string" }, "mfa": { "type": "boolean", "const": true }, "sms": { "type": "boolean", "const": false }, "token": { "type": "null" } }, "additionalProperties": false, "required": [ "mfa", "sms", "ticket", "token", "webauthn" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "LoginResponse": { "anyOf": [ { "$ref": "#/definitions/TokenResponse" }, { "$ref": "#/definitions/MFAResponse" }, { "$ref": "#/definitions/WebAuthnResponse" } ], "definitions": { "TokenResponse": { "type": "object", "properties": { "token": { "type": "string" }, "settings": { "$ref": "#/definitions/UserSettings" } }, "additionalProperties": false, "required": [ "settings", "token" ] }, "UserSettings": { "type": "object", "properties": { "index": { "type": "string" }, "afk_timeout": { "type": "integer", "default": 3600 }, "allow_accessibility_detection": { "type": "boolean", "default": true }, "animate_emoji": { "type": "boolean", "default": true }, "animate_stickers": { "type": "integer", "default": 0 }, "contact_sync_enabled": { "type": "boolean", "default": false }, "convert_emoticons": { "type": "boolean", "default": false }, "custom_status": { "anyOf": [ { "$ref": "#/definitions/CustomStatus" }, { "type": "null" } ], "default": null }, "default_guilds_restricted": { "type": "boolean", "default": false }, "detect_platform_accounts": { "type": "boolean", "default": false }, "developer_mode": { "type": "boolean", "default": true }, "disable_games_tab": { "type": "boolean", "default": true }, "enable_tts_command": { "type": "boolean", "default": false }, "explicit_content_filter": { "type": "integer", "default": 0 }, "friend_discovery_flags": { "type": "integer", "default": 0 }, "friend_source_flags": { "$ref": "#/definitions/FriendSourceFlags" }, "gateway_connected": { "type": "boolean", "default": false }, "gif_auto_play": { "type": "boolean", "default": false }, "guild_folders": { "type": "array", "items": { "$ref": "#/definitions/GuildFolder" }, "default": [] }, "guild_positions": { "type": "array", "items": { "type": "string" }, "default": [] }, "inline_attachment_media": { "type": "boolean", "default": true }, "inline_embed_media": { "type": "boolean", "default": true }, "locale": { "type": "string", "default": "en-US" }, "message_display_compact": { "type": "boolean", "default": false }, "native_phone_integration_enabled": { "type": "boolean", "default": true }, "render_embeds": { "type": "boolean", "default": true }, "render_reactions": { "type": "boolean", "default": true }, "restricted_guilds": { "type": "array", "items": { "type": "string" }, "default": [] }, "show_current_game": { "type": "boolean", "default": true }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string", "default": "online" }, "stream_notifications_enabled": { "type": "boolean", "default": false }, "theme": { "enum": [ "dark", "light" ], "type": "string", "default": "dark" }, "timezone_offset": { "type": "integer", "default": 0 }, "view_nsfw_guilds": { "type": "boolean", "default": true } }, "additionalProperties": false, "required": [ "afk_timeout", "allow_accessibility_detection", "animate_emoji", "animate_stickers", "contact_sync_enabled", "convert_emoticons", "custom_status", "default_guilds_restricted", "detect_platform_accounts", "developer_mode", "disable_games_tab", "enable_tts_command", "explicit_content_filter", "friend_discovery_flags", "friend_source_flags", "gateway_connected", "gif_auto_play", "guild_folders", "guild_positions", "index", "inline_attachment_media", "inline_embed_media", "locale", "message_display_compact", "native_phone_integration_enabled", "render_embeds", "render_reactions", "restricted_guilds", "show_current_game", "status", "stream_notifications_enabled", "theme", "timezone_offset", "view_nsfw_guilds" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } }, "additionalProperties": false }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "color", "guild_ids", "id", "name" ] }, "MFAResponse": { "type": "object", "properties": { "ticket": { "type": "string" }, "mfa": { "type": "boolean", "const": true }, "sms": { "type": "boolean", "const": false }, "token": { "type": "null" } }, "additionalProperties": false, "required": [ "mfa", "sms", "ticket", "token" ] }, "WebAuthnResponse": { "type": "object", "properties": { "webauthn": { "type": "string" }, "ticket": { "type": "string" }, "mfa": { "type": "boolean", "const": true }, "sms": { "type": "boolean", "const": false }, "token": { "type": "null" } }, "additionalProperties": false, "required": [ "mfa", "sms", "ticket", "token", "webauthn" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "LoginSchema": { "type": "object", "properties": { "login": { "type": "string" }, "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "undelete": { "type": "boolean" }, "captcha_key": { "type": "string" }, "login_source": { "type": "string" }, "gift_code_sku_id": { "type": "string" } }, "additionalProperties": false, "required": [ "login", "password" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MemberChangeProfileSchema": { "type": "object", "properties": { "banner": { "type": [ "null", "string" ] }, "nick": { "type": "string" }, "bio": { "type": "string" }, "pronouns": { "type": "string" }, "theme_colors": { "items": [ { "type": "integer" }, { "type": "integer" } ], "type": "array", "minItems": 2, "maxItems": 2 } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "MemberChangeSchema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "nick": { "type": "string" }, "avatar": { "type": [ "null", "string" ] }, "bio": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "MemberNickChangeSchema": { "type": "object", "properties": { "nick": { "type": "string" } }, "additionalProperties": false, "required": [ "nick" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "MessageAcknowledgeSchema": { "type": "object", "properties": { "manual": { "type": "boolean" }, "mention_count": { "type": "integer" }, "flags": { "type": "integer" }, "last_viewed": { "type": "integer" }, "token": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "MessageCreateSchema": { "type": "object", "properties": { "type": { "type": "integer" }, "content": { "type": "string" }, "mobile_network_type": { "type": "string" }, "nonce": { "type": "string" }, "channel_id": { "type": "string" }, "tts": { "type": "boolean" }, "flags": { "type": "integer" }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "embed": { "$ref": "#/definitions/Embed" }, "allowed_mentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "message_id" ] }, "payload_json": { "type": "string" }, "file": { "type": "object", "properties": { "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename" ] }, "attachments": { "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion", "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "uploaded_filename": { "type": "string" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "uploaded_filename" ] } ] } }, "sticker_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "components": { "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, { "type": "null" } ] }, "poll": { "$ref": "#/definitions/PollCreationSchema" }, "enforce_nonce": { "type": "boolean" }, "applied_tags": { "type": "array", "items": { "type": "string" } }, "thread_name": { "type": "string" }, "avatar_url": { "type": "string" }, "interaction": { "$ref": "#/definitions/MessageInteractionSchema" }, "interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" } }, "additionalProperties": false, "definitions": { "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "PollCreationSchema": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "duration": { "type": "integer" }, "allow_multiselect": { "type": "boolean" }, "layout_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "answers", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "MessageInteractionSchema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" }, "command_type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "ephemerality_reason": { "type": "integer" }, "user": { "$ref": "#/definitions/PublicUser" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "original_response_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "interacted_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "triggering_interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" }, "target_user": { "$ref": "#/definitions/PublicUser" }, "target_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] }, "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "PollCreationSchema": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "duration": { "type": "integer" }, "allow_multiselect": { "type": "boolean" }, "layout_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "answers", "question" ], "definitions": { "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MessageInteractionSchema": { "$ref": "#/definitions/MessageInteractionSchema", "definitions": { "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] }, "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false }, "MessageInteractionSchema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" }, "command_type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "ephemerality_reason": { "type": "integer" }, "user": { "$ref": "#/definitions/PublicUser" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "original_response_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "interacted_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "triggering_interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" }, "target_user": { "$ref": "#/definitions/PublicUser" }, "target_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MessageEditSchema": { "type": "object", "properties": { "embed": { "$ref": "#/definitions/Embed" }, "file": { "type": "object", "properties": { "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename" ] }, "flags": { "type": "integer" }, "channel_id": { "type": "string" }, "content": { "type": "string" }, "mobile_network_type": { "type": "string" }, "nonce": { "type": "string" }, "tts": { "type": "boolean" }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "allowed_mentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "message_id" ] }, "payload_json": { "type": "string" }, "attachments": { "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion", "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "uploaded_filename": { "type": "string" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "uploaded_filename" ] } ] } }, "sticker_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "components": { "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/ActionRowComponent" } }, { "type": "null" } ] }, "poll": { "$ref": "#/definitions/PollCreationSchema" }, "enforce_nonce": { "type": "boolean" }, "applied_tags": { "type": "array", "items": { "type": "string" } }, "thread_name": { "type": "string" }, "avatar_url": { "type": "string" }, "interaction": { "$ref": "#/definitions/MessageInteractionSchema" }, "interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" } }, "additionalProperties": false, "definitions": { "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "ActionRowComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.ActionRow" }, "components": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/ButtonComponent" }, { "$ref": "#/definitions/SelectMenuComponent" }, { "$ref": "#/definitions/StringSelectMenuComponent" }, { "$ref": "#/definitions/TextInputComponent" } ] } } }, "additionalProperties": false, "required": [ "components", "type" ] }, "MessageComponentType.ActionRow": { "type": "number", "const": 1 }, "ButtonComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.Button" }, "style": { "$ref": "#/definitions/ButtonStyle" }, "label": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "custom_id": { "type": "string" }, "sku_id": { "type": "string" }, "url": { "type": "string" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "style", "type" ] }, "MessageComponentType.Button": { "type": "number", "const": 2 }, "ButtonStyle": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "SelectMenuComponent": { "type": "object", "properties": { "type": { "enum": [ 3, 5, 6, 7, 8 ], "type": "number" }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "type" ] }, "SelectMenuDefaultOption": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "channel", "role", "user" ], "type": "string" } }, "additionalProperties": false, "required": [ "id", "type" ] }, "StringSelectMenuComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.StringSelect" }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuOption" } }, "custom_id": { "type": "string" }, "channel_types": { "type": "array", "items": { "type": "integer" } }, "placeholder": { "type": "string" }, "default_values": { "type": "array", "items": { "$ref": "#/definitions/SelectMenuDefaultOption" } }, "min_values": { "type": "integer" }, "max_values": { "type": "integer" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "custom_id", "options", "type" ] }, "MessageComponentType.StringSelect": { "type": "number", "const": 3 }, "SelectMenuOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" }, "default": { "type": "boolean" } }, "additionalProperties": false, "required": [ "label", "value" ] }, "TextInputComponent": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MessageComponentType.TextInput" }, "custom_id": { "type": "string" }, "style": { "$ref": "#/definitions/TextInputStyle" }, "label": { "type": "string" }, "min_length": { "type": "integer" }, "max_length": { "type": "integer" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "placeholder": { "type": "string" } }, "additionalProperties": false, "required": [ "custom_id", "label", "style", "type" ] }, "MessageComponentType.TextInput": { "type": "number", "const": 4 }, "TextInputStyle": { "type": "number", "enum": [ 1, 2 ] }, "PollCreationSchema": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "duration": { "type": "integer" }, "allow_multiselect": { "type": "boolean" }, "layout_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "answers", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] }, "MessageInteractionSchema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/InteractionType" }, "name": { "type": "string" }, "command_type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "ephemerality_reason": { "type": "integer" }, "user": { "$ref": "#/definitions/PublicUser" }, "authorizing_integration_owners": { "type": "object", "properties": {}, "additionalProperties": true }, "original_response_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "interacted_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" }, "triggering_interaction_metadata": { "$ref": "#/definitions/MessageInteractionSchema" }, "target_user": { "$ref": "#/definitions/PublicUser" }, "target_message_id": { "description": "A container for useful snowflake-related methods.", "$ref": "#/definitions/Snowflake" } }, "additionalProperties": false, "required": [ "id", "name", "type" ] }, "InteractionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "PublicUser": { "type": "object", "properties": { "id": { "description": "A Twitter-like snowflake, except the epoch is 2015-01-01T00:00:00.000Z\n```\nIf we have a snowflake '266241948824764416' we can represent it as binary:\n\n64 22 17 12 0\n 000000111011000111100001101001000101000000 00001 00000 000000000000\n number of ms since Discord epoch worker pid increment\n```", "type": "string" }, "premium_since": { "type": "string", "format": "date-time" }, "avatar": { "type": "string" }, "username": { "type": "string" }, "discriminator": { "type": "string" }, "public_flags": { "type": "integer" }, "accent_color": { "type": "integer" }, "banner": { "type": "string" }, "bio": { "type": "string" }, "bot": { "type": "boolean" }, "premium_type": { "type": "integer" }, "theme_colors": { "type": "array", "items": { "type": "integer" } }, "pronouns": { "type": "string" }, "badge_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "bio", "bot", "discriminator", "id", "premium_since", "premium_type", "public_flags", "username" ] }, "Snowflake": { "description": "A container for useful snowflake-related methods.", "type": "object", "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "MfaCodesSchema": { "type": "object", "properties": { "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "regenerate": { "type": "boolean" } }, "additionalProperties": false, "required": [ "password" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ModifyGuildStickerSchema": { "type": "object", "properties": { "name": { "minLength": 2, "maxLength": 30, "type": "string" }, "description": { "maxLength": 100, "type": "string" }, "tags": { "maxLength": 200, "type": "string" } }, "additionalProperties": false, "required": [ "name", "tags" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "PasswordResetSchema": { "type": "object", "properties": { "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "token": { "type": "string" } }, "additionalProperties": false, "required": [ "password", "token" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "PreloadMessagesRequestSchema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "channels" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "PruneSchema": { "type": "object", "properties": { "days": { "type": "integer" } }, "additionalProperties": false, "required": [ "days" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "PurgeSchema": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "after", "before" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "RefreshUrlsRequestSchema": { "type": "object", "properties": { "attachment_urls": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "attachment_urls" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "RegisterSchema": { "type": "object", "properties": { "username": { "minLength": 2, "type": "string" }, "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "consent": { "type": "boolean" }, "email": { "format": "email", "type": "string" }, "fingerprint": { "type": "string" }, "invite": { "type": "string" }, "date_of_birth": { "type": "string" }, "gift_code_sku_id": { "type": "string" }, "captcha_key": { "type": "string" }, "promotional_email_opt_in": { "type": "boolean" }, "unique_username_registration": { "type": "boolean" }, "global_name": { "type": "string" } }, "additionalProperties": false, "required": [ "consent", "username" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "RelationshipPostSchema": { "type": "object", "properties": { "discriminator": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false, "required": [ "discriminator", "username" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "RelationshipPutSchema": { "type": "object", "properties": { "type": { "enum": [ 1, 2, 3, 4 ], "type": "number" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "RequestGuildMembersSchema": { "type": "object", "properties": { "guild_id": { "anyOf": [ { "type": "array", "items": [ { "type": "string" } ], "minItems": 1, "maxItems": 1 }, { "type": "string" } ] }, "query": { "type": "string" }, "limit": { "type": "integer" }, "presences": { "type": "boolean" }, "user_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "nonce": { "type": "string" } }, "additionalProperties": false, "required": [ "guild_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "RoleModifySchema": { "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "type": "string" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" }, "colors": { "type": "object", "properties": { "primary_color": { "type": "integer" }, "secondary_color": { "type": [ "null", "integer" ] }, "tertiary_color": { "type": [ "null", "integer" ] } }, "additionalProperties": false, "required": [ "primary_color", "secondary_color" ] } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "RolePositionUpdateSchema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } }, "additionalProperties": false, "required": [ "id", "position" ] }, "$schema": "http://json-schema.org/draft-07/schema#" }, "SelectProtocolSchema": { "type": "object", "properties": { "protocol": { "enum": [ "udp", "webrtc" ], "type": "string" }, "data": { "anyOf": [ { "type": "object", "properties": { "address": { "type": "string" }, "port": { "type": "integer" }, "mode": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "mode", "port" ] }, { "type": "string" } ] }, "sdp": { "type": "string" }, "codecs": { "type": "array", "items": { "type": "object", "properties": { "name": { "enum": [ "H264", "VP8", "VP9", "opus" ], "type": "string" }, "type": { "enum": [ "audio", "video" ], "type": "string" }, "priority": { "type": "integer" }, "payload_type": { "type": "integer" }, "rtx_payload_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "name", "payload_type", "priority", "type" ] } }, "rtc_connection_id": { "type": "string" } }, "additionalProperties": false, "required": [ "data", "protocol" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SettingsProtoUpdateSchema": { "type": "object", "properties": { "settings": { "type": "string" }, "required_data_version": { "type": "integer" } }, "additionalProperties": false, "required": [ "settings" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "SettingsProtoUpdateJsonSchema": { "type": "object", "properties": { "settings": { "$ref": "#/definitions/JsonValue" }, "required_data_version": { "type": "integer" } }, "additionalProperties": false, "required": [ "settings" ], "definitions": { "JsonValue": { "description": "Represents any possible JSON value:\n- number\n- string\n- boolean\n- null\n- object (with any JSON value as property)\n- array (with any JSON value as element)", "anyOf": [ { "description": "Represents a JSON object.", "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonValue" } }, { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9]+$": { "$ref": "#/definitions/JsonValue" } }, "properties": { "length": { "type": "integer" }, "__@unscopables@689": { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9]+$": { "type": "boolean" } }, "properties": { "length": { "type": "boolean" }, "toString": { "type": "boolean" }, "toLocaleString": { "type": "boolean" }, "pop": { "type": "boolean" }, "push": { "type": "boolean" }, "concat": { "type": "boolean" }, "join": { "type": "boolean" }, "reverse": { "type": "boolean" }, "shift": { "type": "boolean" }, "slice": { "type": "boolean" }, "sort": { "type": "boolean" }, "splice": { "type": "boolean" }, "unshift": { "type": "boolean" }, "indexOf": { "type": "boolean" }, "lastIndexOf": { "type": "boolean" }, "every": { "type": "boolean" }, "some": { "type": "boolean" }, "forEach": { "type": "boolean" }, "map": { "type": "boolean" }, "filter": { "type": "boolean" }, "reduce": { "type": "boolean" }, "reduceRight": { "type": "boolean" }, "find": { "type": "boolean" }, "findIndex": { "type": "boolean" }, "fill": { "type": "boolean" }, "copyWithin": { "type": "boolean" }, "entries": { "type": "boolean" }, "keys": { "type": "boolean" }, "values": { "type": "boolean" }, "includes": { "type": "boolean" }, "flatMap": { "type": "boolean" }, "flat": { "type": "boolean" }, "at": { "type": "boolean" }, "findLast": { "type": "boolean" }, "findLastIndex": { "type": "boolean" }, "toReversed": { "type": "boolean" }, "toSorted": { "type": "boolean" }, "toSpliced": { "type": "boolean" }, "with": { "type": "boolean" }, "containsAll": { "type": "boolean" }, "partition": { "type": "boolean" }, "single": { "type": "boolean" }, "forEachAsync": { "type": "boolean" }, "remove": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "distinct": { "type": "boolean" }, "distinctBy": { "type": "boolean" }, "intersect": { "type": "boolean" }, "except": { "type": "boolean" }, "__@iterator@687": { "type": "boolean" }, "__@unscopables@689": { "type": "boolean" } } } }, "required": [ "__@unscopables@689", "length" ] }, { "type": [ "null", "string", "integer", "boolean" ] } ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "TeamCreateSchema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TemplateCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TemplateModifySchema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TotpDisableSchema": { "type": "object", "properties": { "code": { "minLength": 6, "maxLength": 6, "type": "string" } }, "additionalProperties": false, "required": [ "code" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TotpEnableSchema": { "type": "object", "properties": { "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "code": { "minLength": 6, "maxLength": 6, "type": "string" }, "secret": { "type": "string" } }, "additionalProperties": false, "required": [ "password" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "TotpSchema": { "type": "object", "properties": { "code": { "type": "string" }, "ticket": { "type": "string" }, "gift_code_sku_id": { "type": [ "null", "string" ] }, "login_source": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "code", "ticket" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UploadAttachmentRequestSchema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/definitions/UploadAttachmentRequest" } } }, "additionalProperties": false, "required": [ "files" ], "definitions": { "UploadAttachmentRequest": { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "file_size": { "type": "integer" }, "is_clip": { "type": "boolean" }, "original_content_type": { "type": "string" } }, "additionalProperties": false, "required": [ "file_size", "filename" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserDeleteSchema": { "type": "object", "properties": { "user_id": { "type": "string" } }, "additionalProperties": false, "required": [ "user_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UserGuildSettingsSchema": { "type": "object", "properties": { "channel_overrides": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChannelOverride" } }, "version": { "type": "integer" }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/definitions/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "guild_id": { "type": [ "null", "string" ] }, "flags": { "type": "integer" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "const": 0, "type": "number" } }, "additionalProperties": false, "definitions": { "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/definitions/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": [ "null", "string" ] } }, "additionalProperties": false, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "additionalProperties": false, "required": [ "end_time", "selected_time_window" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserModifySchema": { "type": "object", "properties": { "username": { "minLength": 2, "type": "string" }, "avatar": { "type": [ "null", "string" ] }, "bio": { "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": [ "null", "string" ] }, "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "new_password": { "minLength": 1, "maxLength": 72, "type": "string" }, "code": { "minLength": 6, "maxLength": 6, "type": "string" }, "email": { "format": "email", "type": "string" }, "discriminator": { "minLength": 4, "maxLength": 4, "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "UserNoteUpdateSchema": { "type": "object", "properties": { "note": { "type": "string" } }, "additionalProperties": false, "required": [ "note" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "UserProfileModifySchema": { "type": "object", "properties": { "bio": { "type": "string" }, "accent_color": { "type": [ "null", "integer" ] }, "banner": { "type": [ "null", "string" ] }, "pronouns": { "type": "string" }, "theme_colors": { "items": [ { "type": "integer" }, { "type": "integer" } ], "type": "array", "minItems": 2, "maxItems": 2 } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "VanityUrlSchema": { "type": "object", "properties": { "code": { "minLength": 1, "maxLength": 20, "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "VerifyEmailSchema": { "type": "object", "properties": { "captcha_key": { "type": [ "null", "string" ] }, "token": { "type": "string" } }, "additionalProperties": false, "required": [ "token" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "VoiceStateUpdateSchema": { "type": "object", "properties": { "guild_id": { "type": "string" }, "channel_id": { "type": "string" }, "self_mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_video": { "type": "boolean" }, "preferred_region": { "type": "string" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "suppress": { "type": "boolean" }, "flags": { "type": "integer" } }, "additionalProperties": false, "required": [ "self_deaf", "self_mute" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "GenerateWebAuthnCredentialsSchema": { "type": "object", "properties": { "password": { "type": "string" } }, "additionalProperties": false, "required": [ "password" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "CreateWebAuthnCredentialSchema": { "type": "object", "properties": { "credential": { "type": "string" }, "name": { "type": "string" }, "ticket": { "type": "string" } }, "additionalProperties": false, "required": [ "credential", "name", "ticket" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "WebAuthnPostSchema": { "anyOf": [ { "$ref": "#/definitions/GenerateWebAuthnCredentialsSchema" }, { "$ref": "#/definitions/CreateWebAuthnCredentialSchema" } ], "definitions": { "GenerateWebAuthnCredentialsSchema": { "type": "object", "properties": { "password": { "type": "string" } }, "additionalProperties": false, "required": [ "password" ] }, "CreateWebAuthnCredentialSchema": { "type": "object", "properties": { "credential": { "type": "string" }, "name": { "type": "string" }, "ticket": { "type": "string" } }, "additionalProperties": false, "required": [ "credential", "name", "ticket" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "WebAuthnTotpSchema": { "type": "object", "properties": { "code": { "type": "string" }, "ticket": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "ticket" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "WebhookCreateSchema": { "type": "object", "properties": { "name": { "maxLength": 80, "type": "string" }, "avatar": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "WebhookExecuteSchema": { "type": "object", "properties": { "content": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "tts": { "type": "boolean" }, "embeds": { "type": "array", "items": { "$ref": "#/definitions/Embed" } }, "allowed_mentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false }, "components": { "type": "array", "items": {} }, "file": { "type": "object", "properties": { "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename" ] }, "payload_json": { "type": "string" }, "attachments": { "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id" ] } }, "flags": { "type": "integer" }, "thread_name": { "type": "string" }, "applied_tags": { "type": "array", "items": { "type": "string" } }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "message_id" ] }, "sticker_ids": { "type": "array", "items": { "type": "string" } }, "nonce": { "type": "string" }, "enforce_nonce": { "type": "boolean" }, "poll": { "$ref": "#/definitions/PollCreationSchema" } }, "additionalProperties": false, "definitions": { "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/definitions/EmbedImage" }, "thumbnail": { "$ref": "#/definitions/EmbedImage" }, "video": { "$ref": "#/definitions/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } }, "additionalProperties": false }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } }, "additionalProperties": false }, "PollCreationSchema": { "type": "object", "properties": { "question": { "$ref": "#/definitions/PollMedia" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/PollAnswer" } }, "duration": { "type": "integer" }, "allow_multiselect": { "type": "boolean" }, "layout_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "answers", "question" ] }, "PollMedia": { "type": "object", "properties": { "text": { "type": "string" }, "emoji": { "$ref": "#/definitions/PartialEmoji" } }, "additionalProperties": false }, "PartialEmoji": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name" ] }, "PollAnswer": { "type": "object", "properties": { "answer_id": { "type": "string" }, "poll_media": { "$ref": "#/definitions/PollMedia" } }, "additionalProperties": false, "required": [ "poll_media" ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }, "WebhookUpdateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "avatar": { "type": "string" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "$schema": "http://json-schema.org/draft-07/schema#" }, "WidgetModifySchema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "channel_id": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "enabled" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "VoiceIdentifySchema": { "type": "object", "properties": { "server_id": { "type": "string" }, "user_id": { "type": "string" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "video": { "type": "boolean" }, "streams": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "audio", "screen", "video" ], "type": "string" }, "rid": { "type": "string" }, "quality": { "type": "integer" } }, "additionalProperties": false, "required": [ "quality", "rid", "type" ] } }, "max_secure_frames_version": { "type": "integer" } }, "additionalProperties": false, "required": [ "server_id", "session_id", "token", "user_id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "VoiceVideoSchema": { "type": "object", "properties": { "audio_ssrc": { "type": "integer" }, "video_ssrc": { "type": "integer" }, "rtx_ssrc": { "type": "integer" }, "user_id": { "type": "string" }, "streams": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "audio", "screen", "video" ], "type": "string" }, "rid": { "type": "string" }, "ssrc": { "type": "integer" }, "active": { "type": "boolean" }, "quality": { "type": "integer" }, "rtx_ssrc": { "type": "integer" }, "max_bitrate": { "type": "integer" }, "max_framerate": { "type": "integer" }, "max_resolution": { "type": "object", "properties": { "type": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "additionalProperties": false, "required": [ "height", "type", "width" ] } }, "additionalProperties": false, "required": [ "active", "max_bitrate", "max_framerate", "max_resolution", "quality", "rid", "rtx_ssrc", "ssrc", "type" ] } } }, "additionalProperties": false, "required": [ "audio_ssrc", "video_ssrc" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "ApplicationCommandCreateSchema": { "type": "object", "properties": { "type": { "enum": [ 1, 2, 3, 4 ], "type": "number" }, "name": { "type": "string" }, "name_localizations": { "$ref": "#/definitions/Record" }, "description": { "type": "string" }, "description_localizations": { "$ref": "#/definitions/Record" }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } }, "default_member_permissions": { "type": "string" }, "dm_permission": { "type": "boolean" }, "nsfw": { "type": "boolean" }, "integration_types": { "type": "array", "items": { "$ref": "#/definitions/ApplicationIntegrationType" } }, "contexts": { "type": "array", "items": { "$ref": "#/definitions/InteractionContextType" } }, "handler": { "enum": [ 1, 2, 3 ], "type": "number" } }, "additionalProperties": false, "required": [ "name" ], "definitions": { "Record": { "type": "object", "additionalProperties": false }, "ApplicationCommandOption": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ApplicationCommandOptionType" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "choices": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOptionChoice" } }, "options": { "type": "array", "items": { "$ref": "#/definitions/ApplicationCommandOption" } } }, "additionalProperties": false, "required": [ "description", "name", "type" ] }, "ApplicationCommandOptionType": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ] }, "ApplicationCommandOptionChoice": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": [ "string", "integer" ] } }, "additionalProperties": false, "required": [ "name", "value" ] }, "ApplicationIntegrationType": { "type": "number", "enum": [ 0, 1 ] }, "InteractionContextType": { "type": "number", "enum": [ 0, 1, 2 ] } }, "$schema": "http://json-schema.org/draft-07/schema#" } }