Get invitations

[paulnoirel]

Description

This PR addresses a request from Schneider Electric to be able to retrieve the list of pending invitations.

Notes:

This PR fixes a bug when a project is deleted after an invite was sent. To prevent an exception, deleted projects are not listed in invite.project_roles

Functions

Organization.get_invites(self) -> PaginatedCollection
Organization.get_project_invites(project_id: str) -> PaginatedCollection:
Invite.cancel() -> bool

Invite.get_invites(client: "Client") -> PaginatedCollection
Invite.get_project_invites(client: "Client", project_id: str) -> PaginatedCollection:

Example:

import uuid
import labelbox as lb

client = lb.Client(API_KEY)

# Data
test_email = f"test-{uuid.uuid4()}@labelbox.com"
project = client.create_project(
    name=f"test-project1-{uuid.uuid4()}", media_type=lb.MediaType.Image
)

org = client.get_organization()
roles = client.get_roles()
project_role = lb.ProjectRole(project=project, role=roles["LABELER"])

invite_temp = org.invite_user(
  email=test_email
  role=roles["NONE"],
  project_roles=[project_role]
)

# At this stage invite_temp.uid == "invited" as per mutation
invite = next(
    invite for invite in org.get_invites() if invite.email == test_email
)

invite_project = next(
    invite for invite in org.get_project_invites(project.uid) if invite.email == test_email
)

cancel_inv_org = invite.cancel() # True
cancel_inv_proj_org = invite_project.cancel() # Exception "Unable to find pending invite with ID xxxx"

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Document change (fix typo or modifying any markdown files, code comments or anything in the examples folder only)

All Submissions

• Have you followed the guidelines in our Contributing document?
• Have you provided a description?
• Are your changes properly formatted?

New Feature Submissions

• Does your submission pass tests?
• Have you added thorough tests for your new feature?
• Have you commented your code, particularly in hard-to-understand areas?
• Have you added a Docstring?

Changes to Core Features

• Have you written new tests for your core changes, as applicable?
• Have you successfully run tests with your changes locally?
• Have you updated any code comments, as applicable?

[Gabefire]

This might make it finicky is their any way we could make this behave more sync? Worse case a retry loop

[Gabefire]

Simple one something like time.sleep 5 seconds check if not there retry again up to 3 times

[Gabefire]

I only mention because ive fix test with this sort of logic. Its annoying when they become finicky

[paulnoirel]

Thanks for the update. I've removed the pause completely.