View Source GitHub.Interactions (GitHub REST API Client v0.0.1-beta.0)

Provides API endpoints related to interactions

Link to this section Summary

Functions

Get interaction restrictions for your public repositories

Get interaction restrictions for an organization

Get interaction restrictions for a repository

Remove interaction restrictions from your public repositories

Remove interaction restrictions for an organization

Remove interaction restrictions for a repository

Set interaction restrictions for your public repositories

Set interaction restrictions for an organization

Set interaction restrictions for a repository

Link to this section Functions

Link to this function

get_restrictions_for_authenticated_user(opts \\ [])

View Source
@spec get_restrictions_for_authenticated_user(keyword()) ::
  {:ok, map() | GitHub.Interaction.Limit.Response.t()}
  | {:error, GitHub.Error.t()}

Get interaction restrictions for your public repositories

resources

Resources

Link to this function

get_restrictions_for_org(org, opts \\ [])

View Source
@spec get_restrictions_for_org(
  String.t(),
  keyword()
) ::
  {:ok, map() | GitHub.Interaction.Limit.Response.t()}
  | {:error, GitHub.Error.t()}

Get interaction restrictions for an organization

resources

Resources

Link to this function

get_restrictions_for_repo(owner, repo, opts \\ [])

View Source
@spec get_restrictions_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, map() | GitHub.Interaction.Limit.Response.t()}
  | {:error, GitHub.Error.t()}

Get interaction restrictions for a repository

resources

Resources

Link to this function

remove_restrictions_for_authenticated_user(opts \\ [])

View Source
@spec remove_restrictions_for_authenticated_user(keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Remove interaction restrictions from your public repositories

resources

Resources

Link to this function

remove_restrictions_for_org(org, opts \\ [])

View Source
@spec remove_restrictions_for_org(
  String.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Remove interaction restrictions for an organization

resources

Resources

Link to this function

remove_restrictions_for_repo(owner, repo, opts \\ [])

View Source
@spec remove_restrictions_for_repo(String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Remove interaction restrictions for a repository

resources

Resources

Link to this function

set_restrictions_for_authenticated_user(body, opts \\ [])

View Source
@spec set_restrictions_for_authenticated_user(
  GitHub.Interaction.Limit.t(),
  keyword()
) :: {:ok, GitHub.Interaction.Limit.Response.t()} | {:error, GitHub.Error.t()}

Set interaction restrictions for your public repositories

resources

Resources

Link to this function

set_restrictions_for_org(org, body, opts \\ [])

View Source
@spec set_restrictions_for_org(String.t(), GitHub.Interaction.Limit.t(), keyword()) ::
  {:ok, GitHub.Interaction.Limit.Response.t()} | {:error, GitHub.Error.t()}

Set interaction restrictions for an organization

resources

Resources

Link to this function

set_restrictions_for_repo(owner, repo, body, opts \\ [])

View Source
@spec set_restrictions_for_repo(
  String.t(),
  String.t(),
  GitHub.Interaction.Limit.t(),
  keyword()
) ::
  {:ok, GitHub.Interaction.Limit.Response.t()} | {:error, GitHub.Error.t()}

Set interaction restrictions for a repository

resources

Resources