Spatio.Api.Recommendations (spatio_sdk v0.0.2)

API calls for all endpoints tagged Recommendations.

Summary

Functions

delete_recommendation(connection, id, opts \\ [])

Delete a recommendation (hard delete; status-update is preferred).

get_recommendation(connection, id, opts \\ [])

Fetch one recommendation.

list_recommendations(connection, opts \\ [])

List recommendations for a workspace.

propose_recommendation(connection, propose_recommendation_request, opts \\ [])

Agent-side propose endpoint (the spatio_recommendations propose MCP tool calls this).

update_recommendation_status(connection, id, update_recommendation_status_request, opts \\ [])

Accept or dismiss a recommendation.

Functions

delete_recommendation(connection, id, opts \\ [])

@spec delete_recommendation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Delete a recommendation (hard delete; status-update is preferred).

Parameters

  • connection (Spatio.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

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

get_recommendation(connection, id, opts \\ [])

@spec get_recommendation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Spatio.Model.ApiError.t()}
  | {:ok, Spatio.Model.Recommendation.t()}
  | {:error, Tesla.Env.t()}

Fetch one recommendation.

Parameters

  • connection (Spatio.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Spatio.Model.Recommendation.t} on success
  • {:error, Tesla.Env.t} on failure

list_recommendations(connection, opts \\ [])

@spec list_recommendations(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Spatio.Model.RecommendationListResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List recommendations for a workspace.

Parameters

  • connection (Spatio.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :workspaceId (String.t):
    • :status (String.t):
    • :limit (integer()):

Returns

  • {:ok, Spatio.Model.RecommendationListResponse.t} on success
  • {:error, Tesla.Env.t} on failure

propose_recommendation(connection, propose_recommendation_request, opts \\ [])

@spec propose_recommendation(
  Tesla.Env.client(),
  Spatio.Model.ProposeRecommendationRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.ApiError.t()}
  | {:ok, Spatio.Model.Recommendation.t()}
  | {:error, Tesla.Env.t()}

Agent-side propose endpoint (the spatio_recommendations propose MCP tool calls this).

Parameters

  • connection (Spatio.Connection): Connection to server
  • propose_recommendation_request (ProposeRecommendationRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Spatio.Model.Recommendation.t} on success
  • {:error, Tesla.Env.t} on failure

update_recommendation_status(connection, id, update_recommendation_status_request, opts \\ [])

@spec update_recommendation_status(
  Tesla.Env.client(),
  String.t(),
  Spatio.Model.UpdateRecommendationStatusRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.ApiError.t()}
  | {:ok, Spatio.Model.Recommendation.t()}
  | {:error, Tesla.Env.t()}

Accept or dismiss a recommendation.

Parameters

  • connection (Spatio.Connection): Connection to server
  • id (String.t):
  • update_recommendation_status_request (UpdateRecommendationStatusRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Spatio.Model.Recommendation.t} on success
  • {:error, Tesla.Env.t} on failure