Skip to content

Responses

immichpy.client.generated.api_response.ApiResponse pydantic-model

Bases: BaseModel, Generic[T]

API response object

Show JSON schema: 
{
  "description": "API response object",
  "properties": {
    "status_code": {
      "description": "HTTP status code",
      "title": "Status Code",
      "type": "integer"
    },
    "headers": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "HTTP headers",
      "title": "Headers"
    },
    "data": {
      "description": "Deserialized data given the data type",
      "title": "Data"
    },
    "raw_data": {
      "description": "Raw data (HTTP response body)",
      "format": "binary",
      "title": "Raw Data",
      "type": "string"
    }
  },
  "required": [
    "status_code",
    "data",
    "raw_data"
  ],
  "title": "ApiResponse",
  "type": "object"
}

Config:

  • default: {'arbitrary_types_allowed': True}

Fields:

data pydantic-field 

data: T

Deserialized data given the data type

headers pydantic-field 

headers: Optional[Mapping[str, str]] = None

HTTP headers

raw_data pydantic-field 

raw_data: StrictBytes

Raw data (HTTP response body)

status_code pydantic-field 

status_code: StrictInt

HTTP status code

immichpy.client.generated.rest.RESTResponseType module-attribute 

RESTResponseType = ClientResponse

This is a type alias for aiohttp.ClientResponse.