Add support for the list failed organization invitations feature (#1871)

Fixes: #1812.

github/orgs_members.go

@@ -362,3 +362,27 @@ func (s *OrganizationsService) ListOrgInvitationTeams(ctx context.Context, org,
 	}
 	return orgInvitationTeams, resp, nil
 }
+
+// ListFailedOrgInvitations returns a list of failed inviatations.
+//
+// GitHub API docs: https://docs.github.com/en/rest/reference/orgs#list-failed-organization-invitations
+func (s *OrganizationsService) ListFailedOrgInvitations(ctx context.Context, org string, opts *ListOptions) ([]*Invitation, *Response, error) {
+	u := fmt.Sprintf("orgs/%v/failed_invitations", org)
+	u, err := addOptions(u, opts)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	var failedInvitations []*Invitation
+	resp, err := s.client.Do(ctx, req, &failedInvitations)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return failedInvitations, resp, nil
+}

github/orgs_members_test.go

@@ -744,3 +744,108 @@ func TestOrganizationsService_ListOrgInvitationTeams(t *testing.T) {
 		return resp, err
 	})
 }
+
+func TestOrganizationsService_ListFailedOrgInvitations(t *testing.T) {
+	client, mux, _, teardown := setup()
+	defer teardown()
+
+	mux.HandleFunc("/orgs/o/failed_invitations", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testFormValues(t, r, values{"page": "2", "per_page": "1"})
+		fmt.Fprint(w, `[
+			{
+			   "id":1,
+			   "login":"monalisa",
+			   "node_id":"MDQ6VXNlcjE=",
+			   "email":"octocat@github.com",
+			   "role":"direct_member",
+			   "created_at":"2016-11-30T06:46:10Z",
+			   "failed_at":"2017-01-02T01:10:00Z",
+			   "failed_reason":"the reason",
+			   "inviter":{
+				  "login":"other_user",
+				  "id":1,
+				  "node_id":"MDQ6VXNlcjE=",
+				  "avatar_url":"https://github.com/images/error/other_user_happy.gif",
+				  "gravatar_id":"",
+				  "url":"https://api.github.com/users/other_user",
+				  "html_url":"https://github.com/other_user",
+				  "followers_url":"https://api.github.com/users/other_user/followers",
+				  "following_url":"https://api.github.com/users/other_user/following{/other_user}",
+				  "gists_url":"https://api.github.com/users/other_user/gists{/gist_id}",
+				  "starred_url":"https://api.github.com/users/other_user/starred{/owner}{/repo}",
+				  "subscriptions_url":"https://api.github.com/users/other_user/subscriptions",
+				  "organizations_url":"https://api.github.com/users/other_user/orgs",
+				  "repos_url":"https://api.github.com/users/other_user/repos",
+				  "events_url":"https://api.github.com/users/other_user/events{/privacy}",
+				  "received_events_url":"https://api.github.com/users/other_user/received_events",
+				  "type":"User",
+				  "site_admin":false
+			   },
+			   "team_count":2,
+			   "invitation_team_url":"https://api.github.com/organizations/2/invitations/1/teams"
+			}
+		]`)
+	})
+
+	opts := &ListOptions{Page: 2, PerPage: 1}
+	ctx := context.Background()
+	failedInvitations, _, err := client.Organizations.ListFailedOrgInvitations(ctx, "o", opts)
+	if err != nil {
+		t.Errorf("Organizations.ListFailedOrgInvitations returned error: %v", err)
+	}
+
+	createdAt := time.Date(2016, time.November, 30, 6, 46, 10, 0, time.UTC)
+	want := []*Invitation{
+		{
+			ID:           Int64(1),
+			Login:        String("monalisa"),
+			NodeID:       String("MDQ6VXNlcjE="),
+			Email:        String("octocat@github.com"),
+			Role:         String("direct_member"),
+			FailedAt:     &Timestamp{time.Date(2017, time.January, 2, 1, 10, 0, 0, time.UTC)},
+			FailedReason: String("the reason"),
+			CreatedAt:    &createdAt,
+			Inviter: &User{
+				Login:             String("other_user"),
+				ID:                Int64(1),
+				NodeID:            String("MDQ6VXNlcjE="),
+				AvatarURL:         String("https://github.com/images/error/other_user_happy.gif"),
+				GravatarID:        String(""),
+				URL:               String("https://api.github.com/users/other_user"),
+				HTMLURL:           String("https://github.com/other_user"),
+				FollowersURL:      String("https://api.github.com/users/other_user/followers"),
+				FollowingURL:      String("https://api.github.com/users/other_user/following{/other_user}"),
+				GistsURL:          String("https://api.github.com/users/other_user/gists{/gist_id}"),
+				StarredURL:        String("https://api.github.com/users/other_user/starred{/owner}{/repo}"),
+				SubscriptionsURL:  String("https://api.github.com/users/other_user/subscriptions"),
+				OrganizationsURL:  String("https://api.github.com/users/other_user/orgs"),
+				ReposURL:          String("https://api.github.com/users/other_user/repos"),
+				EventsURL:         String("https://api.github.com/users/other_user/events{/privacy}"),
+				ReceivedEventsURL: String("https://api.github.com/users/other_user/received_events"),
+				Type:              String("User"),
+				SiteAdmin:         Bool(false),
+			},
+			TeamCount:         Int(2),
+			InvitationTeamURL: String("https://api.github.com/organizations/2/invitations/1/teams"),
+		},
+	}
+
+	if !reflect.DeepEqual(failedInvitations, want) {
+		t.Errorf("Organizations.ListFailedOrgInvitations returned %+v, want %+v", failedInvitations, want)
+	}
+
+	const methodName = "ListFailedOrgInvitations"
+	testBadOptions(t, methodName, func() error {
+		_, _, err := client.Organizations.ListFailedOrgInvitations(ctx, "\n", opts)
+		return err
+	})
+
+	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
+		got, resp, err := client.Organizations.ListFailedOrgInvitations(ctx, "o", opts)
+		if got != nil {
+			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
+		}
+		return resp, err
+	})
+}

github/teams.go

@@ -71,6 +71,8 @@ type Invitation struct {
 	Inviter           *User      `json:"inviter,omitempty"`
 	TeamCount         *int       `json:"team_count,omitempty"`
 	InvitationTeamURL *string    `json:"invitation_team_url,omitempty"`
+	FailedAt          *Timestamp `json:"failed_at,omitempty"`
+	FailedReason      *string    `json:"failed_reason,omitempty"`
 }
 
 func (i Invitation) String() string {