Jido.Chat.GitHub.Transport behaviour (Jido Chat GitHub v1.0.0)

Copy Markdown View Source

Transport contract for GitHub REST API calls used by the adapter.

Summary

Callbacks

create_issue(t, t, t, arg4, keyword)

@callback create_issue(String.t(), String.t(), String.t(), String.t() | nil, keyword()) ::
  {:ok, map()} | {:error, term()}

create_issue_comment(t, t, integer, t, keyword)

@callback create_issue_comment(String.t(), String.t(), integer(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

create_issue_comment_reaction(t, t, arg3, t, keyword)

@callback create_issue_comment_reaction(
  String.t(),
  String.t(),
  integer() | String.t(),
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

create_issue_reaction(t, t, integer, t, keyword)

@callback create_issue_reaction(String.t(), String.t(), integer(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

delete_issue_comment(t, t, arg3, keyword)

@callback delete_issue_comment(String.t(), String.t(), integer() | String.t(), keyword()) ::
  :ok | {:error, term()}

delete_issue_comment_reaction(t, t, arg3, arg4, keyword)

@callback delete_issue_comment_reaction(
  String.t(),
  String.t(),
  integer() | String.t(),
  integer() | String.t(),
  keyword()
) :: :ok | {:error, term()}

delete_issue_reaction(t, t, integer, arg4, keyword)

@callback delete_issue_reaction(
  String.t(),
  String.t(),
  integer(),
  integer() | String.t(),
  keyword()
) :: :ok | {:error, term()}

get_issue(t, t, integer, keyword)

@callback get_issue(String.t(), String.t(), integer(), keyword()) ::
  {:ok, map()} | {:error, term()}

get_issue_comment(t, t, arg3, keyword)

@callback get_issue_comment(String.t(), String.t(), integer() | String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

list_issue_comment_reactions(t, t, arg3, keyword)

@callback list_issue_comment_reactions(
  String.t(),
  String.t(),
  integer() | String.t(),
  keyword()
) :: {:ok, [map()]} | {:error, term()}

list_issue_comments(t, t, integer, keyword)

@callback list_issue_comments(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [map()]} | {:error, term()}

list_issue_reactions(t, t, integer, keyword)

@callback list_issue_reactions(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [map()]} | {:error, term()}

list_issues(t, t, keyword)

@callback list_issues(String.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, term()}

update_issue_comment(t, t, arg3, t, keyword)

@callback update_issue_comment(
  String.t(),
  String.t(),
  integer() | String.t(),
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}