Skip to content

Output profile

Output profile resource for defining data output destinations.

SyncOutputProfiles 

SyncOutputProfiles(client: SyncClient)

Bases: BaseResource['SyncClient']

Output profiles resource for data routing profiles.

Methods:

  • add_devices –

    Add devices to an output profile.

  • create –

    Create a new output profile.

  • delete –

    Delete an output profile.

  • get –

    Retrieve an output profile by its ID.

  • get_all –

    List all output profiles.

  • patch –

    Partially update an output profile.

  • update –

    Update an output profile (full replacement).

  • update_devices –

    Update devices associated with an output profile.

add_devices 

add_devices(
    profile_id: str, data: OutputProfileDevicesUpdate
) -> OutputProfileDevicesUpdateResponse

Add devices to an output profile.

Parameters:

Returns:

create 

create(data: OutputProfileCreate) -> str

Create a new output profile.

Parameters:

Returns:

  • str ( str ) –

    The ID of the newly created output profile.

delete 

delete(profile_id: str) -> None

Delete an output profile.

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile to delete.

Returns:

  • None –

    None

get 

get(profile_id: str) -> OutputProfileInstance

Retrieve an output profile by its ID.

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile.

Returns:

get_all 

get_all() -> list[OutputProfileInstance]

List all output profiles.

Returns:

patch 

patch(profile_id: str, data: OutputProfilePatch) -> bool

Partially update an output profile.

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile.

  • data

    (OutputProfilePatch) –

    The partial output profile data to update.

Returns:

  • OutputProfileInstance ( bool ) –

    The updated output profile instance.

update 

update(profile_id: str, data: OutputProfileUpdate) -> bool

Update an output profile (full replacement).

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile.

  • data

    (OutputProfileUpdate) –

    The complete output profile data for replacement.

Returns:

  • OutputProfileInstance ( bool ) –

    The updated output profile instance.

update_devices 

update_devices(
    profile_id: str, data: OutputProfileDevicesUpdate
) -> OutputProfileDevicesUpdateResponse

Update devices associated with an output profile.

Parameters:

Returns:

AsyncOutputProfiles 

AsyncOutputProfiles(client: AsyncClient)

Bases: BaseResource['AsyncClient']

Async output profiles resource for data routing profiles.

Methods:

  • add_devices –

    Add devices to an output profile.

  • create –

    Create a new output profile.

  • delete –

    Delete an output profile.

  • get –

    Retrieve an output profile by its ID.

  • get_all –

    List all output profiles.

  • patch –

    Partially update an output profile.

  • update –

    Update an output profile (full replacement).

  • update_devices –

    Update devices associated with an output profile.

add_devices async 

add_devices(
    profile_id: str, data: OutputProfileDevicesUpdate
) -> OutputProfileDevicesUpdateResponse

Add devices to an output profile.

Parameters:

Returns:

create async 

create(data: OutputProfileCreate) -> str

Create a new output profile.

Parameters:

Returns:

  • str ( str ) –

    The ID of the newly created output profile.

delete async 

delete(profile_id: str) -> None

Delete an output profile.

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile to delete.

Returns:

  • None –

    None

get async 

get(profile_id: str) -> OutputProfileInstance

Retrieve an output profile by its ID.

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile.

Returns:

get_all async 

get_all() -> list[OutputProfileInstance]

List all output profiles.

Returns:

patch async 

patch(profile_id: str, data: OutputProfilePatch) -> bool

Partially update an output profile.

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile.

  • data

    (OutputProfilePatch) –

    The partial output profile data to update.

Returns:

  • bool ( bool ) –

    True if the patch was successful, False otherwise.

update async 

update(profile_id: str, data: OutputProfileUpdate) -> bool

Update an output profile (full replacement).

Parameters:

  • profile_id

    (str) –

    The unique identifier of the output profile.

  • data

    (OutputProfileUpdate) –

    The complete output profile data for replacement.

Returns:

  • bool ( bool ) –

    True if the update was successful, False otherwise.

update_devices async 

update_devices(
    profile_id: str, data: OutputProfileDevicesUpdate
) -> OutputProfileDevicesUpdateResponse

Update devices associated with an output profile.

Parameters:

Returns:

Request and response types: Output profile models.