import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Use this data source to retrieve information about a GitHub team. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const example = github.getTeam({ * slug: "example", * }); * ``` */ export declare function getTeam(args: GetTeamArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getTeam. */ export interface GetTeamArgs { /** * Type of membership to be requested to fill the list of members. Can be either `all` _(default)_ or `immediate`. */ membershipType?: string; /** * (Optional) Set the number of results per REST API query. Accepts a value between 0 - 100 _(defaults to `100`)_. * * @deprecated This is deprecated and will be removed in a future release. */ resultsPerPage?: number; /** * The team slug. */ slug: string; /** * Exclude the members and repositories of the team from the returned result. Defaults to `false`. */ summaryOnly?: boolean; } /** * A collection of values returned by getTeam. */ export interface GetTeamResult { /** * Team's description. */ readonly description: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * List of team members (list of GitHub usernames). Not returned if `summaryOnly = true`. */ readonly members: string[]; readonly membershipType?: string; /** * Team's full name. */ readonly name: string; /** * Node ID of the team. */ readonly nodeId: string; /** * Teams's notification setting. Can be either `notificationsEnabled` or `notificationsDisabled`. */ readonly notificationSetting: string; /** * (**DEPRECATED**) The permission that new repositories will be added to the team with when none is specified. * * @deprecated Closing down notice. */ readonly permission: string; /** * Team's privacy type. Can either be `closed` or `secret`. */ readonly privacy: string; /** * (**DEPRECATED**) List of team repositories (list of repo names). Not returned if `summaryOnly = true`. * * @deprecated Use repositoriesDetailed instead. */ readonly repositories: string[]; /** * List of team repositories (each item comprises of `repoId`, `repoName` & `roleName`). Not returned if `summaryOnly = true`. */ readonly repositoriesDetaileds: outputs.GetTeamRepositoriesDetailed[]; /** * @deprecated This is deprecated and will be removed in a future release. */ readonly resultsPerPage?: number; readonly slug: string; readonly summaryOnly?: boolean; } /** * Use this data source to retrieve information about a GitHub team. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const example = github.getTeam({ * slug: "example", * }); * ``` */ export declare function getTeamOutput(args: GetTeamOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getTeam. */ export interface GetTeamOutputArgs { /** * Type of membership to be requested to fill the list of members. Can be either `all` _(default)_ or `immediate`. */ membershipType?: pulumi.Input; /** * (Optional) Set the number of results per REST API query. Accepts a value between 0 - 100 _(defaults to `100`)_. * * @deprecated This is deprecated and will be removed in a future release. */ resultsPerPage?: pulumi.Input; /** * The team slug. */ slug: pulumi.Input; /** * Exclude the members and repositories of the team from the returned result. Defaults to `false`. */ summaryOnly?: pulumi.Input; } //# sourceMappingURL=getTeam.d.ts.map