using System;
using System.Diagnostics.CodeAnalysis;
using System.Reactive;
namespace Octokit.Reactive
{
public interface IObservableRepositoriesClient
{
///
/// Creates a new repository for the current user.
///
/// A instance describing the new repository to create
/// An instance for the created repository
IObservable Create(NewRepository newRepository);
///
/// Creates a new repository in the specified organization.
///
/// The login of the organization in which to create the repository
/// A instance describing the new repository to create
/// An instance for the created repository
IObservable Create(string organizationLogin, NewRepository newRepository);
///
/// Creates a new repository using a repository template.
///
/// The owner of the template
/// The name of the template
/// A instance describing the new repository to create from a template
/// An instance for the created repository
IObservable Generate(string templateOwner, string templateRepo, NewRepositoryFromTemplate newRepository);
///
/// Deletes a repository for the specified owner and name.
///
/// The owner of the repository
/// The name of the repository
/// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
/// An for the operation
IObservable Delete(string owner, string name);
///
/// Deletes a repository for the specified owner and name.
///
/// The Id of the repository
/// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
/// An for the operation
IObservable Delete(long repositoryId);
///
/// Transfers the ownership of the specified repository.
///
///
/// See the API documentation for more information.
///
/// The current owner of the repository
/// The name of the repository
/// Repository transfer information
/// A
IObservable Transfer(string owner, string name, RepositoryTransfer repositoryTransfer);
///
/// Transfers the ownership of the specified repository.
///
///
/// See the API documentation for more information.
///
/// The id of the repository
/// Repository transfer information
/// A
IObservable Transfer(long repositoryId, RepositoryTransfer repositoryTransfer);
///
/// Checks if vulnerability alerts are enabled for the specified repository.
///
///
/// See the API documentation for more information.
///
/// The current owner of the repository
/// The name of the repository
/// A bool indicating if alerts are turned on or not.
IObservable AreVulnerabilityAlertsEnabled(string owner, string name);
///
/// Retrieves the for the specified owner and name.
///
/// The owner of the repository
/// The name of the repository
/// A
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
IObservable Get(string owner, string name);
///
/// Retrieves the for the specified owner and name.
///
/// The Id of the repository
/// A
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
IObservable Get(long repositoryId);
///
/// Retrieves every public .
///
///
/// The default page size on GitHub.com is 30.
///
/// A of .
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
Justification = "Makes a network request")]
IObservable GetAllPublic();
///
/// Retrieves every public since the last repository seen.
///
///
/// The default page size on GitHub.com is 30.
///
/// Search parameters of the last repository seen
/// A of .
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
Justification = "Makes a network request")]
IObservable GetAllPublic(PublicRepositoryRequest request);
///
/// Retrieves every that belongs to the current user.
///
///
/// The default page size on GitHub.com is 30.
///
/// Thrown if the client is not authenticated.
/// A of .
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
Justification = "Makes a network request")]
IObservable GetAllForCurrent();
///
/// Retrieves every that belongs to the current user.
///
/// Options for changing the API response
/// Thrown if the client is not authenticated.
/// A of .
IObservable GetAllForCurrent(ApiOptions options);
///
/// Retrieves every that belongs to the current user.
///
///
/// The default page size on GitHub.com is 30.
///
/// Search parameters to filter results on
/// Thrown if the client is not authenticated.
/// A of .
IObservable GetAllForCurrent(RepositoryRequest request);
///
/// Retrieves every that belongs to the current user.
///
/// Search parameters to filter results on
/// Options for changing the API response
/// Thrown if the client is not authenticated.
/// A of .
IObservable GetAllForCurrent(RepositoryRequest request, ApiOptions options);
///
/// Retrieves every that belongs to the specified user.
///
/// The account name to search for
/// A of .
IObservable GetAllForUser(string login);
///
/// Retrieves every that belongs to the specified user.
///
/// The account name to search for
/// Options for changing the API response
/// A of .
IObservable GetAllForUser(string login, ApiOptions options);
///
/// Retrieves every that belongs to the specified organization.
///
///
/// The default page size on GitHub.com is 30.
///
/// A of .
IObservable GetAllForOrg(string organization);
///
/// Retrieves every that belongs to the specified organization.
///
/// The organization name to search for
/// Options for changing the API response
/// A of .
IObservable GetAllForOrg(string organization, ApiOptions options);
///
/// Access GitHub's Repository Actions API.
///
///
/// See the API documentation for more details.
///
IObservableRepositoryActionsClient Actions { get; }
///
/// Client for managing branches in a repository.
///
///
/// See the Branches API documentation for more details
///
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
IObservableRepositoryBranchesClient Branch { get; }
///
/// A client for GitHub's Commit Status API.
///
///
/// See the Commit Status API documentation for more
/// details. Also check out the blog post
/// that announced this feature.
///
IObservableCommitStatusClient Status { get; }
///
/// Client for GitHub's Repository Deployments API
///
///
/// See the Deployments API documentation for more details
///
IObservableDeploymentsClient Deployment { get; }
///
/// Client for GitHub's Repository Envirinments API
///
///
/// See the Envirinments API documentation for more details
///
IObservableRepositoryDeployEnvironmentsClient Environment { get; }
///
/// Client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see a word about caching for more details.
///
///
/// See the Statistics API documentation for more details
///
IObservableStatisticsClient Statistics { get; }
///
/// Client for GitHub's Repository Comments API.
///
///
/// See the Repository Comments API documentation for more information.
///
IObservableRepositoryCommentsClient Comment { get; }
///
/// Client for GitHub's Repository Custom Property Values API.
///
///
/// See the Repository Custom Property API documentation for more information.
///
IObservableRepositoryCustomPropertiesClient CustomProperty { get; }
///
/// A client for GitHub's Repository Hooks API.
///
/// See Hooks API documentation for more information.
IObservableRepositoryHooksClient Hooks { get; }
///
/// A client for GitHub's Repository Forks API.
///
/// See Forks API documentation for more information.
IObservableRepositoryForksClient Forks { get; }
///
/// Client for GitHub's Repository Contents API.
///
///
/// See the Repository Contents API documentation for more information.
///
IObservableRepositoryContentsClient Content { get; }
///
/// Client for GitHub's Repository Merging API
///
///
/// See the Merging API documentation for more details
///
IObservableMergingClient Merging { get; }
///
/// Gets all contributors for the specified repository. Does not include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// All contributors of the repository.
IObservable GetAllContributors(string owner, string name);
///
/// Gets all contributors for the specified repository. Does not include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// All contributors of the repository.
IObservable GetAllContributors(long repositoryId);
///
/// Gets all contributors for the specified repository. Does not include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// Options for changing the API response
/// All contributors of the repository.
IObservable GetAllContributors(string owner, string name, ApiOptions options);
///
/// Gets all contributors for the specified repository. Does not include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// Options for changing the API response
/// All contributors of the repository.
IObservable GetAllContributors(long repositoryId, ApiOptions options);
///
/// Gets all contributors for the specified repository. With the option to include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// True if anonymous contributors should be included in result; Otherwise false
/// All contributors of the repository.
IObservable GetAllContributors(string owner, string name, bool includeAnonymous);
///
/// Gets all contributors for the specified repository. With the option to include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// True if anonymous contributors should be included in result; Otherwise false
/// All contributors of the repository.
IObservable GetAllContributors(long repositoryId, bool includeAnonymous);
///
/// Gets all contributors for the specified repository. With the option to include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// True if anonymous contributors should be included in result; Otherwise false
/// Options for changing the API response
/// All contributors of the repository.
IObservable GetAllContributors(string owner, string name, bool includeAnonymous, ApiOptions options);
///
/// Gets all contributors for the specified repository. With the option to include anonymous contributors.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// True if anonymous contributors should be included in result; Otherwise false
/// Options for changing the API response
/// All contributors of the repository.
IObservable GetAllContributors(long repositoryId, bool includeAnonymous, ApiOptions options);
///
/// Gets all languages for the specified repository.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// All languages used in the repository and the number of bytes of each language.
IObservable GetAllLanguages(string owner, string name);
///
/// Gets all languages for the specified repository.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// All languages used in the repository and the number of bytes of each language.
IObservable GetAllLanguages(long repositoryId);
///
/// Gets all teams for the specified repository.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// All s associated with the repository
IObservable GetAllTeams(string owner, string name);
///
/// Gets all teams for the specified repository.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// All s associated with the repository
IObservable GetAllTeams(long repositoryId);
///
/// Gets all teams for the specified repository.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// Options for changing the API response
/// All s associated with the repository
IObservable GetAllTeams(string owner, string name, ApiOptions options);
///
/// Gets all teams for the specified repository.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// Options for changing the API response
/// All s associated with the repository
IObservable GetAllTeams(long repositoryId, ApiOptions options);
///
/// Gets all tags for the specified repository.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// All of the repositories tags.
IObservable GetAllTags(string owner, string name);
///
/// Gets all tags for the specified repository.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// All of the repositories tags.
IObservable GetAllTags(long repositoryId);
///
/// Gets all tags for the specified repository.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// Options for changing the API response
/// All of the repositories tags.
IObservable GetAllTags(string owner, string name, ApiOptions options);
///
/// Gets all tags for the specified repository.
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// Options for changing the API response
/// All of the repositories tags.
IObservable GetAllTags(long repositoryId, ApiOptions options);
///
/// Get the contents of a repository's license
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// Returns the contents of the repository's license file, if one is detected.
IObservable GetLicenseContents(string owner, string name);
///
/// Get the contents of a repository's license
///
///
/// See the API documentation for more details
///
/// The Id of the repository
/// Returns the contents of the repository's license file, if one is detected.
IObservable GetLicenseContents(long repositoryId);
///
/// Updates the specified repository with the values given in
///
/// The owner of the repository
/// The name of the repository
/// New values to update the repository with
/// The updated
IObservable Edit(string owner, string name, RepositoryUpdate update);
///
/// Updates the specified repository with the values given in
///
/// The Id of the repository
/// New values to update the repository with
/// The updated
IObservable Edit(long repositoryId, RepositoryUpdate update);
///
/// A client for GitHub's Repository Autolinks API
///
///
/// See the API documentation for more information.
///
IObservableAutolinksClient Autolinks { get; }
///
/// A client for GitHub's Repo Collaborators.
///
///
/// See the Collaborators API documentation for more details
///
IObservableRepoCollaboratorsClient Collaborator { get; }
///
/// Client for GitHub's Repository Commits API
///
///
/// See the Commits API documentation for more details
///
IObservableRepositoryCommitsClient Commit { get; }
///
/// Access GitHub's Releases API.
///
///
/// Refer to the API documentation for more information: https://developer.github.com/v3/repos/releases/
///
IObservableReleasesClient Release { get; }
///
/// Client for managing pull requests.
///
///
/// See the Pull Requests API documentation for more details
///
IObservablePullRequestsClient PullRequest { get; }
///
/// Client for managing deploy keys
///
///
/// See the Repository Deploy Keys API documentation for more information.
///
IObservableRepositoryDeployKeysClient DeployKeys { get; }
///
/// A client for GitHub's Repository Pages API.
///
///
/// See the Repository Pages API documentation for more information.
///
IObservableRepositoryPagesClient Page { get; }
///
/// A client for GitHub's Repository Invitations API.
///
///
/// See the Repository Invitations API documentation for more information.
///
IObservableRepositoryInvitationsClient Invitation { get; }
///
/// Access GitHub's Repository Traffic API
///
///
/// Refer to the API documentation for more information: https://developer.github.com/v3/repos/traffic/
///
IObservableRepositoryTrafficClient Traffic { get; }
///
/// Access GitHub's Repository Projects API
///
///
/// Refer to the API documentation for more information: https://developer.github.com/v3/repos/projects/
///
IObservableProjectsClient Project { get; }
///
/// Gets all topics for the specified owner and repository name.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// Options for changing the API response
/// All topics associated with the repository.
IObservable GetAllTopics(string owner, string name, ApiOptions options);
///
/// Gets all topics for the specified owner and repository name.
///
///
/// See the API documentation for more details
///
/// The owner of the repository
/// The name of the repository
/// All topics associated with the repository.
IObservable GetAllTopics(string owner, string name);
///
/// Gets all topics for the specified repository ID.
///
///
/// See the API documentation for more details
///
/// The ID of the repository
/// Options for changing the API response
/// All topics associated with the repository.
IObservable GetAllTopics(long repositoryId, ApiOptions options);
///
/// Gets all topics for the specified repository ID.
///
///
/// See the API documentation for more details
///
/// The ID of the repository
/// All topics associated with the repository.
IObservable GetAllTopics(long repositoryId);
///
/// Replaces all topics for the specified repository.
///
///
/// See the API documentation for more details
///
/// This is a replacement operation; it is not additive. To clear repository topics, for example, you could specify an empty list of topics here.
///
/// The ID of the repository
/// The list of topics to associate with the repository
/// All topics now associated with the repository.
IObservable ReplaceAllTopics(long repositoryId, RepositoryTopics topics);
///
/// Replaces all topics for the specified repository.
///
///
/// See the API documentation for more details
///
/// This is a replacement operation; it is not additive. To clear repository topics, for example, you could specify an empty list of topics here.
///
/// The owner of the repository
/// The name of the repository
/// The list of topics to associate with the repository
/// All topics now associated with the repository.
IObservable ReplaceAllTopics(string owner, string name, RepositoryTopics topics);
///
/// Gets the list of errors in the codeowners file
///
/// The owner of the repository
/// The name of the repository
/// Returns the list of errors in the codeowners files
[ManualRoute("GET", "/repos/{owner}/{repo}/codeowners/errors")]
IObservable GetAllCodeOwnersErrors(string owner, string name);
///
/// Gets the list of errors in the codeowners file
///
/// The Id of the repository
/// Returns the list of errors in the codeowners files
[ManualRoute("GET", "/repositories/{id}/codeowners/errors")]
IObservable GetAllCodeOwnersErrors(long repositoryId);
}
}