View Source PlacetelAPI.Api.Prompts (placetel_api v2.0.0)
API calls for all endpoints tagged Prompts
.
Link to this section Summary
Functions
Delete a prompt Delete a prompt by its ID
Fetch all prompts Provides a list of all prompts
Retrieve a prompt Fetches a prompt by its ID
Create a prompt Creates a new prompt
Update a prompt Update a prompt by its ID
Link to this section Functions
@spec delete_prompts_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete a prompt Delete a prompt by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Prompt IDopts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec get_prompts( Tesla.Env.client(), keyword() ) :: {:ok, [PlacetelAPI.Model.Prompt.t()]} | {:error, Tesla.Env.t()}
Fetch all prompts Provides a list of all prompts
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters:"filter[name]"
(String.t)::"filter[description]"
(String.t)::page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%Prompt{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_prompts_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.Prompt.t()} | {:error, Tesla.Env.t()}
Retrieve a prompt Fetches a prompt by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Prompt IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Prompt.t}
on success{:error, Tesla.Env.t}
on failure
@spec post_prompts(Tesla.Env.client(), PlacetelAPI.Model.PostPrompts.t(), keyword()) :: {:ok, PlacetelAPI.Model.Prompt.t()} | {:error, Tesla.Env.t()}
Create a prompt Creates a new prompt
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverprompts
(PostPrompts):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Prompt.t}
on success{:error, Tesla.Env.t}
on failure
@spec put_prompts_id( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutPrompts.t(), keyword() ) :: {:ok, PlacetelAPI.Model.Prompt.t()} | {:error, Tesla.Env.t()}
Update a prompt Update a prompt by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Prompt IDprompts
(PutPrompts):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Prompt.t}
on success{:error, Tesla.Env.t}
on failure