com.atproto.admin.get_invite_codes

pydantic model atproto.xrpc_client.models.com.atproto.admin.get_invite_codes.Params

Bases: ParamsModelBase

Parameters model for com.atproto.admin.getInviteCodes.

Show JSON schema

{
   "title": "Params",
   "description": "Parameters model for :obj:`com.atproto.admin.getInviteCodes`.",
   "type": "object",
   "properties": {
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 500,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 100,
         "title": "Limit"
      },
      "sort": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Sort"
      }
   },
   "additionalProperties": false
}

Fields:

• cursor (Optional[str])

• limit (Optional[int])

• sort (Optional[str])

field cursor: Optional[str] = None

Cursor.

field limit: Optional[int] = 100

Limit.

Constraints:

• ge = 1

• le = 500

field sort: Optional[str] = None

Sort.

class atproto.xrpc_client.models.com.atproto.admin.get_invite_codes.ParamsDict

Bases: TypedDict

cursor: typing_extensions.NotRequired[Optional[str]]

Cursor.

limit: typing_extensions.NotRequired[Optional[int]]

Limit.

sort: typing_extensions.NotRequired[Optional[str]]

Sort.

pydantic model atproto.xrpc_client.models.com.atproto.admin.get_invite_codes.Response

Bases: ResponseModelBase

Output data model for com.atproto.admin.getInviteCodes.

Show JSON schema

{
   "title": "Response",
   "description": "Output data model for :obj:`com.atproto.admin.getInviteCodes`.",
   "type": "object",
   "properties": {
      "codes": {
         "items": {
            "$ref": "#/$defs/InviteCode"
         },
         "title": "Codes",
         "type": "array"
      },
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      }
   },
   "$defs": {
      "InviteCode": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.server.defs`.",
         "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"
            }
         },
         "required": [
            "available",
            "code",
            "createdAt",
            "createdBy",
            "disabled",
            "forAccount",
            "uses"
         ],
         "title": "InviteCode",
         "type": "object"
      },
      "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": [
      "codes"
   ]
}

Fields:

• codes (List[models.ComAtprotoServerDefs.InviteCode])

• cursor (Optional[str])

field codes: List[models.ComAtprotoServerDefs.InviteCode] [Required]

Codes.

field cursor: Optional[str] = None

Cursor.