bitmovin_api_sdk.account.organizations.groups.invitations package

Submodules

bitmovin_api_sdk.account.organizations.groups.invitations.invitation_list_query_params module

class bitmovin_api_sdk.account.organizations.groups.invitations.invitation_list_query_params.InvitationListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.account.organizations.groups.invitations.invitations_api module

class bitmovin_api_sdk.account.organizations.groups.invitations.invitations_api.InvitationsApi(**kwargs)[source]

Bases: BaseApi

create(organization_id: string_types, group_id: string_types, invitation: Invitation, **kwargs: dict) → Invitation[source]

Add Invitation to Group

Parameters

  • organization_id (string_types, required) – Id of the organization

  • group_id (string_types, required) – Id of the group

  • invitation (Invitation, required) – Invitation details

Returns

Invitation details

Return type

Invitation

delete(organization_id: string_types, group_id: string_types, invitation_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete Invitation

Parameters

  • organization_id (string_types, required) – Id of the organization

  • group_id (string_types, required) – Id of the group

  • invitation_id (string_types, required) – Id of the invitation.

Returns

Id of the group

Return type

BitmovinResponse

get(organization_id: string_types, group_id: string_types, invitation_id: string_types, **kwargs: dict) → Invitation[source]

Invitation Details

Parameters

  • organization_id (string_types, required) – Id of the organization

  • group_id (string_types, required) – Id of the group

  • invitation_id (string_types, required) – Id of the invitation.

Returns

Invitation details

Return type

Invitation

list(organization_id: string_types, group_id: string_types, query_params: InvitationListQueryParams = None, **kwargs: dict) → Invitation[source]

List Invitations

Parameters

  • organization_id (string_types, required) – Id of the organization

  • group_id (string_types, required) – Id of the group

  • query_params (InvitationListQueryParams) – Query parameters

Returns

List of invitations

Return type

Invitation

Module contents