Lab Services — Subscribers

8 min

delete_subscribers_system_id

sync(system: str, id: int, client: AuthenticatedClient | Client, apiversion: str | Unset = UNSET) -> Any | ProblemDetails | None

Parameter	Type	Default
system	str	required
id	int	required
client	AuthenticatedClient \| Client	required
apiversion	str \| Unset	UNSET

Returns: Any | ProblemDetails | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

get_subscribers

sync(client: AuthenticatedClient | Client, apiversion: str | Unset = UNSET) -> list[Subscriber] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
apiversion	str \| Unset	UNSET

Returns: list[Subscriber] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

get_subscribers_system_id

sync(system: str, id: int, client: AuthenticatedClient | Client, apiversion: str | Unset = UNSET) -> ProblemDetails | Subscriber | None

Parameter	Type	Default
system	str	required
id	int	required
client	AuthenticatedClient \| Client	required
apiversion	str \| Unset	UNSET

Returns: ProblemDetails | Subscriber | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

post_subscribers

sync(client: AuthenticatedClient | Client, body: Subscriber | Unset = UNSET, system: str | Unset = UNSET, apiversion: str | Unset = UNSET) -> ProblemDetails | list[Subscriber] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	Subscriber \| Unset	UNSET
system	str \| Unset	UNSET
apiversion	str \| Unset	UNSET

body — A subscriber represents a user/party that is interested in receiving notifications of events.

Returns: ProblemDetails | list[Subscriber] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.