1059 lines
38 KiB
JSON
1059 lines
38 KiB
JSON
{
|
|
"version": "1.0",
|
|
"errors": [
|
|
{
|
|
"id": "a11757c4",
|
|
"name": "AlreadyAuthenticated",
|
|
"description": "The client is attempting to authenticate when already authenticated",
|
|
"error_code": 8713
|
|
},
|
|
{
|
|
"id": "1458e573",
|
|
"name": "AuthenticationFailure",
|
|
"description": "The authentication process failed for some unexpected reason, see the message for further details",
|
|
"error_code": 8710
|
|
},
|
|
{
|
|
"id": "e81059bf",
|
|
"name": "AuthenticationNotApplicable",
|
|
"description": "Raised when the user does not support this method of authentication, see the message for further details",
|
|
"error_code": 8706
|
|
},
|
|
{
|
|
"id": "9f37b285",
|
|
"name": "BadSessionChallengeAnswer",
|
|
"description": "The given session challenge answer is incorrect or out of sync",
|
|
"error_code": 8711
|
|
},
|
|
{
|
|
"id": "5e1c10ae",
|
|
"name": "IncorrectLoginCredentials",
|
|
"description": "The given login credentials are incorrect",
|
|
"error_code": 8704
|
|
},
|
|
{
|
|
"id": "2e9060cf",
|
|
"name": "IncorrectTwoFactorAuthenticationCode",
|
|
"description": "The given two-factor authentication code is incorrect",
|
|
"error_code": 8705
|
|
},
|
|
{
|
|
"id": "02868471",
|
|
"name": "NotAuthenticated",
|
|
"description": "Raised when the client attempts to invoke a method that requires authentication",
|
|
"error_code": 8708
|
|
},
|
|
{
|
|
"id": "a9634560",
|
|
"name": "PrivateAccessTokenRequired",
|
|
"description": "Raised when the user/entity uses a Private Access Token to authenticate and the client attempted to authenticate in another way",
|
|
"error_code": 8709
|
|
},
|
|
{
|
|
"id": "d8f9191f",
|
|
"name": "SessionExpired",
|
|
"description": "Raised when trying to use a session that has expired",
|
|
"error_code": 8714
|
|
},
|
|
{
|
|
"id": "c4dd3574",
|
|
"name": "TwoFactorAuthenticationRequired",
|
|
"description": "Two-Factor Authentication is required, the client must repeat the same request but provide a Two-Factor authentication code as well",
|
|
"error_code": 8712
|
|
},
|
|
{
|
|
"id": "ffed1d8d",
|
|
"name": "AccessDenied",
|
|
"description": "The authenticated peer does not have sufficient permissions to access the requested resource or to invoke a restricted method",
|
|
"error_code": 12550
|
|
},
|
|
{
|
|
"id": "cca04d0c",
|
|
"name": "AlreadyReposted",
|
|
"description": "Raised when the client attempts to repost a post that has already been reposted",
|
|
"error_code": 12547
|
|
},
|
|
{
|
|
"id": "c78cf37b",
|
|
"name": "BlockedByPeer",
|
|
"description": "Raised when attempting to interact with a peer that blocked you",
|
|
"error_code": 12551
|
|
},
|
|
{
|
|
"id": "b518774e",
|
|
"name": "BlockedPeer",
|
|
"description": "Raised when attempting to interact with a peer that you blocked",
|
|
"error_code": 12552
|
|
},
|
|
{
|
|
"id": "aadafa63",
|
|
"name": "DocumentNotFound",
|
|
"description": "The requested Document ID was not found on the server",
|
|
"error_code": 12549
|
|
},
|
|
{
|
|
"id": "9c8e7563",
|
|
"name": "FileUploadError",
|
|
"description": "Raised when there was an error while trying to upload one or more files to the network",
|
|
"error_code": 12548
|
|
},
|
|
{
|
|
"id": "8faa072e",
|
|
"name": "PeerNotFound",
|
|
"description": "The requested user entity was not found in the network",
|
|
"error_code": 12544
|
|
},
|
|
{
|
|
"id": "9f19935e",
|
|
"name": "PostDeleted",
|
|
"description": "Raised when the client requested a post that was deleted",
|
|
"error_code": 12546
|
|
},
|
|
{
|
|
"id": "7a69136f",
|
|
"name": "PostNotFound",
|
|
"description": "Raised when the client requested a post that isn't found",
|
|
"error_code": 12545
|
|
},
|
|
{
|
|
"id": "10dee597",
|
|
"name": "SelfInteractionNotPermitted",
|
|
"description": "Raised when attempting to invoke a method or change that involves a peer that you are authenticated as such as following a peer that you are authenticated as",
|
|
"error_code": 12553
|
|
},
|
|
{
|
|
"id": "9d02379e",
|
|
"name": "DocumentUpload",
|
|
"description": "Raised when there was an error while trying to process the document upload",
|
|
"error_code": 16385
|
|
},
|
|
{
|
|
"id": "4c9bdb87",
|
|
"name": "InternalServerError",
|
|
"description": "Raised when there was an unexpected error while trying to process your request.",
|
|
"error_code": 16384
|
|
},
|
|
{
|
|
"id": "f1ce4792",
|
|
"name": "AgreementRequired",
|
|
"description": "The client/user must agree to the condition to invoke the method",
|
|
"error_code": 8465
|
|
},
|
|
{
|
|
"id": "f95f5f97",
|
|
"name": "FileTooLarge",
|
|
"description": "The given file is too large to be processed",
|
|
"error_code": 8463
|
|
},
|
|
{
|
|
"id": "8f15d1dd",
|
|
"name": "InvalidAttachments",
|
|
"description": "Raised when the given attachments are invalid",
|
|
"error_code": 8470
|
|
},
|
|
{
|
|
"id": "ef2dd55d",
|
|
"name": "InvalidBiography",
|
|
"description": "The Biography is too long or contains invalid characters, see the message for further details",
|
|
"error_code": 8452
|
|
},
|
|
{
|
|
"id": "d22f8f4d",
|
|
"name": "InvalidClientName",
|
|
"description": "The client name contains invalid characters or is too long, see the message for further details",
|
|
"error_code": 8460
|
|
},
|
|
{
|
|
"id": "8980306d",
|
|
"name": "InvalidClientPrivateHash",
|
|
"description": "The client's private hash is invalid and cannot be identified as a sha256",
|
|
"error_code": 8457
|
|
},
|
|
{
|
|
"id": "6207f5b7",
|
|
"name": "InvalidClientPublicHash",
|
|
"description": "The client's public hash is invalid and cannot be identified as a sha256",
|
|
"error_code": 8456
|
|
},
|
|
{
|
|
"id": "8ce0e2a7",
|
|
"name": "InvalidFileForProfilePicture",
|
|
"description": "The given file is invalid for a profile picture",
|
|
"error_code": 8462
|
|
},
|
|
{
|
|
"id": "1209e4fc",
|
|
"name": "InvalidFileName",
|
|
"description": "Raised when the given filename is invalid",
|
|
"error_code": 8471
|
|
},
|
|
{
|
|
"id": "8611fbfa",
|
|
"name": "InvalidGeoLocation",
|
|
"description": "The given geo location value is invalid or too long",
|
|
"error_code": 8467
|
|
},
|
|
{
|
|
"id": "ea3e3974",
|
|
"name": "InvalidHelpDocumentId",
|
|
"description": "The given Help Document ID is invalid",
|
|
"error_code": 8464
|
|
},
|
|
{
|
|
"id": "de95bed6",
|
|
"name": "InvalidLastName",
|
|
"description": "The Last Name provided contains invalid characters and or is too long, see the message for further details",
|
|
"error_code": 8451
|
|
},
|
|
{
|
|
"id": "0f5d11ea",
|
|
"name": "InvalidPageValue",
|
|
"description": "The page parameter contains an invalid value. It cannot be a negative value or 0, see the message for further details",
|
|
"error_code": 8466
|
|
},
|
|
{
|
|
"id": "7fab61d5",
|
|
"name": "InvalidPassword",
|
|
"description": "The given password is insecure, see the message for further details",
|
|
"error_code": 8449
|
|
},
|
|
{
|
|
"id": "468b8e27",
|
|
"name": "InvalidPeerInput",
|
|
"description": "The client provided an invalid peer identification as input",
|
|
"error_code": 8454
|
|
},
|
|
{
|
|
"id": "54854690",
|
|
"name": "InvalidPlatform",
|
|
"description": "The platform name contains invalid characters or is too long, see the message for further details",
|
|
"error_code": 8458
|
|
},
|
|
{
|
|
"id": "f1351689",
|
|
"name": "InvalidPostText",
|
|
"description": "The post contains invalid characters or is too long, see the message for further details",
|
|
"error_code": 8455
|
|
},
|
|
{
|
|
"id": "0eefbfa9",
|
|
"name": "InvalidSessionIdentification",
|
|
"description": "The session identification object is invalid, see the message for further details",
|
|
"error_code": 8461
|
|
},
|
|
{
|
|
"id": "ad680e22",
|
|
"name": "InvalidUrlValue",
|
|
"description": "The given URL input is invalid",
|
|
"error_code": 8468
|
|
},
|
|
{
|
|
"id": "751ca3d3",
|
|
"name": "InvalidUsername",
|
|
"description": "The given username is invalid and does not meet the specification",
|
|
"error_code": 8448
|
|
},
|
|
{
|
|
"id": "b4fa64b8",
|
|
"name": "InvalidVersion",
|
|
"description": "The version is invalid or is too long, see the message for further details",
|
|
"error_code": 8459
|
|
},
|
|
{
|
|
"id": "68181c93",
|
|
"name": "TooManyAttachments",
|
|
"description": "Raised when the amount of attachments exceeds what the server supports",
|
|
"error_code": 8469
|
|
},
|
|
{
|
|
"id": "a890f5d6",
|
|
"name": "UsernameAlreadyExists",
|
|
"description": "The username is already registered in the network and cannot be used",
|
|
"error_code": 8453
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"id": "8245989e",
|
|
"name": "DisplayPictureSize",
|
|
"description": "This object describes the size of a display picture followed by a document object that results in said display picture size.",
|
|
"parameters": [
|
|
{
|
|
"name": "width",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The width of the image"
|
|
},
|
|
{
|
|
"name": "height",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The height of the image"
|
|
},
|
|
{
|
|
"name": "document",
|
|
"types": [{ "type": "Document", "vector": false }],
|
|
"required": true,
|
|
"description": "The document object that points to the display picture"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "54bd4374",
|
|
"name": "Document",
|
|
"description": "A document object contains basic information about the file associated with the document and the document ID used to retrieve the document from the CDN Server",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the document"
|
|
},
|
|
{
|
|
"name": "file_mime",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The Mime of the file"
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The original name of the file"
|
|
},
|
|
{
|
|
"name": "file_size",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The size of the file in bytes"
|
|
},
|
|
{
|
|
"name": "file_type",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The type of file detected by the server"
|
|
},
|
|
{
|
|
"name": "flags",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of flags associated with this document"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "c92c1e11",
|
|
"name": "ErrorDefinition",
|
|
"description": "The object ErrorDefinition contains information about an error that the server is capable of returning if a method fails to execute.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the ErrorDefinition, which is a crc32 hash of the following value; <ProtocolVersion>:<ErrorName>:<ErrorCode> (1.0:InternalServerError:16384)"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The name of the error, this is a unique value."
|
|
},
|
|
{
|
|
"name": "description",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "A description of the error"
|
|
},
|
|
{
|
|
"name": "error_code",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The error code, this is a unique value."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "4182559c",
|
|
"name": "HelpDocument",
|
|
"description": "A help document is often retrieved from the server as a way to represent a document to the user for multiple purposes, from quick guides to server announcements or the legal documents required to be shown to the user before they register an account to the network.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the document, if the document gets updated then the ID will change"
|
|
},
|
|
{
|
|
"name": "text",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The text contents of the document"
|
|
},
|
|
{
|
|
"name": "entities",
|
|
"types": [{ "type": "TextEntity", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of text entities being represented in the text"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "defe580e",
|
|
"name": "MethodDefinition",
|
|
"description": "The object MethodDefinition contains information about method, namespace, permission requirements and the parameters it accepts",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "A crc32 hash of the methods's ID following the value; <ProtocolVersion>:<MethodName> eg; 1.0:timelime.compose"
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The namespace of the method e.g., timeline, network, etc."
|
|
},
|
|
{
|
|
"name": "method_name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The name of the method without the namespace compose, like, repost, etc."
|
|
},
|
|
{
|
|
"name": "method",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The full name of the method with the leading namespace e.g. timeline.compose, timeline.like"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The description of the method"
|
|
},
|
|
{
|
|
"name": "permission_requirements",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "The array of permission requirements for this method"
|
|
},
|
|
{
|
|
"name": "return_types",
|
|
"types": [{ "type": "TypeDefinition", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of possible return types"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "91eed71b",
|
|
"name": "ObjectDefinition",
|
|
"description": "The object ObjectDefinition explains the structure of a object that the server could return or work with.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "A crc32 hash of the object's ID following the value; <ProtocolVersion>:<ObjectName> eg; 1.0:Peer"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The name of the object"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "A description of the object"
|
|
},
|
|
{
|
|
"name": "parameters",
|
|
"types": [{ "type": "ParameterDefinition", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of ParameterDefinitions explaining the object structure"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "5ffe4dc4",
|
|
"name": "ParameterDefinition",
|
|
"description": "The object ParameterDefinition contains information about the parameters used and or available, usually represented within an array; this object indicates the availabe types, name, description and requirement of the parameter. This can be applied to object property structures or method parameters",
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The name of the parameter"
|
|
},
|
|
{
|
|
"name": "types",
|
|
"types": [{ "type": "TypeDefinition", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of types that are used for this parameter"
|
|
},
|
|
{
|
|
"name": "required",
|
|
"types": [{ "type": "boolean", "vector": false }],
|
|
"required": true,
|
|
"description": "Indicates if this parameter is required or not, for objects this will always be true."
|
|
},
|
|
{
|
|
"name": "description",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The description of the parameter"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "1483f7dc",
|
|
"name": "Peer",
|
|
"description": "A peer object provides a basic description and identification a peer entity that can contain information used to identify a peer on the client or basic flags and properties of the peer to pre-determine what actions are available for a peer.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the document, if the document gets updated then the ID will change"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The type of the peer entity"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The display name of the peer"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The username associated with this peer"
|
|
},
|
|
{
|
|
"name": "flags",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "Flags associated with this peer"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "25d7823e",
|
|
"name": "Post",
|
|
"description": "A post object is used to represent a post submitted either by a peer, this object can contain recursive objects.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The unique ID for the post"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The post type used to represent the true intention of the post"
|
|
},
|
|
{
|
|
"name": "peer",
|
|
"types": [
|
|
{ "type": "Peer", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The author peer of the post, this property can be null if the post was deleted."
|
|
},
|
|
{
|
|
"name": "source",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The source for where this post was composed from or collected from (eg; the client the user is using or the third-party source that the post was collected. This is determined by the server). This property can be null if the post was deleted."
|
|
},
|
|
{
|
|
"name": "text",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The text content of the post source. This property can be null if the post has been deleted"
|
|
},
|
|
{
|
|
"name": "attachments",
|
|
"types": [{ "type": "Document", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of attached documents to the post"
|
|
},
|
|
{
|
|
"name": "entities",
|
|
"types": [{ "type": "TextEntity", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of entities extracted from the text, can be used by the client to highlight clickable entities that preforms an action."
|
|
},
|
|
{
|
|
"name": "mentioned_peers",
|
|
"types": [{ "type": "Peer", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of resolved peers that was mentioned in the post text."
|
|
},
|
|
{
|
|
"name": "reply_to_post",
|
|
"types": [
|
|
{ "type": "Post", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The original post that this post is replying to if applicable, otherwise null."
|
|
},
|
|
{
|
|
"name": "quoted_post",
|
|
"types": [
|
|
{ "type": "Post", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The original post that this post is quoting if applicable, otherwise null"
|
|
},
|
|
{
|
|
"name": "reposted_post",
|
|
"types": [
|
|
{ "type": "Post", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The original post that this post is reposting if applicable, otherwise null"
|
|
},
|
|
{
|
|
"name": "original_thread_post",
|
|
"types": [
|
|
{ "type": "Post", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The original thread post, only applicable to replies. This value indicates the main thread post where all the replies originated from. This value will remain the same for all sub-replies of the main post."
|
|
},
|
|
{
|
|
"name": "like_count",
|
|
"types": [
|
|
{ "type": "integer", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The amount of likes that this post has if applicable, otherwise null"
|
|
},
|
|
{
|
|
"name": "repost_count",
|
|
"types": [
|
|
{ "type": "integer", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The amount of repost that this post has if applicable, otherwise null"
|
|
},
|
|
{
|
|
"name": "quote_count",
|
|
"types": [
|
|
{ "type": "integer", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The amount of quoted posts that this post has if applicable, otherwise null"
|
|
},
|
|
{
|
|
"name": "reply_count",
|
|
"types": [
|
|
{ "type": "integer", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The amount of replies that this post has if applicable, otherwise null"
|
|
},
|
|
{
|
|
"name": "posted_timestamp",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The Unix Timestamp for when this post was created"
|
|
},
|
|
{
|
|
"name": "flags",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "The flags associated with this post"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "50f2328a",
|
|
"name": "Profile",
|
|
"description": "The profile object provides a profile display for a peer entity, this is mainly used to represent a \"Profile\" display of a peer.",
|
|
"parameters": [
|
|
{
|
|
"name": "first_name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The first name of the entity"
|
|
},
|
|
{
|
|
"name": "last_name",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The last name of the entity"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The full display name of the entity"
|
|
},
|
|
{
|
|
"name": "biography",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "A biography or description of the entity"
|
|
},
|
|
{
|
|
"name": "location",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The location of the entity"
|
|
},
|
|
{
|
|
"name": "url",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The URL of the entity (Can be a website or a blog, etc)"
|
|
},
|
|
{
|
|
"name": "followers_count",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The amount of followers that this entity has"
|
|
},
|
|
{
|
|
"name": "following_count",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The amount of peers that this entity is following"
|
|
},
|
|
{
|
|
"name": "display_picture_sizes",
|
|
"types": [{ "type": "DisplayPictureSize", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of display picture size objects that represents the entity's display picture"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "2b598a3b",
|
|
"name": "ProtocolDefinitions",
|
|
"description": "The ProtocolDefinitions object contains object definitions of what the server's version of the protocol has defined and what their use cases are. Much like a documentation representation in a object structure that can be understood by clients which allows for constructors during runtime.",
|
|
"parameters": [
|
|
{
|
|
"name": "version",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The version of the protocol being used by the server, eg; 1.0"
|
|
},
|
|
{
|
|
"name": "errors",
|
|
"types": [{ "type": "ErrorDefinition", "vector": true }],
|
|
"required": true,
|
|
"description": "A list of error definitions defined by the server and protocol with their respective error codes and descriptions"
|
|
},
|
|
{
|
|
"name": "objects",
|
|
"types": [{ "type": "ObjectDefinition", "vector": true }],
|
|
"required": true,
|
|
"description": "A list of object definitions defined by the server and protocol with their respective descriptions, names and parameters."
|
|
},
|
|
{
|
|
"name": "methods",
|
|
"types": [{ "type": "MethodDefinition", "vector": true }],
|
|
"required": true,
|
|
"description": "A list of method definitions defined by the server and protocol with their respective descriptions, names and parameters."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "456ff4c6",
|
|
"name": "ServerInformation",
|
|
"description": "The ServerInformation object is a simple object that gives details about the server's attributes and limits or location of other servers that the client should communicate to for other purposes such as a CDN.",
|
|
"parameters": [
|
|
{
|
|
"name": "network_name",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The name of the network, eg; \"Socialvoid\""
|
|
},
|
|
{
|
|
"name": "protocol_version",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The version of the protocol standard that the server is using, eg; \"1.0\""
|
|
},
|
|
{
|
|
"name": "cdn_server",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The HTTP URL Endpoint for the CDN server of the network"
|
|
},
|
|
{
|
|
"name": "upload_max_file_size",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum size of a file that you can upload to the CDN Server (in bytes)"
|
|
},
|
|
{
|
|
"name": "unauthorized_session_ttl",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum time-to-live (in seconds) that an unauthorized session may have. The server will often reset the expiration whenever the session is used."
|
|
},
|
|
{
|
|
"name": "authorized_session_ttl",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum time-to-live (in seconds) that an authorized session may have. The server will often reset the expiration whenever the session is used."
|
|
},
|
|
{
|
|
"name": "retrieve_likes_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum amount of likes a client can retrieve at once using the method timeline.get_likes via the page parameter"
|
|
},
|
|
{
|
|
"name": "retrieve_reposts_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum amount of reposts a client can retrieve at once using the method timeline.get_reposted_peers via the page parameter"
|
|
},
|
|
{
|
|
"name": "retrieve_replies_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum amount of replies a client can retrieve at once using the method timeline.get_replies via the page parameter"
|
|
},
|
|
{
|
|
"name": "retrieve_quotes_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum amount of quotes a client can retrieve at once using the method timeline.get_quotes via the page parameter"
|
|
},
|
|
{
|
|
"name": "retrieve_followers_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum amount of followers a client can retrieve at once using the method network.get_followers via the page parameter"
|
|
},
|
|
{
|
|
"name": "retrieve_following_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The maximum amount of following peers a client can retrieve at once using the method network.get_following via the page parameter"
|
|
},
|
|
{
|
|
"name": "retrieve_feed_max_limit",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The amount of posts a client can retrieve at once using the method timeline.retrieve_feed via the page parameter"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "1647b140",
|
|
"name": "Session",
|
|
"description": "A session object is contains basic information about the session.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the session obtained when establishing a session"
|
|
},
|
|
{
|
|
"name": "flags",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of flags that has been set to this session"
|
|
},
|
|
{
|
|
"name": "permissions",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "An array of permission sets that has been set to this session"
|
|
},
|
|
{
|
|
"name": "authenticated",
|
|
"types": [{ "type": "boolean", "vector": false }],
|
|
"required": true,
|
|
"description": "Indicates if the session is currently authenticated to a user"
|
|
},
|
|
{
|
|
"name": "created",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The Unix Timestamp for when this session was first created"
|
|
},
|
|
{
|
|
"name": "expires",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The Unix Timestamp for when this session expires"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "14907b74",
|
|
"name": "SessionEstablished",
|
|
"description": "A SessionEstablished object is returned when you create a session. This object returns basic information about the session that the server has created for you.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the session obtained when establishing a session"
|
|
},
|
|
{
|
|
"name": "challenge",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "The TOTP based challenge secret"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "63843382",
|
|
"name": "SessionIdentification",
|
|
"description": "A SessionIdentification object allows your client to identify the session it's using and prove that it is the owner of the session, it proves as a identification effort and security effort.",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The ID of the session obtained when establishing a session"
|
|
},
|
|
{
|
|
"name": "challenge",
|
|
"types": [{ "type": "string", "vector": true }],
|
|
"required": true,
|
|
"description": "The TOTP based challenge secret"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "d39428ae",
|
|
"name": "TextEntity",
|
|
"description": "The text entity object describes the text type, this is useful for clients to render the given text correctly. For example a \"@mention\" will have a TextEntity with the value mention. So that the client can perform an action when this entity is clicked.",
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The text entity type"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The offset for when the entity begins in the text"
|
|
},
|
|
{
|
|
"name": "length",
|
|
"types": [{ "type": "integer", "vector": false }],
|
|
"required": true,
|
|
"description": "The length of the entity"
|
|
},
|
|
{
|
|
"name": "value",
|
|
"types": [
|
|
{ "type": "string", "vector": false },
|
|
{ "type": "null", "vector": false }
|
|
],
|
|
"required": true,
|
|
"description": "The value of the entity, for styling entities such as BOLD, ITALIC, etc. this value will be null, but for values such as MENTION, HASHTAG & URL the value will contain the respective value for the entity, for example a URL entity will contain a value of a http URL"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "14789bf7",
|
|
"name": "TypeDefinition",
|
|
"description": "The object TypeDefinition contains information about the defined type, the vector property can indicate if the type is being represented is a vector (list/array) and should be iterated",
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"types": [{ "type": "string", "vector": false }],
|
|
"required": true,
|
|
"description": "The type of the value, can either be a builtin type or one of the pre-defined object being represented as a string, eg; string, Peer, null"
|
|
},
|
|
{
|
|
"name": "vector",
|
|
"types": [{ "type": "boolean", "vector": false }],
|
|
"required": true,
|
|
"description": "An array of types that are used for this parameterIndicates if the type is represented as a vector or not (List/Array)"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"methods": [
|
|
{
|
|
"id": "a3cbf337",
|
|
"namespace": "account",
|
|
"method_name": "clear_profile_biography",
|
|
"method": "clear_profile_biography",
|
|
"description": "Clears the biography set to the user profile",
|
|
"permission_requirements": ["USER", "PROXY", "BOT"],
|
|
"parameters": [
|
|
{
|
|
"name": "session_identification",
|
|
"types": [{ "type": "SessionIdentification", "vector": false }],
|
|
"required": true,
|
|
"description": null
|
|
}
|
|
],
|
|
"possible_error_codes": [8711, 16384, 8456, 8461, 8708, 8714, 8714],
|
|
"return_types": [{ "type": "boolean", "vector": false }]
|
|
},
|
|
{
|
|
"id": "56e78bd0",
|
|
"namespace": "account",
|
|
"method_name": "clear_profile_location",
|
|
"method": "clear_profile_location",
|
|
"description": "Clears the users profile location",
|
|
"permission_requirements": ["USER", "PROXY", "BOT"],
|
|
"parameters": [
|
|
{
|
|
"name": "session_identification",
|
|
"types": [{ "type": "SessionIdentification", "vector": false }],
|
|
"required": true,
|
|
"description": null
|
|
}
|
|
],
|
|
"possible_error_codes": [8711, 16384, 8456, 8461, 8708, 8714, 8714],
|
|
"return_types": [{ "type": "boolean", "vector": false }]
|
|
}
|
|
]
|
|
}
|