# uk.ewancroft.support.github

> Published by [ewancroft.uk](https://lexicon.garden/identity/did:plc:ofrbh253gwicbkc5nktqepol)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ofrbh253gwicbkc5nktqepol/uk.ewancroft.support.github)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ofrbh253gwicbkc5nktqepol/uk.ewancroft.support.github/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ofrbh253gwicbkc5nktqepol/uk.ewancroft.support.github/examples)

## Definitions

### `uk.ewancroft.support.github`

**Type**: `record`

A single GitHub Sponsors event. One record per event, rkey is a TID.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | No | Display name of the sponsor, if known. |
| `login` | `string` | Yes | GitHub username of the sponsor. |
| `action` | `string` | Yes | Sponsorship action: created, cancelled, edited, tier_changed, pending_cancellation, or pending_tier_change. |
| `tierName` | `string` | Yes | Name of the sponsorship tier at the time of this event. |
| `monthlyUsd` | `integer` | Yes | Monthly sponsorship amount in USD at the time of this event. |

## Raw Schema

```json
{
  "id": "uk.ewancroft.support.github",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "login",
          "action",
          "tierName",
          "monthlyUsd"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Display name of the sponsor, if known."
          },
          "login": {
            "type": "string",
            "description": "GitHub username of the sponsor."
          },
          "action": {
            "type": "string",
            "description": "Sponsorship action: created, cancelled, edited, tier_changed, pending_cancellation, or pending_tier_change."
          },
          "tierName": {
            "type": "string",
            "description": "Name of the sponsorship tier at the time of this event."
          },
          "monthlyUsd": {
            "type": "integer",
            "description": "Monthly sponsorship amount in USD at the time of this event."
          }
        }
      },
      "description": "A single GitHub Sponsors event. One record per event, rkey is a TID."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```