com.bitmovin.api.sdk.account.organizations

Class OrganizationsApi

java.lang.Object

com.bitmovin.api.sdk.account.organizations.OrganizationsApi

public class OrganizationsApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
GroupsApi	groups
SubOrganizationsApi	subOrganizations

Constructor Summary

Constructors

Constructor and Description
OrganizationsApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<OrganizationsApi>	builder() Fluent builder for creating an instance of OrganizationsApi
Organization	create(Organization organization) Add Organization
Organization	get(String organizationId) Organization Details
PaginationResponse<Organization>	list() List Organizations
Organization	update(String organizationId, UpdateOrganizationRequest updateOrganizationRequest) Update Organization

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

subOrganizations

public final SubOrganizationsApi subOrganizations

groups

public final GroupsApi groups

Constructor Detail

OrganizationsApi

public OrganizationsApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<OrganizationsApi> builder()

Fluent builder for creating an instance of OrganizationsApi

create

public Organization create(Organization organization)
                    throws BitmovinException

Add Organization

Parameters:

organization - Orgnaization Details (required)

Returns:

Organization

Throws:

BitmovinException - if fails to make API call

get

public Organization get(String organizationId)
                 throws BitmovinException

Organization Details

Parameters:

organizationId - ID of the organization (required)

Returns:

Organization

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Organization> list()
                                      throws BitmovinException

List Organizations

Returns:

List<Organization>

Throws:

BitmovinException - if fails to make API call

update

public Organization update(String organizationId,
                           UpdateOrganizationRequest updateOrganizationRequest)
                    throws BitmovinException

Update Organization

Parameters:

organizationId - ID of the organization (required)

updateOrganizationRequest - Organization Details fields to be updated (required)

Returns:

Organization

Throws:

BitmovinException - if fails to make API call