air_sdk.endpoints.marketplace_demo_tags#
Stub file for marketplace demo tags endpoint type hints.
Classes#
Marketplace demo tag model representing a tag for marketplace demos. |
|
API client for marketplace demo tag endpoints. |
Module Contents#
- class air_sdk.endpoints.marketplace_demo_tags.MarketplaceDemoTag[source]#
Bases:
air_sdk.air_model.AirModelMarketplace demo tag model representing a tag for marketplace demos.
- id#
Unique identifier for the tag
- name#
Name of the tag
- created#
Timestamp when the tag was created
- modified#
Timestamp when the tag was last modified
- created: datetime.datetime#
- modified: datetime.datetime#
- classmethod get_model_api() → type[MarketplaceDemoTagEndpointAPI][source]#
Returns the respective AirModelAPI type for this model.
- property model_api: MarketplaceDemoTagEndpointAPI#
- class air_sdk.endpoints.marketplace_demo_tags.MarketplaceDemoTagEndpointAPI( )[source]#
Bases:
air_sdk.air_model.BaseEndpointAPI[MarketplaceDemoTag]API client for marketplace demo tag endpoints.
- 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 = ...,
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: air_sdk.air_model.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: air_sdk.air_model.PrimaryKey,
- *,
- name: str | dataclasses._MISSING_TYPE = ...,
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')