pluralsight.licensing package

Submodules

pluralsight.licensing.client module

class pluralsight.licensing.client.LicensingAPIClient(plan, api_key)[source]

Bases: object

The licensing API client

delete(uri)[source]
get(uri, params=None)[source]
post(uri, data=None)[source]
put(uri, data=None)[source]

pluralsight.licensing.invites module

class pluralsight.licensing.invites.InvitesClient(client)[source]

Bases: object

Invites API

cancel_invite(id)[source]

Cancel an invitation

Parameters

id (str) – The identifier

Return type

None

get_all_invites()[source]

Get all invites

Returns

A list of Invite

Return type

list of Invite

get_invite(id)[source]

Fetch an invitation by ID

Parameters

id (str) – The identifier

Returns

An instance Invite

Return type

Invite

get_invites(email=None, note=None, team_id=None)[source]

Get invitations matching certain filters

Parameters

  • email (str) – The users’ email address

  • team_id (str) – The team identifier

  • note (str) – Additional notes on the user

Returns

A list of Invite

Return type

list of Invite

invite_user(email, team_id=None, note=None)[source]

Create a new invitation

Parameters

  • email (str) – The users’ email address

  • team_id (str) – The team identifier

  • note (str) – Additional notes on the user

Returns

An instance Invite

Return type

Invite

update_invite(id, note)[source]

Update an invitation

Parameters

  • id (str) – The identifier

  • note (str) – Additional notes on the user

pluralsight.licensing.teams module

class pluralsight.licensing.teams.TeamsClient(client)[source]

Bases: object

Teams API

get_all_teams(name=None)[source]

Get all teams

Parameters

name (str) – Filter by name

Returns

A list of Team

Return type

list of Team

get_team(id)[source]

Fetch a team by ID

Parameters

id (str) – The identifier

Returns

An instance Team

Return type

Team

pluralsight.licensing.users module

class pluralsight.licensing.users.UsersClient(client)[source]

Bases: object

Users API

delete_user(id)[source]

Delete an existing user

Parameters

id (str) – The identifier

Return type

None

get_all_users(first_name=None, last_name=None, email=None, note=None, team_id=None)[source]

Get all users

Parameters

  • first_name (str) – Filter by first name

  • last_name (str) – Filter by last name

  • email (str) – Filter by email

  • note (str) – Filter by note

  • team_id (str) – Filter by team ID

Returns

A list of User

Return type

list of User

get_user(id)[source]

Fetch a user by ID

Parameters

id (str) – The identifier

Returns

An instance User

Return type

User

update_user(id, team_id, note)[source]

Update a user

Parameters

  • id (str) – The identifier

  • team_id (str) – Team the user belongs to

  • note (str) – Additional notes on the user

Module contents