ExOura.Client.WebhookSubscriptionRoutes (ex_oura v4.0.0)

Copy Markdown View Source

Provides API endpoints related to webhook subscription routes

Summary

Functions

create_webhook_subscription_v2_webhook_subscription_post(body, opts \\ [])

Create Webhook Subscription

delete_webhook_subscription_v2_webhook_subscription_id_delete(id, opts \\ [])

Delete Webhook Subscription

get_webhook_subscription_v2_webhook_subscription_id_get(id, opts \\ [])

Get Webhook Subscription

list_webhook_subscriptions_v2_webhook_subscription_get(opts \\ [])

List Webhook Subscriptions

renew_webhook_subscription_v2_webhook_subscription_renew_id_put(id, opts \\ [])

Renew Webhook Subscription

update_webhook_subscription_v2_webhook_subscription_id_put(id, body, opts \\ [])

Update Webhook Subscription

Functions

create_webhook_subscription_v2_webhook_subscription_post(body, opts \\ [])

@spec create_webhook_subscription_v2_webhook_subscription_post(
  body :: ExOura.Client.CreateWebhookSubscriptionRequest.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Create Webhook Subscription

Request Body

Content Types: application/json

delete_webhook_subscription_v2_webhook_subscription_id_delete(id, opts \\ [])

@spec delete_webhook_subscription_v2_webhook_subscription_id_delete(
  id :: String.t(),
  opts :: keyword()
) :: :ok | {:error, ExOura.Client.HTTPValidationError.t()}

Delete Webhook Subscription

get_webhook_subscription_v2_webhook_subscription_id_get(id, opts \\ [])

@spec get_webhook_subscription_v2_webhook_subscription_id_get(
  id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Get Webhook Subscription

list_webhook_subscriptions_v2_webhook_subscription_get(opts \\ [])

@spec list_webhook_subscriptions_v2_webhook_subscription_get(opts :: keyword()) ::
  {:ok, [ExOura.Client.WebhookSubscriptionModel.t()]} | :error

List Webhook Subscriptions

renew_webhook_subscription_v2_webhook_subscription_renew_id_put(id, opts \\ [])

@spec renew_webhook_subscription_v2_webhook_subscription_renew_id_put(
  id :: String.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Renew Webhook Subscription

update_webhook_subscription_v2_webhook_subscription_id_put(id, body, opts \\ [])

@spec update_webhook_subscription_v2_webhook_subscription_id_put(
  id :: String.t(),
  body :: ExOura.Client.UpdateWebhookSubscriptionRequest.t(),
  opts :: keyword()
) ::
  {:ok, ExOura.Client.WebhookSubscriptionModel.t()}
  | {:error, ExOura.Client.HTTPValidationError.t()}

Update Webhook Subscription

Request Body

Content Types: application/json