@pulumi/github 5.0.0 → 5.2.0-alpha.1673638210

package/getUser.d.ts

@@ -1,45 +1,147 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Use this data source to retrieve information about a GitHub user.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUser({
+ *     username: "example",
+ * });
+ * const current = github.getUser({
+ *     username: "",
+ * });
+ * export const currentGithubLogin = current.then(current => current.login);
+ * ```
+ */
 export declare function getUser(args: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>;
 /**
  * A collection of arguments for invoking getUser.
  */
 export interface GetUserArgs {
+    /**
+     * The username. Use an empty string `""` to retrieve information about the currently authenticated user.
+     */
     username: string;
 }
 /**
  * A collection of values returned by getUser.
  */
 export interface GetUserResult {
+    /**
+     * the user's avatar URL.
+     */
     readonly avatarUrl: string;
+    /**
+     * the user's bio.
+     */
     readonly bio: string;
+    /**
+     * the user's blog location.
+     */
     readonly blog: string;
+    /**
+     * the user's company name.
+     */
     readonly company: string;
+    /**
+     * the creation date.
+     */
     readonly createdAt: string;
+    /**
+     * the user's email.
+     */
     readonly email: string;
+    /**
+     * the number of followers.
+     */
     readonly followers: number;
+    /**
+     * the number of following users.
+     */
     readonly following: number;
+    /**
+     * list of user's GPG keys.
+     */
     readonly gpgKeys: string[];
+    /**
+     * the user's gravatar ID.
+     */
     readonly gravatarId: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * the user's location.
+     */
     readonly location: string;
+    /**
+     * the user's login.
+     */
     readonly login: string;
+    /**
+     * the user's full name.
+     */
     readonly name: string;
+    /**
+     * the Node ID of the user.
+     */
     readonly nodeId: string;
+    /**
+     * the number of public gists.
+     */
     readonly publicGists: number;
+    /**
+     * the number of public repositories.
+     */
     readonly publicRepos: number;
+    /**
+     * whether the user is a GitHub admin.
+     */
     readonly siteAdmin: boolean;
+    /**
+     * list of user's SSH keys.
+     */
     readonly sshKeys: string[];
+    /**
+     * the suspended date if the user is suspended.
+     */
     readonly suspendedAt: string;
+    /**
+     * the update date.
+     */
     readonly updatedAt: string;
     readonly username: string;
 }
+/**
+ * Use this data source to retrieve information about a GitHub user.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUser({
+ *     username: "example",
+ * });
+ * const current = github.getUser({
+ *     username: "",
+ * });
+ * export const currentGithubLogin = current.then(current => current.login);
+ * ```
+ */
 export declare function getUserOutput(args: GetUserOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetUserResult>;
 /**
  * A collection of arguments for invoking getUser.
  */
 export interface GetUserOutputArgs {
+    /**
+     * The username. Use an empty string `""` to retrieve information about the currently authenticated user.
+     */
     username: pulumi.Input<string>;
 }

package/getUser.js

@@ -5,18 +5,51 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserOutput = exports.getUser = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about a GitHub user.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUser({
+ *     username: "example",
+ * });
+ * const current = github.getUser({
+ *     username: "",
+ * });
+ * export const currentGithubLogin = current.then(current => current.login);
+ * ```
+ */
 function getUser(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getUser:getUser", {
         "username": args.username,
     }, opts);
 }
 exports.getUser = getUser;
+/**
+ * Use this data source to retrieve information about a GitHub user.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUser({
+ *     username: "example",
+ * });
+ * const current = github.getUser({
+ *     username: "",
+ * });
+ * export const currentGithubLogin = current.then(current => current.login);
+ * ```
+ */
 function getUserOutput(args, opts) {
-    return pulumi.output(args).apply(a => getUser(a, opts));
+    return pulumi.output(args).apply((a) => getUser(a, opts));
 }
 exports.getUserOutput = getUserOutput;
 //# sourceMappingURL=getUser.js.map

package/getUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"getUser.js","sourceRoot":"","sources":["../getUser.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,OAAO,CAAC,IAAiB,EAAE,IAA2B;IAClE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,EAAE;QACzD,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,0BASC;AAwCD,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAC9E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAFD,sCAEC"}
+{"version":3,"file":"getUser.js","sourceRoot":"","sources":["../getUser.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,OAAO,CAAC,IAAiB,EAAE,IAA2B;IAElE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,EAAE;QACzD,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0BAMC;AAsGD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAC9E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAClE,CAAC;AAFD,sCAEC"}

package/getUsers.d.ts

@@ -1,9 +1,32 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Use this data source to retrieve information about multiple GitHub users at once.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUsers({
+ *     usernames: [
+ *         "example1",
+ *         "example2",
+ *         "example3",
+ *     ],
+ * });
+ * export const validUsers = example.then(example => example.logins);
+ * export const invalidUsers = example.then(example => example.unknownLogins);
+ * ```
+ */
 export declare function getUsers(args: GetUsersArgs, opts?: pulumi.InvokeOptions): Promise<GetUsersResult>;
 /**
  * A collection of arguments for invoking getUsers.
  */
 export interface GetUsersArgs {
+    /**
+     * List of usernames.
+     */
     usernames: string[];
 }
 /**
@@ -14,15 +37,47 @@ export interface GetUsersResult {
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * list of logins of users that could be found.
+     */
     readonly logins: string[];
+    /**
+     * list of Node IDs of users that could be found.
+     */
     readonly nodeIds: string[];
+    /**
+     * list of logins without matching user.
+     */
     readonly unknownLogins: string[];
     readonly usernames: string[];
 }
+/**
+ * Use this data source to retrieve information about multiple GitHub users at once.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUsers({
+ *     usernames: [
+ *         "example1",
+ *         "example2",
+ *         "example3",
+ *     ],
+ * });
+ * export const validUsers = example.then(example => example.logins);
+ * export const invalidUsers = example.then(example => example.unknownLogins);
+ * ```
+ */
 export declare function getUsersOutput(args: GetUsersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetUsersResult>;
 /**
  * A collection of arguments for invoking getUsers.
  */
 export interface GetUsersOutputArgs {
+    /**
+     * List of usernames.
+     */
     usernames: pulumi.Input<pulumi.Input<string>[]>;
 }

package/getUsers.js

@@ -5,18 +5,55 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUsersOutput = exports.getUsers = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about multiple GitHub users at once.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUsers({
+ *     usernames: [
+ *         "example1",
+ *         "example2",
+ *         "example3",
+ *     ],
+ * });
+ * export const validUsers = example.then(example => example.logins);
+ * export const invalidUsers = example.then(example => example.unknownLogins);
+ * ```
+ */
 function getUsers(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getUsers:getUsers", {
         "usernames": args.usernames,
     }, opts);
 }
 exports.getUsers = getUsers;
+/**
+ * Use this data source to retrieve information about multiple GitHub users at once.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getUsers({
+ *     usernames: [
+ *         "example1",
+ *         "example2",
+ *         "example3",
+ *     ],
+ * });
+ * export const validUsers = example.then(example => example.logins);
+ * export const invalidUsers = example.then(example => example.unknownLogins);
+ * ```
+ */
 function getUsersOutput(args, opts) {
-    return pulumi.output(args).apply(a => getUsers(a, opts));
+    return pulumi.output(args).apply((a) => getUsers(a, opts));
 }
 exports.getUsersOutput = getUsersOutput;
 //# sourceMappingURL=getUsers.js.map

package/getUsers.js.map

@@ -1 +1 @@
-{"version":3,"file":"getUsers.js","sourceRoot":"","sources":["../getUsers.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IACpE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,4BASC;AAuBD,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC5D,CAAC;AAFD,wCAEC"}
+{"version":3,"file":"getUsers.js","sourceRoot":"","sources":["../getUsers.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IAEpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4BAMC;AAkCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnE,CAAC;AAFD,wCAEC"}