Class GreenhouseApi


  • public class GreenhouseApi
    extends Api
    GreenhouseApi is a class that handles all requests to the Greenhouse API.
    • Constructor Summary

      Constructors 
      Constructor Description
      GreenhouseApi​(java.lang.String userToken, java.lang.String proxyURL)
      Constructor for GreenhouseApi.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Greenhouse registerGreenhouse​(java.lang.String name, java.lang.String description)
      Register a new greenhouse inside the Greenhouse API.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GreenhouseApi

        public GreenhouseApi​(java.lang.String userToken,
                             java.lang.String proxyURL)
        Constructor for GreenhouseApi.
        Parameters:
        userToken - The access token needed to access the Greenhouse API.
        proxyURL - The URL of the proxy server.
    • Method Detail

      • registerGreenhouse

        public Greenhouse registerGreenhouse​(java.lang.String name,
                                             java.lang.String description)
                                      throws ProxyRequestFailException
        Register a new greenhouse inside the Greenhouse API.
        Parameters:
        name - The name of the greenhouse.
        description - The description of the greenhouse.
        Returns:
        The greenhouse that was registered as a Greenhouse object.
        Throws:
        ProxyRequestFailException - If the request to the Greenhouse API fails.