com.softlayer.api.service.account.ProofOfConcept 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;

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.proofofconcept.Review;
import com.softlayer.api.service.container.account.proofofconcept.request.AccountFunded;
import com.softlayer.api.service.container.account.proofofconcept.request.GlobalFunded;
import com.softlayer.api.service.container.account.proofofconcept.review.Summary;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Approved IBM sales representatives can use this service to request and manage temporary access on behalf of clients. This access is subject to multiple layers of approval and requires payment arrangement in advance. 

 * 

 * This service is unavailable to users outside of IBM and is not applicable to the majority of users. 
 *
 * @see SoftLayer_Account_ProofOfConcept
 */
@ApiType("SoftLayer_Account_ProofOfConcept")
public class ProofOfConcept extends Entity {

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

    /**
     * Approved IBM sales representatives can use this service to request and manage temporary access on behalf of clients. This access is subject to multiple layers of approval and requires payment arrangement in advance. 

     * 

     * This service is unavailable to users outside of IBM and is not applicable to the majority of users. 
     *
     * @see SoftLayer_Account_ProofOfConcept
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Account_ProofOfConcept")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Allows a verified reviewer to approve a request 
         *
         * @see SoftLayer_Account_ProofOfConcept::approveReview
         */
        @ApiMethod
        public Void approveReview(Long requestId, String accessToken);

        /**
         * Allows verified reviewer to deny a request 
         *
         * @see SoftLayer_Account_ProofOfConcept::denyReview
         */
        @ApiMethod
        public Void denyReview(Long requestId, String accessToken, String reason);

        /**
         * Returns URL used to authenticate reviewers 
         *
         * @see SoftLayer_Account_ProofOfConcept::getAuthenticationUrl
         */
        @ApiMethod
        public String getAuthenticationUrl(String targetPage);

        /**
         * Retrieves a list of requests that are pending review in the specified regions 
         *
         * @see SoftLayer_Account_ProofOfConcept::getRequestsPendingIntegratedOfferingTeamReview
         */
        @ApiMethod
        public List getRequestsPendingIntegratedOfferingTeamReview(String accessToken);

        /**
         * Retrieves a list of requests that are pending over threshold review 
         *
         * @see SoftLayer_Account_ProofOfConcept::getRequestsPendingOverThresholdReview
         */
        @ApiMethod
        public List getRequestsPendingOverThresholdReview(String accessToken);

        /**
         * Exchanges a code for a token during reviewer validation. 
         *
         * @see SoftLayer_Account_ProofOfConcept::getReviewerAccessToken
         */
        @ApiMethod
        public String getReviewerAccessToken(String unverifiedAuthenticationCode);

        /**
         * Finds a reviewer's email using the access token 
         *
         * @see SoftLayer_Account_ProofOfConcept::getReviewerEmailFromAccessToken
         */
        @ApiMethod
        public String getReviewerEmailFromAccessToken(String accessToken);

        /**
         * Allows authorized IBMer to pull all the details of a single proof of concept account request. 
         *
         * @see SoftLayer_Account_ProofOfConcept::getSubmittedRequest
         */
        @ApiMethod
        public Review getSubmittedRequest(Long requestId);

        /**
         * Allows authorized IBMer to retrieve a list summarizing all previously submitted proof of concept requests. 

         * 

         * Note that the proof of concept system is for internal IBM employees only and is not applicable to users outside the IBM organization. 
         *
         * @see SoftLayer_Account_ProofOfConcept::getSubmittedRequests
         */
        @ApiMethod
        public List getSubmittedRequests(String email, String sortOrder);

        /**
         * Gets email address users can use to ask for help/support 
         *
         * @see SoftLayer_Account_ProofOfConcept::getSupportEmailAddress
         */
        @ApiMethod
        public String getSupportEmailAddress();

        /**
         * @see SoftLayer_Account_ProofOfConcept::getTotalRequestsPendingIntegratedOfferingTeamReview
         */
        @ApiMethod
        public Long getTotalRequestsPendingIntegratedOfferingTeamReview(String accessToken);

        /**
         * @see SoftLayer_Account_ProofOfConcept::getTotalRequestsPendingOverThresholdReviewCount
         */
        @ApiMethod
        public Long getTotalRequestsPendingOverThresholdReviewCount();

        /**
         * Determines if the user is one of the reviewers currently able to act 
         *
         * @see SoftLayer_Account_ProofOfConcept::isCurrentReviewer
         */
        @ApiMethod
        public Boolean isCurrentReviewer(Long requestId, String accessToken);

        /**
         * Indicates whether or not a reviewer belongs to the integrated offering team 
         *
         * @see SoftLayer_Account_ProofOfConcept::isIntegratedOfferingTeamReviewer
         */
        @ApiMethod
        public Boolean isIntegratedOfferingTeamReviewer(String emailAddress);

        /**
         * Indicates whether or not a reviewer belongs to the threshold team. 
         *
         * @see SoftLayer_Account_ProofOfConcept::isOverThresholdReviewer
         */
        @ApiMethod
        public Boolean isOverThresholdReviewer(String emailAddress);

        /**
         * Allows authorized IBMer's to apply for a proof of concept account using account team funding. Requests will be reviewed by multiple internal teams before an account is created. 

         * 

         * Note that the proof of concept system is for internal IBM employees only and is not applicable to users outside the IBM organization. 
         *
         * @see SoftLayer_Account_ProofOfConcept::requestAccountTeamFundedAccount
         */
        @ApiMethod
        public Summary requestAccountTeamFundedAccount(AccountFunded request);

        /**
         * Allows authorized IBMer's to apply for a proof of concept account using global funding. Requests will be reviewed by multiple internal teams before an account is created. 

         * 

         * Note that the proof of concept system is for internal IBM employees only and is not applicable to users outside the IBM organization. 
         *
         * @see SoftLayer_Account_ProofOfConcept::requestGlobalFundedAccount
         */
        @ApiMethod
        public Summary requestGlobalFundedAccount(GlobalFunded request);

        /**
         * Verifies that a potential reviewer is an approved internal IBM employee 
         *
         * @see SoftLayer_Account_ProofOfConcept::verifyReviewer
         */
        @ApiMethod
        public Void verifyReviewer(Long requestId, String reviewerEmailAddress);

    }

    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#approveReview}
         */
        public Future approveReview(Long requestId, String accessToken);

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

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

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

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

        public Future getAuthenticationUrl(String targetPage, ResponseHandler callback);

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

        public Future getRequestsPendingIntegratedOfferingTeamReview(String accessToken, ResponseHandler> callback);

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

        public Future getRequestsPendingOverThresholdReview(String accessToken, ResponseHandler> callback);

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

        public Future getReviewerAccessToken(String unverifiedAuthenticationCode, ResponseHandler callback);

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

        public Future getReviewerEmailFromAccessToken(String accessToken, ResponseHandler callback);

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

        public Future getSubmittedRequest(Long requestId, ResponseHandler callback);

        /**
         * Async version of {@link Service#getSubmittedRequests}
         */
        public Future> getSubmittedRequests(String email, String sortOrder);

        public Future getSubmittedRequests(String email, String sortOrder, ResponseHandler> callback);

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

        public Future getSupportEmailAddress(ResponseHandler callback);

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

        public Future getTotalRequestsPendingIntegratedOfferingTeamReview(String accessToken, ResponseHandler callback);

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

        public Future getTotalRequestsPendingOverThresholdReviewCount(ResponseHandler callback);

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

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

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

        public Future isIntegratedOfferingTeamReviewer(String emailAddress, ResponseHandler callback);

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

        public Future isOverThresholdReviewer(String emailAddress, ResponseHandler callback);

        /**
         * Async version of {@link Service#requestAccountTeamFundedAccount}
         */
        public Future requestAccountTeamFundedAccount(AccountFunded request);

        public Future requestAccountTeamFundedAccount(AccountFunded request, ResponseHandler callback);

        /**
         * Async version of {@link Service#requestGlobalFundedAccount}
         */
        public Future requestGlobalFundedAccount(GlobalFunded request);

        public Future requestGlobalFundedAccount(GlobalFunded request, ResponseHandler callback);

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

        public Future verifyReviewer(Long requestId, String reviewerEmailAddress, ResponseHandler callback);

    }

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

    }

}