Teams

class cherryservers_sdk_python.teams.Team(client: C, model: T)[source]

Cherry Servers team resource.

This class represents an existing Cherry Servers resource and should only be initialized by TeamClient.

delete() → None[source]: Delete Cherry Servers team resource.

get_id() → int[source]: Get resource ID.

update(update_schema: UpdateRequest) → None[source]: Update Cherry Servers team resource.

class cherryservers_sdk_python.teams.RemainingTimeModel(*, time: int | None = None, unit: str | None = None)[source]

Cherry Servers team credit resource remaining time model.

This model is frozen by default, since it represents an actual Cherry Servers credit resource remaining time state. Here, resources refers to infrastructure objects that have a real cost.

time

Remaining time at the current usage rate and credit.

Type:: int | None

unit

Time unit type.

Type:: str | None

class cherryservers_sdk_python.teams.ResourcesModel(*, pricing: PricingModel | None = None, remaining: RemainingTimeModel | None = None)[source]

Cherry Servers team credit resource detail model.

This model is frozen by default, since it represents an actual Cherry Servers teams credit resources state. Here, resources refers to infrastructure objects that have a real cost.

pricing

Team resource pricing data.

Type:: cherryservers_sdk_python.plans.PricingModel | None

remaining

Team resource remaining time data.

Type:: cherryservers_sdk_python.teams.RemainingTimeModel | None

class cherryservers_sdk_python.teams.CreditDetailsModel(*, remaining: float | None = None, usage: float | None = None, currency: str | None = None)[source]

Cherry Servers team credit details model.

This model is frozen by default, since it represents an actual Cherry Servers team credit detail resource state.

remaining

Remaining credit.

Type:: float | None

usage

Credit usage rate.

Type:: float | None

currency

Credit currency.

Type:: str | None

class cherryservers_sdk_python.teams.CreditModel(*, account: CreditDetailsModel | None = None, promo: CreditDetailsModel | None = None, resources: ResourcesModel | None = None)[source]

Cherry Servers team credit model.

This model is frozen by default, since in represents an actual Cherry Servers team credit resource state.

account

Account credit details.

Type:: cherryservers_sdk_python.teams.CreditDetailsModel | None

promo

Promotional credit details.

Type:: cherryservers_sdk_python.teams.CreditDetailsModel | None

resources

Resources credit details.

Type:: cherryservers_sdk_python.teams.ResourcesModel | None

class cherryservers_sdk_python.teams.VatModel(*, amount: int | None = None, number: str | None = None, valid: bool | None = None)[source]

Cherry Servers team VAT model.

This model is frozen by default, since it represents an actual Cherry Servers team VAT resource state.

amount

VAT rate.

Type:: int | None

number

Amount of paid VAT.

Type:: str | None

valid

Whether VAT has been applied.

Type:: bool | None

Cherry Servers team billing model.

This model is frozen by default, since it represents an actual Cherry Servers team billing resource state.

type

Billing type: personal or business.

Type:: str | None

company_name

Company name, if applicable.

Type:: str | None

company_code

Company code, if applicable.

Type:: str | None

first_name

First name, if applicable.

Type:: str | None

last_name

Last name, if applicable.

Type:: str | None

address_1

First address line, if applicable.

Type:: str | None

address_2

Last address line, if applicable.

Type:: str | None

country_iso_2

Country code, if applicable.

Type:: str | None

city

City, if applicable.

Type:: str | None

vat

VAT data.

Type:: cherryservers_sdk_python.teams.VatModel | None

currency

Currency type.

Type:: str | None

class cherryservers_sdk_python.teams.TeamModel(*, id: int, name: str | None = None, credit: CreditModel | None = None, billing: BillingModel | None = None, href: str | None = None)[source]

Cherry Servers team model.

This model is frozen by default, since it represents an actual Cherry Servers team resource state.

id

Team ID.

Type:: int

name

Team name.

Type:: str | None

credit

Team credit data.

Type:: cherryservers_sdk_python.teams.CreditModel | None

billing

Team billing data.

Type:: cherryservers_sdk_python.teams.BillingModel | None

href

Team href.

Type:: str | None

class cherryservers_sdk_python.teams.TeamClient(api_client: _client.CherryApiClient, request_timeout: int = 120)[source]

Cherry Servers team client.

Manage Cherry Servers team resources. This class should typically be initialized by cherryservers_sdk_python.facade.CherryApiFacade.

Example

# Get all teams.
teams = facade.teams.get_all()

# Get a team by ID.
team = facade.teams.get_by_id(123456)

# Create a team.
create_req = cherryservers_sdk_python.teams.CreationRequest(
    name="python-sdk-test", currency="EUR"
)
new_team = facade.teams.create(create_req)

# Update team.
update_req = cherryservers_sdk_python.teams.UpdateRequest(
    name="python-sdk-test-updated"
)
new_team.update(update_req)

# Delete team.
new_team.delete()

create(creation_schema: CreationRequest) → Team[source]: Create a new team.

delete(team_id: int) → None[source]: Delete a team by ID.

get_all() → list[Team][source]: Get all teams.

get_by_id(team_id: int) → Team[source]: Retrieve a team by ID.

update(team_id: int, update_schema: UpdateRequest) → Team[source]: Update a team by ID.

class cherryservers_sdk_python.teams.CreationRequest(*, name: str, type: str = 'personal', currency: str | None = None)[source]

Cherry Servers team creation request schema.

name

The name of the team. Required.

Type:: str

type

Team type. Required. Defaults to personal.

Type:: str

currency

Currency type.

Type:: str | None

class cherryservers_sdk_python.teams.UpdateRequest(*, name: str | None = None, type: str | None = None, currency: str | None = None)[source]

Cherry Servers team update request schema.

name

The name of the team.

Type:: str | None

type

Team type.

Type:: str | None

currency

Currency type.

Type:: str | None