TagsResponseBody

pydantic model openapi_client.models.tags_response_body.TagsResponseBody

Response for GET /tags. Contains either a “tags” array (default mode) or a “tagKeys” array (when action=list_tag_keys). Only one of the two arrays is populated per request.

Fields:
field tags: Optional[List[TagsByNameResponseBody]] = None

List of tag objects the user has access to. Present when action is absent (default mode).

field tag_keys: Optional[List[TagsResponseBodyTagKeysInner]] = None (alias 'tagKeys')

List of unique tag keys. Present when action=list_tag_keys.

field next_available: Optional[StrictStr] = None

“yes” if more pages exist, “no” if this is the last page.

field count: Optional[StrictInt] = None

Number of items in the current page.

field total_count: Optional[StrictInt] = None

Total number of items after filtering, before pagination.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of TagsResponseBody from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of TagsResponseBody from a dict

Return type:

Optional[Self]