Skip to content

Iptrunk

Helper methods for IP Trunk subscriptions that make database interactions easier.

get_active_iptrunk_subscriptions(includes=None)

Retrieve active subscriptions specifically for IP trunks.

Parameters:

Name Type Description Default
includes list[str] | None

The fields to be included in the returned Subscription objects.

 None

Returns:

Type Description
list[SubscriptionType]

A list of Subscription objects for IP trunks.
Source code in gso/services/subscriptions/iptrunk.py 
 9
10
11
12
13
14
15
16
17
18
19
20
def get_active_iptrunk_subscriptions(includes: list[str] | None = None) -> list[SubscriptionType]:
    """Retrieve active subscriptions specifically for IP trunks.

    Args:
        includes: The fields to be included in the returned Subscription objects.

    Returns:
        A list of Subscription objects for IP trunks.
    """
    return get_subscriptions(
        product_types=[ProductType.IP_TRUNK], lifecycles=[SubscriptionLifecycle.ACTIVE], includes=includes
    )

get_non_terminated_iptrunk_subscriptions(includes=None)

Retrieve all IP trunk subscriptions that are not terminated.

Parameters:

Name Type Description Default
includes list[str] | None

Fields to be included in the returned Subscription objects.

 None

Returns:

Type Description
list[SubscriptionType]

A list of IP trunk subscriptions.
Source code in gso/services/subscriptions/iptrunk.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def get_non_terminated_iptrunk_subscriptions(includes: list[str] | None = None) -> list[SubscriptionType]:
    """Retrieve all IP trunk subscriptions that are not terminated.

    Args:
        includes: Fields to be included in the returned Subscription objects.

    Returns:
        A list of IP trunk subscriptions.
    """
    return get_subscriptions(
        product_types=[ProductType.IP_TRUNK],
        lifecycles=[SubscriptionLifecycle.INITIAL, SubscriptionLifecycle.PROVISIONING, SubscriptionLifecycle.ACTIVE],
        includes=includes,
    )