ApiResponseMetadata#

class ApiResponseMetadata(flags=None, links=None, total_available_results=None, messages=None, extra_info=None, *args, **kwargs)[source]#

Bases: object

The metadata associated with an API response. Always present and minimally contains the self link for the API request that produced this response. Also contains pagination data for paginated requests.

Parameters:

flags – (flags)
links – (links)
total_available_results – (total_available_results)
messages – (messages)
extra_info – (extra_info) An array of entity specific metadata

property extra_info#

An array of entity specific metadata

Type:: list[ KVPair ]

property flags#

Type:: list[ Flag ]

property links#

Type:: list[ ApiLink ]

property messages#

Type:: list[ Message ]

to_dict()[source]#: Returns the model properties as a dictionary

to_str()[source]#: Returns the string representation of the model

property total_available_results#

Type:: int