com.softlayer.api.service.ticket.Survey 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
There is a newer version: 0.3.4
package com.softlayer.api.service.ticket;

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.ticket.survey.Preference;
import java.util.concurrent.Future;

/**
 * @see SoftLayer_Ticket_Survey
 */
@ApiType("SoftLayer_Ticket_Survey")
public class Survey extends Entity {

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

    /**
     * @see SoftLayer_Ticket_Survey
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Ticket_Survey")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Use this method to retrieve the ticket survey preferences. It will return your [[SoftLayer_Container_Ticket_Survey_Preference|survey preference]] which indicates if your account is applicable to receive a survey and if you're opted in. You can control the survey opt via the [[SoftLayer_Ticket_Survey::optIn|opt-in]] or [[SoftLayer_Ticket_Survey::optOut|opt-out]] method. 
         *
         * @see SoftLayer_Ticket_Survey::getPreference
         */
        @ApiMethod
        public Preference getPreference();

        /**
         * You will not receive a ticket survey if you are opted out. Use this method to opt back in if you wish to provide feedback to our support team. You may use the [[SoftLayer_Ticket_Survey::getPreference|getPreference]] method to check your current opt status. 

         * 

         * This method is depricated. Use [[SoftLayer_User_Customer::changePreference]] instead. 
         *
         * @see SoftLayer_Ticket_Survey::optIn
         */
        @ApiMethod
        public Preference optIn();

        /**
         * By default, customers will occasionally receive a ticket survey upon closing of a ticket. Use this method to opt out of it for the next 90 days. Ticket surveys may not be applicable for some customers. Use the [[SoftLayer_Ticket_Survey::getPreference|getPreference]] method to retrieve your survey preference. The "applicable" property of the [[SoftLayer_Container_Ticket_Survey_Preference|survey preference]] indicates if the survey is relevant to your account or not. 

         * 

         * This method is depricated. Use [[SoftLayer_User_Customer::changePreference]] instead. 
         *
         * @see SoftLayer_Ticket_Survey::optOut
         */
        @ApiMethod
        public Preference optOut();

    }

    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#getPreference}
         */
        public Future getPreference();

        public Future getPreference(ResponseHandler callback);

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

        public Future optIn(ResponseHandler callback);

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

        public Future optOut(ResponseHandler callback);

    }

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

    }

}