# NOTE: This file is auto generated by OpenAPI Generator 7.22.0 (https://openapi-generator.tech).
# Do not edit this file manually.
defmodule Spatio.Api.Apps do
@moduledoc """
API calls for all endpoints tagged `Apps`.
"""
alias Spatio.Connection
import Spatio.RequestBuilder
@doc """
Register a prototype app (project_path is the on-disk root).
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `create_app_request` (CreateAppRequest):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, Spatio.Model.App.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec create_app(Tesla.Env.client, Spatio.Model.CreateAppRequest.t, keyword()) :: {:ok, Spatio.Model.App.t} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def create_app(connection, create_app_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps")
|> add_param(:body, :body, create_app_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Spatio.Model.App},
{401, Spatio.Model.ApiError}
])
end
@doc """
Delete an app.
### 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
"""
@spec delete_app(Tesla.Env.client, String.t, keyword()) :: {:ok, nil} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def delete_app(connection, id, _opts \\ []) do
request =
%{}
|> method(:delete)
|> url("/v1/apps/#{id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{204, false},
{401, Spatio.Model.ApiError}
])
end
@doc """
Delete one file inside the app's project directory.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `id` (String.t):
- `path` (String.t):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, nil}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec delete_app_file(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, nil} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def delete_app_file(connection, id, path, _opts \\ []) do
request =
%{}
|> method(:delete)
|> url("/v1/apps/#{id}/file")
|> add_param(:query, :path, path)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{204, false},
{401, Spatio.Model.ApiError}
])
end
@doc """
Fetch an app.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `id` (String.t):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, Spatio.Model.App.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec get_app(Tesla.Env.client, String.t, keyword()) :: {:ok, Spatio.Model.App.t} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def get_app(connection, id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Spatio.Model.App},
{401, Spatio.Model.ApiError},
{404, Spatio.Model.ApiError}
])
end
@doc """
List files inside the app's project directory.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `id` (String.t):
- `opts` (keyword): Optional parameters
- `:path` (String.t):
### Returns
- `{:ok, Spatio.Model.AppFileListResponse.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec list_app_files(Tesla.Env.client, String.t, keyword()) :: {:ok, Spatio.Model.AppFileListResponse.t} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def list_app_files(connection, id, opts \\ []) do
optional_params = %{
:path => :query
}
request =
%{}
|> method(:get)
|> url("/v1/apps/#{id}/files")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Spatio.Model.AppFileListResponse},
{401, Spatio.Model.ApiError}
])
end
@doc """
List the caller's prototype apps.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, Spatio.Model.AppListResponse.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec list_apps(Tesla.Env.client, keyword()) :: {:ok, Spatio.Model.AppListResponse.t} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def list_apps(connection, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Spatio.Model.AppListResponse},
{401, Spatio.Model.ApiError}
])
end
@doc """
Read one file inside the app's project directory. Path is traversal-checked; returns 400 if it escapes project root.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `id` (String.t):
- `path` (String.t):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, Spatio.Model.AppFileContentResponse.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec read_app_file(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, Spatio.Model.AppFileContentResponse.t} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def read_app_file(connection, id, path, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{id}/file")
|> add_param(:query, :path, path)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Spatio.Model.AppFileContentResponse},
{401, Spatio.Model.ApiError}
])
end
@doc """
Update an app.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `id` (String.t):
- `update_app_request` (UpdateAppRequest):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, Spatio.Model.App.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec update_app(Tesla.Env.client, String.t, Spatio.Model.UpdateAppRequest.t, keyword()) :: {:ok, Spatio.Model.App.t} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def update_app(connection, id, update_app_request, _opts \\ []) do
request =
%{}
|> method(:patch)
|> url("/v1/apps/#{id}")
|> add_param(:body, :body, update_app_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Spatio.Model.App},
{401, Spatio.Model.ApiError}
])
end
@doc """
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `org` (String.t):
- `workspace` (String.t):
- `request_body` (%{optional(String.t) => any()}):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, %{}}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec workspace_create_app(Tesla.Env.client, String.t, String.t, %{optional(String.t) => any()}, keyword()) :: {:ok, %{optional(String.t) => any()}} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def workspace_create_app(connection, org, workspace, request_body, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/organizations/#{org}/workspaces/#{workspace}/apps")
|> add_param(:body, :body, request_body)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, %{}},
{401, Spatio.Model.ApiError},
{403, Spatio.Model.ApiError}
])
end
@doc """
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `org` (String.t):
- `workspace` (String.t):
- `id` (String.t):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, nil}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec workspace_delete_app(Tesla.Env.client, String.t, String.t, String.t, keyword()) :: {:ok, nil} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def workspace_delete_app(connection, org, workspace, id, _opts \\ []) do
request =
%{}
|> method(:delete)
|> url("/v1/organizations/#{org}/workspaces/#{workspace}/apps/#{id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{204, false},
{401, Spatio.Model.ApiError},
{403, Spatio.Model.ApiError}
])
end
@doc """
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `org` (String.t):
- `workspace` (String.t):
- `id` (String.t):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, %{}}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec workspace_get_app(Tesla.Env.client, String.t, String.t, String.t, keyword()) :: {:ok, %{optional(String.t) => any()}} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def workspace_get_app(connection, org, workspace, id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/organizations/#{org}/workspaces/#{workspace}/apps/#{id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, %{}},
{401, Spatio.Model.ApiError},
{403, Spatio.Model.ApiError},
{404, Spatio.Model.ApiError}
])
end
@doc """
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `org` (String.t):
- `workspace` (String.t):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, %{}}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec workspace_list_apps(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, %{optional(String.t) => any()}} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def workspace_list_apps(connection, org, workspace, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/organizations/#{org}/workspaces/#{workspace}/apps")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, %{}},
{401, Spatio.Model.ApiError},
{403, Spatio.Model.ApiError}
])
end
@doc """
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `org` (String.t):
- `workspace` (String.t):
- `id` (String.t):
- `request_body` (%{optional(String.t) => any()}):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, %{}}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec workspace_update_app(Tesla.Env.client, String.t, String.t, String.t, %{optional(String.t) => any()}, keyword()) :: {:ok, %{optional(String.t) => any()}} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def workspace_update_app(connection, org, workspace, id, request_body, _opts \\ []) do
request =
%{}
|> method(:patch)
|> url("/v1/organizations/#{org}/workspaces/#{workspace}/apps/#{id}")
|> add_param(:body, :body, request_body)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, %{}},
{401, Spatio.Model.ApiError},
{403, Spatio.Model.ApiError}
])
end
@doc """
Write one file inside the app's project directory.
### Parameters
- `connection` (Spatio.Connection): Connection to server
- `id` (String.t):
- `write_app_file_request` (WriteAppFileRequest):
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, nil}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec write_app_file(Tesla.Env.client, String.t, Spatio.Model.WriteAppFileRequest.t, keyword()) :: {:ok, nil} | {:ok, Spatio.Model.ApiError.t} | {:error, Tesla.Env.t}
def write_app_file(connection, id, write_app_file_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps/#{id}/file")
|> add_param(:body, :body, write_app_file_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{204, false},
{401, Spatio.Model.ApiError}
])
end
end