ExDaytona.Api.Webhooks (ex_daytona v0.1.0)

Copy Markdown View Source

API calls for all endpoints tagged Webhooks.

Summary

Functions

Get Svix Consumer App Portal access for an organization

Get webhook initialization status for an organization

Initialize webhooks for an organization

Refresh cached endpoint presence flag for an organization

Functions

get_app_portal_access(connection, organization_id, opts \\ [])

@spec get_app_portal_access(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.WebhookAppPortalAccess.t()} | {:error, Tesla.Env.t()}

Get Svix Consumer App Portal access for an organization

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t):
  • opts (keyword): Optional parameters
    • :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

  • {:ok, ExDaytona.Model.WebhookAppPortalAccess.t} on success
  • {:error, Tesla.Env.t} on failure

get_initialization_status(connection, organization_id, opts \\ [])

@spec get_initialization_status(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, ExDaytona.Model.WebhookInitializationStatus.t()}
  | {:error, Tesla.Env.t()}

Get webhook initialization status for an organization

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t):
  • opts (keyword): Optional parameters
    • :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

  • {:ok, ExDaytona.Model.WebhookInitializationStatus.t} on success
  • {:error, Tesla.Env.t} on failure

initialize_webhooks(connection, organization_id, opts \\ [])

@spec initialize_webhooks(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.WebhookInitializationStatus.t()}
  | {:error, Tesla.Env.t()}

Initialize webhooks for an organization

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t): Organization ID
  • opts (keyword): Optional parameters
    • :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

  • {:ok, ExDaytona.Model.WebhookInitializationStatus.t} on success
  • {:error, Tesla.Env.t} on failure

refresh_endpoints(connection, organization_id, opts \\ [])

@spec refresh_endpoints(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Refresh cached endpoint presence flag for an organization

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t):
  • opts (keyword): Optional parameters
    • :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure