com.atproto.server.defs

pydantic model atproto.xrpc_client.models.com.atproto.server.defs.InviteCode

Bases: ModelBase

Definition model for com.atproto.server.defs.

Show JSON schema

{
   "title": "InviteCode",
   "description": "Definition model for :obj:`com.atproto.server.defs`.",
   "type": "object",
   "properties": {
      "available": {
         "title": "Available",
         "type": "integer"
      },
      "code": {
         "title": "Code",
         "type": "string"
      },
      "createdAt": {
         "title": "Createdat",
         "type": "string"
      },
      "createdBy": {
         "title": "Createdby",
         "type": "string"
      },
      "disabled": {
         "title": "Disabled",
         "type": "boolean"
      },
      "forAccount": {
         "title": "Foraccount",
         "type": "string"
      },
      "uses": {
         "items": {
            "$ref": "#/$defs/InviteCodeUse"
         },
         "title": "Uses",
         "type": "array"
      },
      "$type": {
         "const": "com.atproto.server.defs#inviteCode",
         "default": "com.atproto.server.defs#inviteCode",
         "title": "$Type"
      }
   },
   "$defs": {
      "InviteCodeUse": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.server.defs`.",
         "properties": {
            "usedAt": {
               "title": "Usedat",
               "type": "string"
            },
            "usedBy": {
               "title": "Usedby",
               "type": "string"
            },
            "$type": {
               "const": "com.atproto.server.defs#inviteCodeUse",
               "default": "com.atproto.server.defs#inviteCodeUse",
               "title": "$Type"
            }
         },
         "required": [
            "usedAt",
            "usedBy"
         ],
         "title": "InviteCodeUse",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "available",
      "code",
      "createdAt",
      "createdBy",
      "disabled",
      "forAccount",
      "uses"
   ]
}

Fields:

• available (int)

• code (str)

• created_at (str)

• created_by (str)

• disabled (bool)

• for_account (str)

• py_type (typing_extensions.Literal[com.atproto.server.defs#inviteCode])

• uses (List[models.ComAtprotoServerDefs.InviteCodeUse])

field available: int [Required]

Available.

field code: str [Required]

Code.

field created_at: str [Required] (alias 'createdAt')

Created at.

field created_by: str [Required] (alias 'createdBy')

Created by.

field disabled: bool [Required]

Disabled.

field for_account: str [Required] (alias 'forAccount')

For account.

field py_type: typing_extensions.Literal[com.atproto.server.defs#inviteCode] = 'com.atproto.server.defs#inviteCode' (alias '$type')

field uses: List[models.ComAtprotoServerDefs.InviteCodeUse] [Required]

Uses.

pydantic model atproto.xrpc_client.models.com.atproto.server.defs.InviteCodeUse

Bases: ModelBase

Definition model for com.atproto.server.defs.

Show JSON schema

{
   "title": "InviteCodeUse",
   "description": "Definition model for :obj:`com.atproto.server.defs`.",
   "type": "object",
   "properties": {
      "usedAt": {
         "title": "Usedat",
         "type": "string"
      },
      "usedBy": {
         "title": "Usedby",
         "type": "string"
      },
      "$type": {
         "const": "com.atproto.server.defs#inviteCodeUse",
         "default": "com.atproto.server.defs#inviteCodeUse",
         "title": "$Type"
      }
   },
   "additionalProperties": false,
   "required": [
      "usedAt",
      "usedBy"
   ]
}

Fields:

• py_type (typing_extensions.Literal[com.atproto.server.defs#inviteCodeUse])

• used_at (str)

• used_by (str)

field py_type: typing_extensions.Literal[com.atproto.server.defs#inviteCodeUse] = 'com.atproto.server.defs#inviteCodeUse' (alias '$type')

field used_at: str [Required] (alias 'usedAt')

Used at.

field used_by: str [Required] (alias 'usedBy')

Used by.