com.podio.org.OrgAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
The official Java wrapper for the Podio API
The newest version!
package com.podio.org;

import java.util.Arrays;
import java.util.List;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;

import com.podio.BaseAPI;
import com.podio.ResourceFactory;
import com.podio.space.Space;
import com.sun.jersey.api.client.GenericType;

public class OrgAPI extends BaseAPI {

	public OrgAPI(ResourceFactory resourceFactory) {
		super(resourceFactory);
	}

	/**
	 * Creates a new organization
	 * 
	 * @param data
	 *            The data for the new organization
	 * @return The data for the newly created organization
	 */
	public OrganizationCreateResponse createOrganization(OrganizationCreate data) {
		return getResourceFactory().getApiResource("/org/")
				.entity(data, MediaType.APPLICATION_JSON_TYPE)
				.post(OrganizationCreateResponse.class);
	}

	/**
	 * Updates an organization with new name and logo. Note that the URL of the
	 * organization will not change even though the name changes.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param data
	 *            The new data
	 */
	public void updateOrganization(int orgId, OrganizationCreate data) {
		getResourceFactory().getApiResource("/org/" + orgId)
				.entity(data, MediaType.APPLICATION_JSON_TYPE).put();
	}

	/**
	 * Gets the organization with the given id.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @return The organization
	 */
	public Organization getOrganization(int orgId) {
		return getResourceFactory().getApiResource("/org/" + orgId).get(
				Organization.class);
	}

	/**
	 * Returns a list of all the organizations and spaces the user is member of.
	 * 
	 * @return The organizations the user is member of
	 */
	public List getOrganizations() {
		return Arrays.asList(getResourceFactory().getApiResource("/org/").get(
				OrganizationWithSpaces[].class));
	}

	/**
	 * Returns the organization with the given full URL. The URL does not have
	 * to be truncated to the root, it can be to any resource on the URL.
	 * 
	 * @param url
	 *            The URL to find the organization for
	 * @return The organization
	 */
	public OrganizationMini getOrganizationByURL(String url) {
		return getResourceFactory().getApiResource("/org/url")
				.queryParam("url", url).get(OrganizationMini.class);
	}

	/**
	 * Returns the organizations and spaces that the logged in user shares with
	 * the specified user. The organizations and spaces will be returned sorted
	 * by name.
	 * 
	 * @param userId
	 *            The id of the user
	 * @return The organizations with spaces that are shared with the user
	 */
	public List getSharedOrganizations(int userId) {
		return getResourceFactory().getApiResource("/org/shared/" + userId)
				.get(new GenericType>() {
				});
	}

	/**
	 * Return the space with the given URL on the space. To get the space
	 * related to http://company.podio.com/intranet, first lookup the
	 * organization on "company" and then the space using this function using
	 * the URL "intranet".
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param url
	 *            The url fragment for the space
	 * @return The matching space
	 */
	public Space getSpaceByURL(int orgId, String url) {
		return getResourceFactory().getApiResource(
				"/org/" + orgId + "/space/url/" + url).get(Space.class);
	}

	/**
	 * Returns all the spaces for the organization.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @return The spaces in the organization
	 */
	public List getSpaces(int orgId) {
		return getResourceFactory().getApiResource("/org/" + orgId + "/space/")
				.get(new GenericType>() {
				});
	}

	/**
	 * Returns the members, both invited and active, of the given organization.
	 * This method is only available for organization administrators. For users
	 * only invited, only very limited information will be returned for the user
	 * and profile.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @return The list of members on the organization with detailed information
	 */
	public List getMembers(int orgId) {
		return getResourceFactory()
				.getApiResource("/org/" + orgId + "/member/").get(
						new GenericType>() {
						});
	}
	
	/**
	 * Returns the members, both invited and active, of the given organization.
	 * This method is only available for organization administrators. For users
	 * only invited, only very limited information will be returned for the user
	 * and profile.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param offset
	 *            The offset into the user list
	 * @param limit
	 *            The number of results to return (max 500)
	 * @return The list of members on the organization with detailed information
	 */
	public List getMembers(int orgId, int offset, int limit) {
		return getResourceFactory()
				.getApiResource("/org/" + orgId + "/member/")
				.queryParam("offset", new Integer(offset).toString())
				.queryParam("limit", new Integer(limit).toString())
				.get(new GenericType>() { });
	}
	
	/**
	 * Returns the members, both invited and active, of the given organization.
	 * This method is only available for organization administrators. For users
	 * only invited, only very limited information will be returned for the user
	 * and profile.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param options
	 *            The parameters for get organization members
	 * @return The list of members on the organization with detailed information
	 */
	public List getMembers(int orgId, MultivaluedMap options) {
		return getResourceFactory()
				.getApiResource("/org/" + orgId + "/member/")
				.queryParams(options)
				.get(new GenericType>() { });
	}

	/**
	 * Returns the member data for the given user in the given organization.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param userId
	 *            The id of the user
	 * @return The details of the users membership of the organization
	 */
	public OrganizationMember getMember(int orgId, int userId) {
		return getResourceFactory().getApiResource(
				"/org/" + orgId + "/member/" + userId).get(
				OrganizationMember.class);
	}

	/**
	 * Returns the member data for the given user in the given organization.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param mail
	 *            The mail of the users account
	 * @return The details of the users membership of the organization
	 */
	public OrganizationMember getMemberByMail(int orgId, String mail) {
		return getResourceFactory().getApiResource(
				"/org/" + orgId + "/member/mail/" + mail).get(
				OrganizationMember.class);
	}
	
	/**
	 * Returns information about what would happen if this user would be removed from the org
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param userId
	 *            The id of the user
	 * @return The information about the users workspace memberships in the org
	 */
	public EndMemberInfo getEndMemberInfo(int orgId, int userId) {
		return getResourceFactory().getApiResource(
				"/org/" + orgId + "/member/" + userId + "/end_member_info").get(
						EndMemberInfo.class);		
	}

	/**
	 * Ends the users membership of all spaces in the organization. In
	 * workspaces in the organization where the user is the last admin, other
	 * users will be promoted to admins. Workspaces where the user is the only
	 * member will be deleted.
	 * 
	 * @param orgId
	 *            The id of the organization
	 * @param userId
	 *            The id of the user
	 */
	public void endMember(int orgId, int userId) {
		getResourceFactory().getApiResource(
				"/org/" + orgId + "/member/" + userId).delete();
	}
}