com.atproto.server.create_invite_codes

pydantic model atproto.xrpc_client.models.com.atproto.server.create_invite_codes.AccountCodes

Bases: ModelBase

Definition model for com.atproto.server.createInviteCodes.

Show JSON schema

{
   "title": "AccountCodes",
   "description": "Definition model for :obj:`com.atproto.server.createInviteCodes`.",
   "type": "object",
   "properties": {
      "account": {
         "title": "Account",
         "type": "string"
      },
      "codes": {
         "items": {
            "type": "string"
         },
         "title": "Codes",
         "type": "array"
      },
      "$type": {
         "const": "com.atproto.server.createInviteCodes#accountCodes",
         "default": "com.atproto.server.createInviteCodes#accountCodes",
         "title": "$Type"
      }
   },
   "additionalProperties": false,
   "required": [
      "account",
      "codes"
   ]
}

Fields:

• account (str)

• codes (List[str])

• py_type (typing_extensions.Literal[com.atproto.server.createInviteCodes#accountCodes])

field account: str [Required]

Account.

field codes: List[str] [Required]

Codes.

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

pydantic model atproto.xrpc_client.models.com.atproto.server.create_invite_codes.Data

Bases: DataModelBase

Input data model for com.atproto.server.createInviteCodes.

Show JSON schema

{
   "title": "Data",
   "description": "Input data model for :obj:`com.atproto.server.createInviteCodes`.",
   "type": "object",
   "properties": {
      "codeCount": {
         "default": 1,
         "title": "Codecount",
         "type": "integer"
      },
      "useCount": {
         "title": "Usecount",
         "type": "integer"
      },
      "forAccounts": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Foraccounts"
      }
   },
   "additionalProperties": false,
   "required": [
      "useCount"
   ]
}

Fields:

• code_count (int)

• for_accounts (Optional[List[str]])

• use_count (int)

field code_count: int = 1 (alias 'codeCount')

Code count.

field for_accounts: Optional[List[str]] = None (alias 'forAccounts')

For accounts.

field use_count: int [Required] (alias 'useCount')

Use count.

class atproto.xrpc_client.models.com.atproto.server.create_invite_codes.DataDict

Bases: TypedDict

code_count: int

Code count.

for_accounts: typing_extensions.NotRequired[Optional[List[str]]]

For accounts.

use_count: int

Use count.

pydantic model atproto.xrpc_client.models.com.atproto.server.create_invite_codes.Response

Bases: ResponseModelBase

Output data model for com.atproto.server.createInviteCodes.

Show JSON schema

{
   "title": "Response",
   "description": "Output data model for :obj:`com.atproto.server.createInviteCodes`.",
   "type": "object",
   "properties": {
      "codes": {
         "items": {
            "$ref": "#/$defs/AccountCodes"
         },
         "title": "Codes",
         "type": "array"
      }
   },
   "$defs": {
      "AccountCodes": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.server.createInviteCodes`.",
         "properties": {
            "account": {
               "title": "Account",
               "type": "string"
            },
            "codes": {
               "items": {
                  "type": "string"
               },
               "title": "Codes",
               "type": "array"
            },
            "$type": {
               "const": "com.atproto.server.createInviteCodes#accountCodes",
               "default": "com.atproto.server.createInviteCodes#accountCodes",
               "title": "$Type"
            }
         },
         "required": [
            "account",
            "codes"
         ],
         "title": "AccountCodes",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "codes"
   ]
}

Fields:

• codes (List[models.ComAtprotoServerCreateInviteCodes.AccountCodes])

field codes: List[models.ComAtprotoServerCreateInviteCodes.AccountCodes] [Required]

Codes.