air_sdk.endpoints.marketplace_demo_tags

Stub file for marketplace demo tags endpoint type hints.

Classes

Name	Description
`MarketplaceDemoTag`	Marketplace demo tag model representing a tag for marketplace demos.
`MarketplaceDemoTagEndpointAPI`	API client for marketplace demo tag endpoints.

Module Contents

class air_sdk.endpoints.marketplace_demo_tags.MarketplaceDemoTag

Bases: air_sdk.air_model.AirModel

Marketplace demo tag model representing a tag for marketplace demos.

id: str

Unique identifier for the tag

name: str

Name of the tag

created: datetime.datetime

Timestamp when the tag was created

modified: datetime.datetime

Timestamp when the tag was last modified

get_model_api() -> type[MarketplaceDemoTagEndpointAPI]

model_api: MarketplaceDemoTagEndpointAPI

class air_sdk.endpoints.marketplace_demo_tags.MarketplaceDemoTagEndpointAPI

Bases: air_sdk.air_model.BaseEndpointAPI[air_sdk.endpoints.marketplace_demo_tags.MarketplaceDemoTag]

API client for marketplace demo tag endpoints.

API_PATH: str

model: type[MarketplaceDemoTag]

create(
    *,
    name: str
) -> MarketplaceDemoTag

Create a new marketplace demo tag.

Parameters:

name – Name for the new tag

Returns:

The created MarketplaceDemoTag instance

Example:

>>> tag = api.marketplace_demo_tags.create(name='networking')

list(
    *,
    limit: int | dataclasses._MISSING_TYPE = ...,
    offset: int | dataclasses._MISSING_TYPE = ...,
    search: str | dataclasses._MISSING_TYPE = ...,
    ordering: str | dataclasses._MISSING_TYPE = ...
) -> Iterator[MarketplaceDemoTag]

List all marketplace demo tags.

Optional parameters: limit: Number of results to return per page offset: The initial index from which to return the results search: Search term to filter tags ordering: Order the response by the specified field

Returns:

Iterator of MarketplaceDemoTag instances

Example:

>>> # List all tags
>>> for tag in api.marketplace_demo_tags.list():
...     print(tag.name)

get(pk: PrimaryKey) -> MarketplaceDemoTag

Get a specific marketplace demo tag by ID.

Parameters:

pk – The tag ID (string or UUID)

Returns:

The MarketplaceDemoTag instance

Example:

>>> tag = api.marketplace_demo_tags.get('tag-id')
>>> print(tag.name)

patch(
    pk: PrimaryKey,
    *,
    name: str | dataclasses._MISSING_TYPE = ...
) -> MarketplaceDemoTag

Update a marketplace demo tag.

Parameters:

pk – The tag ID (string or UUID)
name – New name for the tag

Returns:

The updated MarketplaceDemoTag instance

Example:

>>> tag = api.marketplace_demo_tags.patch('tag-id', name='new-name')

delete(pk: PrimaryKey) -> None

Delete a marketplace demo tag.

Parameters:

pk – The tag ID (string or UUID)

Example:

>>> api.marketplace_demo_tags.delete('tag-id')