View Source PlacetelAPI.Api.Prompts (placetel_api v2.0.1)

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

Link to this function

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

View Source
@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 server
  • id (integer()): Prompt ID
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_prompts(connection, opts \\ [])

View Source
@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 server
  • opts (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
Link to this function

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

View Source
@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 server
  • id (integer()): Prompt ID
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, PlacetelAPI.Model.Prompt.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_prompts(connection, prompts, opts \\ [])

View Source

Create a prompt Creates a new prompt

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • prompts (PostPrompts):
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, PlacetelAPI.Model.Prompt.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

put_prompts_id(connection, id, prompts, opts \\ [])

View Source
@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 server
  • id (integer()): Prompt ID
  • prompts (PutPrompts):
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, PlacetelAPI.Model.Prompt.t} on success
  • {:error, Tesla.Env.t} on failure