# systems.sister.gift

> Published by [vault.pds.sister.systems](https://lexicon.garden/identity/did:plc:e2gllbtzj3go3vaiimn4qmls)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:e2gllbtzj3go3vaiimn4qmls/systems.sister.gift)
- [Documentation](https://lexicon.garden/lexicon/did:plc:e2gllbtzj3go3vaiimn4qmls/systems.sister.gift/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:e2gllbtzj3go3vaiimn4qmls/systems.sister.gift/examples)

## Definitions

### `systems.sister.gift`

**Type**: `record`

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `to` | `string` | Yes |  |
| `from` | `string` | Yes |  |
| `itemCid` | `string` | No |  |
| `message` | `string` | No |  |
| `isReturn` | `boolean` | No |  |
| `itemRkey` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `returnedAt` | `string` (datetime) | No |  |
| `itemSnapshot` | `ref` → `#itemSnapshot` | Yes |  |
| `originalGiftUri` | `string` | No |  |

### `systems.sister.gift#stat`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `value` | `integer` | Yes |  |

### `systems.sister.gift#itemSnapshot`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `tags` | `array` | No |  |
| `stats` | `array` | No |  |
| `rarity` | `string` | Yes |  |
| `creator` | `string` | No |  |
| `itemType` | `string` | Yes |  |
| `tradable` | `boolean` | No |  |
| `description` | `string` | No |  |
| `lootboxRkey` | `string` | No |  |
| `levelRequirement` | `integer` | No |  |

## Raw Schema

```json
{
  "id": "systems.sister.gift",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "from",
          "to",
          "itemRkey",
          "itemSnapshot",
          "createdAt"
        ],
        "properties": {
          "to": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "from": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "itemCid": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "message": {
            "type": "string",
            "maxLength": 512
          },
          "isReturn": {
            "type": "boolean"
          },
          "itemRkey": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "returnedAt": {
            "type": "string",
            "format": "datetime"
          },
          "itemSnapshot": {
            "ref": "#itemSnapshot",
            "type": "ref"
          },
          "originalGiftUri": {
            "type": "string",
            "maxLength": 512,
            "minLength": 1
          }
        }
      }
    },
    "stat": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1
        },
        "value": {
          "type": "integer"
        }
      }
    },
    "itemSnapshot": {
      "type": "object",
      "required": [
        "name",
        "rarity",
        "itemType"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 128,
          "minLength": 1
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "maxLength": 50
        },
        "stats": {
          "type": "array",
          "items": {
            "ref": "#stat",
            "type": "ref"
          },
          "maxLength": 50
        },
        "rarity": {
          "enum": [
            "common",
            "uncommon",
            "rare",
            "epic",
            "legendary",
            "unusual"
          ],
          "type": "string"
        },
        "creator": {
          "type": "string",
          "maxLength": 256,
          "minLength": 1
        },
        "itemType": {
          "enum": [
            "weapon",
            "armor",
            "consumable",
            "cosmetic",
            "material",
            "misc",
            "crate",
            "table",
            "toolkit",
            "helperCrate",
            "shovel",
            "glasses"
          ],
          "type": "string"
        },
        "tradable": {
          "type": "boolean"
        },
        "description": {
          "type": "string",
          "maxLength": 4096
        },
        "lootboxRkey": {
          "type": "string",
          "maxLength": 256,
          "minLength": 1
        },
        "levelRequirement": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```