SBUserPlan#

samson.SBUserPlan objects holds the user plan.

See also

SAMSON SDK: SBCContainerUserPlan

class samson.SBUserPlan(*args, **kwargs)#

Bases: pybind11_object

This class describes a SAMSON user plan.

Overloaded function.

  1. __init__(self: samson.SBUserPlan) -> None

Constructs the NoPlan user plan

  1. __init__(self: samson.SBUserPlan, userPlan: samson.SBUserPlan.Type) -> None

Constructs a user plan from enum value.

Parameters:

userPlan (samson.SBUserPlan.Type) – User plan tier.

  1. __init__(self: samson.SBUserPlan, typeString: str) -> None

Constructs a user plan.

Parameters:

typeString (str) – A string representation of a user plan (Starter, Professional, Expert, Enterprise). Unknown values fallback to NoPlan.

  1. __init__(self: samson.SBUserPlan, userPlan: samson.SBUserPlan) -> None

Copy constructor.

Parameters:

userPlan (samson.SBUserPlan) – Source user plan.

class Type(self: samson.SBUserPlan.Type, value: int)#

Bases: pybind11_object

Members:

NoPlan : No plan

Starter : The Starter plan

Professional : The Professional plan

Expert : The Expert plan

Enterprise : The Enterprise plan

__eq__(self: object, other: object) → bool#
__ne__(self: object, other: object) → bool#
Enterprise = <Type.Enterprise: 4>#
Expert = <Type.Expert: 3>#
NoPlan = <Type.NoPlan: 0>#
Professional = <Type.Professional: 2>#
Starter = <Type.Starter: 1>#
property name#
property value#
__eq__(self: samson.SBUserPlan, arg0: samson.SBUserPlan) → bool#

Returns True when both user plans are identical.

__lt__(self: samson.SBUserPlan, arg0: samson.SBUserPlan) → bool#

Tier-order comparison (<).

__ne__(self: samson.SBUserPlan, arg0: samson.SBUserPlan) → bool#

Returns True when user plans are different.

Enterprise = <Type.Enterprise: 4>#
Expert = <Type.Expert: 3>#
NoPlan = <Type.NoPlan: 0>#
Professional = <Type.Professional: 2>#
Starter = <Type.Starter: 1>#
property type#

Returns the user plan type. A read-only property.