com.softlayer.api.service.account.internal.Ibm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
The newest version!
package com.softlayer.api.service.account.internal;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.account.internal.ibm.Request;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Processes requests by IBM employees to create an IaaS account tied to their email. Request process cannot be initiated directly and must go through the Bluemix IBMer account request form. 
 *
 * @see SoftLayer_Account_Internal_Ibm
 */
@ApiType("SoftLayer_Account_Internal_Ibm")
public class Ibm extends Entity {

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    /**
     * Processes requests by IBM employees to create an IaaS account tied to their email. Request process cannot be initiated directly and must go through the Bluemix IBMer account request form. 
     *
     * @see SoftLayer_Account_Internal_Ibm
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Account_Internal_Ibm")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Validates request and, if the request is approved, returns a list of allowed uses for an automatically created IBMer IaaS account. 
         *
         * @see SoftLayer_Account_Internal_Ibm::getAccountTypes
         */
        @ApiMethod
        public List getAccountTypes();

        /**
         * Gets the URL used to perform manager validation. 
         *
         * @see SoftLayer_Account_Internal_Ibm::getAuthorizationUrl
         */
        @ApiMethod
        public String getAuthorizationUrl(Long requestId);

        /**
         * @see SoftLayer_Account_Internal_Ibm::getBmsCountryList
         */
        @ApiMethod
        public List getBmsCountryList();

        /**
         * Exchanges a code for a token during manager validation. 
         *
         * @see SoftLayer_Account_Internal_Ibm::getEmployeeAccessToken
         */
        @ApiMethod
        public String getEmployeeAccessToken(String unverifiedAuthenticationCode);

        /**
         * After validating the requesting user through the access token, generates a container with the relevant request information and returns it. 
         *
         * @see SoftLayer_Account_Internal_Ibm::getManagerPreview
         */
        @ApiMethod
        public Request getManagerPreview(Long requestId, String accessToken);

        /**
         * Checks for an existing request which would block an IBMer from submitting a new request. Such a request could be denied, approved, or awaiting manager action. 
         *
         * @see SoftLayer_Account_Internal_Ibm::hasExistingRequest
         */
        @ApiMethod
        public Boolean hasExistingRequest(String employeeUid, String managerUid);

        /**
         * Applies manager approval to a pending internal IBM account request. If cost recovery is already configured, this will create an account. If not, this will remind the internal team to configure cost recovery and create the account when possible. 
         *
         * @see SoftLayer_Account_Internal_Ibm::managerApprove
         */
        @ApiMethod
        public Void managerApprove(Long requestId, String accessToken);

        /**
         * Denies a pending request and prevents additional requests from the same applicant for as long as the manager remains the same. 
         *
         * @see SoftLayer_Account_Internal_Ibm::managerDeny
         */
        @ApiMethod
        public Void managerDeny(Long requestId, String accessToken);

        /**
         * Validates request and kicks off the approval process. 
         *
         * @see SoftLayer_Account_Internal_Ibm::requestAccount
         */
        @ApiMethod
        public Void requestAccount(Request requestContainer);

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getAccountTypes}
         */
        public Future> getAccountTypes();

        public Future getAccountTypes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAuthorizationUrl}
         */
        public Future getAuthorizationUrl(Long requestId);

        public Future getAuthorizationUrl(Long requestId, ResponseHandler callback);

        /**
         * Async version of {@link Service#getBmsCountryList}
         */
        public Future> getBmsCountryList();

        public Future getBmsCountryList(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getEmployeeAccessToken}
         */
        public Future getEmployeeAccessToken(String unverifiedAuthenticationCode);

        public Future getEmployeeAccessToken(String unverifiedAuthenticationCode, ResponseHandler callback);

        /**
         * Async version of {@link Service#getManagerPreview}
         */
        public Future getManagerPreview(Long requestId, String accessToken);

        public Future getManagerPreview(Long requestId, String accessToken, ResponseHandler callback);

        /**
         * Async version of {@link Service#hasExistingRequest}
         */
        public Future hasExistingRequest(String employeeUid, String managerUid);

        public Future hasExistingRequest(String employeeUid, String managerUid, ResponseHandler callback);

        /**
         * Async version of {@link Service#managerApprove}
         */
        public Future managerApprove(Long requestId, String accessToken);

        public Future managerApprove(Long requestId, String accessToken, ResponseHandler callback);

        /**
         * Async version of {@link Service#managerDeny}
         */
        public Future managerDeny(Long requestId, String accessToken);

        public Future managerDeny(Long requestId, String accessToken, ResponseHandler callback);

        /**
         * Async version of {@link Service#requestAccount}
         */
        public Future requestAccount(Request requestContainer);

        public Future requestAccount(Request requestContainer, ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

    }

}