Skip to content

Gateway group

Gateway group resource for grouping gateways.

SyncGatewayGroups 

SyncGatewayGroups(client: SyncClient)

Bases: BaseResource['SyncClient']

Gateway groups resource for gateway grouping.

Methods:

  • create –

    Create a new gateway group.

  • delete –

    Delete a gateway group.

  • get –

    Retrieve a gateway group by its ID.

  • get_all –

    List all gateway groups.

  • patch –

    Partially update a gateway group.

  • update –

    Update a gateway group (full replacement).

create 

create(data: GatewayGroupCreate) -> str

Create a new gateway group.

Parameters:

Returns:

  • str ( str ) –

    The ID of the newly created gateway group.

delete 

delete(group_id: str) -> None

Delete a gateway group.

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group to delete.

Returns:

  • None –

    None

get 

get(group_id: str) -> GatewayGroupInstance

Retrieve a gateway group by its ID.

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group.

Returns:

  • GatewayGroupInstance ( GatewayGroupInstance ) –

    The gateway group instance matching the given ID.

get_all 

get_all() -> list[GatewayGroupInstance]

List all gateway groups.

Returns:

patch 

patch(group_id: str, data: GatewayGroupPatch) -> bool

Partially update a gateway group.

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group.

  • data

    (GatewayGroupPatch) –

    The partial gateway group data to update.

Returns:

  • GatewayGroupInstance ( bool ) –

    The updated gateway group instance.

update 

update(group_id: str, data: GatewayGroupUpdate) -> bool

Update a gateway group (full replacement).

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group.

  • data

    (GatewayGroupUpdate) –

    The complete gateway group data for replacement.

Returns:

  • GatewayGroupInstance ( bool ) –

    The updated gateway group instance.

AsyncGatewayGroups 

AsyncGatewayGroups(client: AsyncClient)

Bases: BaseResource['AsyncClient']

Async gateway groups resource for gateway grouping.

Methods:

  • create –

    Create a new gateway group.

  • delete –

    Delete a gateway group.

  • get –

    Retrieve a gateway group by its ID.

  • get_all –

    List all gateway groups.

  • patch –

    Partially update a gateway group.

  • update –

    Update a gateway group (full replacement).

create async 

create(data: GatewayGroupCreate) -> str

Create a new gateway group.

Parameters:

Returns:

  • str ( str ) –

    The ID of the newly created gateway group.

delete async 

delete(group_id: str) -> None

Delete a gateway group.

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group to delete.

Returns:

  • None –

    None

get async 

get(group_id: str) -> GatewayGroupInstance

Retrieve a gateway group by its ID.

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group.

Returns:

  • GatewayGroupInstance ( GatewayGroupInstance ) –

    The gateway group instance matching the given ID.

get_all async 

get_all() -> list[GatewayGroupInstance]

List all gateway groups.

Returns:

patch async 

patch(group_id: str, data: GatewayGroupPatch) -> bool

Partially update a gateway group.

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group.

  • data

    (GatewayGroupPatch) –

    The partial gateway group data to update.

Returns:

  • bool ( bool ) –

    True if the patch was successful, False otherwise.

update async 

update(group_id: str, data: GatewayGroupUpdate) -> bool

Update a gateway group (full replacement).

Parameters:

  • group_id

    (str) –

    The unique identifier of the gateway group.

  • data

    (GatewayGroupUpdate) –

    The complete gateway group data for replacement.

Returns:

  • bool ( bool ) –

    True if the update was successful, False otherwise.

Request and response types: Gateway group models.