Class OrganizationsClient

java.lang.Object

com.ants.platform.client.resources.organizations.OrganizationsClient

public class OrganizationsClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
OrganizationsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
MembershipsResponse	getOrganizationMemberships()	Get all memberships for the organization associated with the API key (requires organization-scoped API key)
MembershipsResponse	getOrganizationMemberships(RequestOptions requestOptions)	Get all memberships for the organization associated with the API key (requires organization-scoped API key)
OrganizationProjectsResponse	getOrganizationProjects()	Get all projects for the organization associated with the API key (requires organization-scoped API key)
OrganizationProjectsResponse	getOrganizationProjects(RequestOptions requestOptions)	Get all projects for the organization associated with the API key (requires organization-scoped API key)
MembershipsResponse	getProjectMemberships(String projectId)	Get all memberships for a specific project (requires organization-scoped API key)
MembershipsResponse	getProjectMemberships(String projectId, RequestOptions requestOptions)	Get all memberships for a specific project (requires organization-scoped API key)
MembershipResponse	updateOrganizationMembership(MembershipRequest request)	Create or update a membership for the organization associated with the API key (requires organization-scoped API key)
MembershipResponse	updateOrganizationMembership(MembershipRequest request, RequestOptions requestOptions)	Create or update a membership for the organization associated with the API key (requires organization-scoped API key)
MembershipResponse	updateProjectMembership(String projectId, MembershipRequest request)	Create or update a membership for a specific project (requires organization-scoped API key).
MembershipResponse	updateProjectMembership(String projectId, MembershipRequest request, RequestOptions requestOptions)	Create or update a membership for a specific project (requires organization-scoped API key).

Methods inherited from class Object

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

Field Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

OrganizationsClient

public OrganizationsClient(ClientOptions clientOptions)

Method Details

getOrganizationMemberships

public MembershipsResponse getOrganizationMemberships()

Get all memberships for the organization associated with the API key (requires organization-scoped API key)

getOrganizationMemberships

public MembershipsResponse getOrganizationMemberships(RequestOptions requestOptions)

Get all memberships for the organization associated with the API key (requires organization-scoped API key)

updateOrganizationMembership

public MembershipResponse updateOrganizationMembership(MembershipRequest request)

Create or update a membership for the organization associated with the API key (requires organization-scoped API key)

updateOrganizationMembership

public MembershipResponse updateOrganizationMembership(MembershipRequest request,
 RequestOptions requestOptions)

Create or update a membership for the organization associated with the API key (requires organization-scoped API key)

getProjectMemberships

public MembershipsResponse getProjectMemberships(String projectId)

Get all memberships for a specific project (requires organization-scoped API key)

getProjectMemberships

public MembershipsResponse getProjectMemberships(String projectId,
 RequestOptions requestOptions)

Get all memberships for a specific project (requires organization-scoped API key)

updateProjectMembership

public MembershipResponse updateProjectMembership(String projectId,
 MembershipRequest request)

Create or update a membership for a specific project (requires organization-scoped API key). The user must already be a member of the organization.

updateProjectMembership

public MembershipResponse updateProjectMembership(String projectId,
 MembershipRequest request,
 RequestOptions requestOptions)

Create or update a membership for a specific project (requires organization-scoped API key). The user must already be a member of the organization.

getOrganizationProjects

public OrganizationProjectsResponse getOrganizationProjects()

Get all projects for the organization associated with the API key (requires organization-scoped API key)

getOrganizationProjects

public OrganizationProjectsResponse getOrganizationProjects(RequestOptions requestOptions)

Get all projects for the organization associated with the API key (requires organization-scoped API key)