Skip to content

Storage Classes

albert.resources.storage_classes

StorageCompatibilityMatrix

Bases: BaseAlbertModel

Co-storage compatibility for a single Storage Class.

Describes which other storage classes a given class may be stored alongside. Each entry identifies another storage class (by name or number).

Show JSON schema: 
{
  "description": "Co-storage compatibility for a single Storage Class.\n\nDescribes which other storage classes a given class may be stored alongside.\nEach entry identifies another storage class (by name or number).",
  "properties": {
    "Allowed": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Storage classes that may be safely co-stored with this class.",
      "title": "Allowed"
    },
    "NotAllowed": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Storage classes that must not be co-stored with this class.",
      "title": "Notallowed"
    },
    "Warnings": {
      "anyOf": [
        {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "description": "Storage classes that may be co-stored only with caution, keyed by the other class, with the list describing the applicable warnings.",
      "title": "Warnings"
    }
  },
  "title": "StorageCompatibilityMatrix",
  "type": "object"
}

Fields:

allowed 

allowed: list[str] | None

Storage classes that may be safely co-stored with this class.

not_allowed 

not_allowed: list[str] | None

Storage classes that must not be co-stored with this class.

warnings 

warnings: dict[str, list[str]] | None

Storage classes that may be co-stored only with caution, keyed by the other class, with the list describing the applicable warnings.

StorageClass

Bases: BaseAlbertModel

A hazardous-materials storage classification.

A Storage Class governs which materials may be safely stored together. Inventory Items carry a storage/security class that ties back to one of these classifications. Retrieved through StorageClassesCollection.

Show JSON schema: 
{
  "$defs": {
    "StorageCompatibilityMatrix": {
      "description": "Co-storage compatibility for a single Storage Class.\n\nDescribes which other storage classes a given class may be stored alongside.\nEach entry identifies another storage class (by name or number).",
      "properties": {
        "Allowed": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "description": "Storage classes that may be safely co-stored with this class.",
          "title": "Allowed"
        },
        "NotAllowed": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "description": "Storage classes that must not be co-stored with this class.",
          "title": "Notallowed"
        },
        "Warnings": {
          "anyOf": [
            {
              "additionalProperties": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "description": "Storage classes that may be co-stored only with caution, keyed by the other class, with the list describing the applicable warnings.",
          "title": "Warnings"
        }
      },
      "title": "StorageCompatibilityMatrix",
      "type": "object"
    }
  },
  "description": "A hazardous-materials storage classification.\n\nA Storage Class governs which materials may be safely stored together.\nInventory Items carry a storage/security class that ties back to one of these\nclassifications. Retrieved through\n[`StorageClassesCollection`][albert.collections.storage_classes.StorageClassesCollection].",
  "properties": {
    "storageClassName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The human-readable name of the storage class.",
      "title": "Storageclassname"
    },
    "storageClassNumber": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The identifying number/code of the storage class within its classification scheme.",
      "title": "Storageclassnumber"
    },
    "StorageCompatibility": {
      "anyOf": [
        {
          "$ref": "#/$defs/StorageCompatibilityMatrix"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The co-storage compatibility matrix for this class, listing which other classes it may, may not, or may with warnings be stored alongside."
    }
  },
  "title": "StorageClass",
  "type": "object"
}

Fields:

storage_class_name 

storage_class_name: str | None = None

The human-readable name of the storage class.

storage_class_number 

storage_class_number: str | None = None

The identifying number/code of the storage class within its classification scheme.

storage_compatibility 

storage_compatibility: StorageCompatibilityMatrix | None = (
    None
)

The co-storage compatibility matrix for this class, listing which other classes it may, may not, or may with warnings be stored alongside.