Skip to main content

​
prefect_github.organization

This is a module containing: GitHub query_organization* tasks

​
Functions

​
query_organization 

query_organization(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The query root of GitHub’s GraphQL interface. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_team 

query_organization_team(login: str, slug: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find an organization’s team by its slug. Args:
  • login: The organization’s login.
  • slug: The name or slug of the team to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_teams 

query_organization_teams(login: str, user_logins: Iterable[str], github_credentials: GitHubCredentials, privacy: graphql_schema.TeamPrivacy = None, role: graphql_schema.TeamRole = None, query: Optional[str] = None, order_by: graphql_schema.TeamOrder = None, ldap_mapped: Optional[bool] = None, root_teams_only: bool = False, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of teams in this organization. Args:
  • login: The organization’s login.
  • user_logins: User logins to filter by.
  • github_credentials: Credentials to use for authentication with GitHub.
  • privacy: If non-null, filters teams according to privacy.
  • role: If non-null, filters teams according to whether the viewer is an admin or member on team.
  • query: If non-null, filters teams with query on team name and team slug.
  • order_by: Ordering options for teams returned from the connection.
  • ldap_mapped: If true, filters teams that are mapped to an LDAP Group (Enterprise only).
  • root_teams_only: If true, restrict to only root teams.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_project 

query_organization_project(login: str, number: int, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find project by number. Args:
  • login: The organization’s login.
  • number: The project number to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_domains 

query_organization_domains(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, is_verified: Optional[bool] = None, is_approved: Optional[bool] = None, order_by: graphql_schema.VerifiableDomainOrder = {'field': 'DOMAIN', 'direction': 'ASC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of domains owned by the organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • is_verified: Filter by if the domain is verified.
  • is_approved: Filter by if the domain is approved.
  • order_by: Ordering options for verifiable domains returned.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_packages 

query_organization_packages(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, names: Optional[Iterable[str]] = None, repository_id: Optional[str] = None, package_type: graphql_schema.PackageType = None, order_by: graphql_schema.PackageOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of packages under the owner. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • names: Find packages by their names.
  • repository_id: Find packages in a repository by ID.
  • package_type: Filter registry package by type.
  • order_by: Ordering of the returned packages.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_projects 

query_organization_projects(login: str, states: Iterable[graphql_schema.ProjectState], github_credentials: GitHubCredentials, order_by: graphql_schema.ProjectOrder = None, search: Optional[str] = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of projects under the owner. Args:
  • login: The organization’s login.
  • states: A list of states to filter the projects by.
  • github_credentials: Credentials to use for authentication with GitHub.
  • order_by: Ordering options for projects returned from the connection.
  • search: Query to search projects by, currently only searching by name.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsors 

query_organization_sponsors(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, tier_id: Optional[str] = None, order_by: graphql_schema.SponsorOrder = {'field': 'RELEVANCE', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
List of sponsors for this user or organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • tier_id: If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see.
  • order_by: Ordering options for sponsors returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_audit_log 

query_organization_audit_log(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, query: Optional[str] = None, order_by: graphql_schema.AuditLogOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Audit log entries of the organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • query: The query string to filter audit entries.
  • order_by: Ordering options for the returned audit log entries.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_project_v2 

query_organization_project_v2(login: str, number: int, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find a project by number. Args:
  • login: The organization’s login.
  • number: The project number.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_projects_v2 

query_organization_projects_v2(login: str, github_credentials: GitHubCredentials, query: Optional[str] = None, order_by: graphql_schema.ProjectV2Order = {'field': 'NUMBER', 'direction': 'DESC'}, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of projects under the owner. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • query: A project to search for under the the owner.
  • order_by: How to order the returned projects.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_repository 

query_organization_repository(login: str, name: str, github_credentials: GitHubCredentials, follow_renames: bool = True, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find Repository. Args:
  • login: The organization’s login.
  • name: Name of Repository to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • follow_renames: Follow repository renames. If disabled, a repository referenced by its old name will return an error.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsoring 

query_organization_sponsoring(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SponsorOrder = {'field': 'RELEVANCE', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
List of users and organizations this entity is sponsoring. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for the users and organizations returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_project_next 

query_organization_project_next(login: str, number: int, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find a project by project (beta) number. Args:
  • login: The organization’s login.
  • number: The project (beta) number.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_pinned_items 

query_organization_pinned_items(login: str, types: Iterable[graphql_schema.PinnableItemType], github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories and gists this profile owner has pinned to their profile. Args:
  • login: The organization’s login.
  • types: Filter the types of pinned items that are returned.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_projects_next 

query_organization_projects_next(login: str, github_credentials: GitHubCredentials, query: Optional[str] = None, sort_by: graphql_schema.ProjectNextOrderField = 'TITLE', after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of projects (beta) under the owner. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • query: A project (beta) to search for under the the owner.
  • sort_by: How to order the returned projects (beta).
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_repositories 

query_organization_repositories(login: str, github_credentials: GitHubCredentials, privacy: graphql_schema.RepositoryPrivacy = None, order_by: graphql_schema.RepositoryOrder = None, affiliations: Iterable[graphql_schema.RepositoryAffiliation] = None, owner_affiliations: Iterable[graphql_schema.RepositoryAffiliation] = ('OWNER', 'COLLABORATOR'), is_locked: Optional[bool] = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, is_fork: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories that the user owns. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • privacy: If non-null, filters repositories according to privacy.
  • order_by: Ordering options for repositories returned from the connection.
  • affiliations: Array of viewer’s affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.
  • owner_affiliations: Array of owner’s affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.
  • is_locked: If non-null, filters repositories according to whether they have been locked.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • is_fork: If non-null, filters repositories according to whether they are forks of another repository.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_item_showcase 

query_organization_item_showcase(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_pinnable_items 

query_organization_pinnable_items(login: str, types: Iterable[graphql_schema.PinnableItemType], github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories and gists this profile owner can pin to their profile. Args:
  • login: The organization’s login.
  • types: Filter the types of pinnable items that are returned.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_recent_projects 

query_organization_recent_projects(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Recent projects that this user has modified in the context of the owner. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_member_statuses 

query_organization_member_statuses(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.UserStatusOrder = {'field': 'UPDATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Get the status messages members of this entity have set that are either public or visible only to the organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for user statuses returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_pending_members 

query_organization_pending_members(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of users who have been invited to join this organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsors_listing 

query_organization_sponsors_listing(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The GitHub Sponsors listing for this user or organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_members_with_role 

query_organization_members_with_role(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of users who are members of this organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_enterprise_owners 

query_organization_enterprise_owners(login: str, github_credentials: GitHubCredentials, query: Optional[str] = None, organization_role: graphql_schema.RoleInOrganization = None, order_by: graphql_schema.OrgEnterpriseOwnerOrder = {'field': 'LOGIN', 'direction': 'ASC'}, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of owners of the organization’s enterprise account. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • query: The search string to look for.
  • organization_role: The organization role to filter by.
  • order_by: Ordering options for enterprise owners returned from the connection.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsors_activities 

query_organization_sponsors_activities(login: str, actions: Iterable[graphql_schema.SponsorsActivityAction], github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, period: graphql_schema.SponsorsActivityPeriod = 'MONTH', order_by: graphql_schema.SponsorsActivityOrder = {'field': 'TIMESTAMP', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Events involving this sponsorable, such as new sponsorships. Args:
  • login: The organization’s login.
  • actions: Filter activities to only the specified actions.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • period: Filter activities returned to only those that occurred in the most recent specified time period. Set to ALL to avoid filtering by when the activity occurred.
  • order_by: Ordering options for activity returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_interaction_ability 

query_organization_interaction_ability(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The interaction ability settings for this organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_ip_allow_list_entries 

query_organization_ip_allow_list_entries(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.IpAllowListEntryOrder = {'field': 'ALLOW_LIST_VALUE', 'direction': 'ASC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The IP addresses that are allowed to access resources owned by the organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for IP allow list entries returned.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_repository_migrations 

query_organization_repository_migrations(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, state: graphql_schema.MigrationState = None, repository_name: Optional[str] = None, order_by: graphql_schema.RepositoryMigrationOrder = {'field': 'CREATED_AT', 'direction': 'ASC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of all repository migrations for this organization. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • state: Filter repository migrations by state.
  • repository_name: Filter repository migrations by repository name.
  • order_by: Ordering options for repository migrations returned.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_saml_identity_provider 

query_organization_saml_identity_provider(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The Organization’s SAML identity providers. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_repository_discussions 

query_organization_repository_discussions(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.DiscussionOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, repository_id: Optional[str] = None, answered: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Discussions this user has started. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for discussions returned from the connection.
  • repository_id: Filter discussions to only those in a specific repository.
  • answered: Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsorships_as_sponsor 

query_organization_sponsorships_as_sponsor(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SponsorshipOrder = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
This object’s sponsorships as the sponsor. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsorship_newsletters 

query_organization_sponsorship_newsletters(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SponsorshipNewsletterOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
List of sponsorship updates sent from this sponsorable to sponsors. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for sponsorship updates returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsorships_as_maintainer 

query_organization_sponsorships_as_maintainer(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, include_private: bool = False, order_by: graphql_schema.SponsorshipOrder = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
This object’s sponsorships as the maintainer. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • include_private: Whether or not to include private sponsorships in the result set.
  • order_by: Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_repository_discussion_comments 

query_organization_repository_discussion_comments(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, repository_id: Optional[str] = None, only_answers: bool = False, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Discussion comments this user has authored. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • repository_id: Filter discussion comments to only those in a specific repository.
  • only_answers: Filter discussion comments to only those that were marked as the answer.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsorship_for_viewer_as_sponsor 

query_organization_sponsorship_for_viewer_as_sponsor(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The sponsorship from the viewer to this user/organization; that is, the sponsorship where you’re the sponsor. Only returns a sponsorship if it is active. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_organization_sponsorship_for_viewer_as_sponsorable 

query_organization_sponsorship_for_viewer_as_sponsorable(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The sponsorship from this user/organization to the viewer; that is, the sponsorship you’re receiving. Only returns a sponsorship if it is active. Args:
  • login: The organization’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.