runzero.api.custom_integrations

enables standard access to of runZero custom integrations, limited to read operations.

Module Contents

Classes

CustomIntegrations

Read access to custom integrations.
class runzero.api.custom_integrations.CustomIntegrations(client: runzero.client.Client)[source]

Read access to custom integrations.

This is a subset of operations available in runzero.admin.custom_integrations.CustomIntegrationsAdmin which allows ‘write’ operations for custom integrations.

Parameters:

client (runzero.client.Client) – A handle to the runzero.Client which manages interactions with the runZero server.

Constructor method

get(org_id: uuid.UUID, name: str | None = None, custom_integration_id: uuid.UUID | None = None) → runzero.types.CustomIntegration | None[source]

Retrieves runZero custom integrations with either the matching ID or Name.

Parameters:

  • org_id (uuid.UUID) – The ID of the organization to operate against

  • name (Optional[str]) – Optional, name of the organization you want the UUID for

  • custom_integration_id (Optional[uuid.UUID]) – Optional, the id of the source to retrieve

Raises:

AuthError, ClientError, ServerError ValueError if neither custom_integration_id nor name are provided.

Returns:

The matching CustomIntegration or None

Return type:

Optional[runzero.types.CustomIntegration]

get_all(org_id: uuid.UUID) → List[runzero.types.CustomIntegration][source]

Lists all custom integrations available to your account.

Parameters:

org_id (uuid.UUID) – The ID of the organization to operate against

Returns:

List of custom integrations

Raises:

AuthError, ClientError, ServerError

Return type:

List[runzero.types.CustomIntegration]