com.ringcentral.paths.webinar.registration.v1.sessions.registrants.Index Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ringcentral Show documentation
RingCentral Java SDK
There is a newer version: 3.2.1
package com.ringcentral.paths.webinar.registration.v1.sessions.registrants;

import com.ringcentral.*;
import com.ringcentral.definitions.*;

public class Index {
    public RestClient rc;
    public com.ringcentral.paths.webinar.registration.v1.sessions.Index parent;
    public String registrantId;

    public Index(com.ringcentral.paths.webinar.registration.v1.sessions.Index parent, String registrantId) {
        this.parent = parent;
        this.rc = parent.rc;
        this.registrantId = registrantId;
    }

    public String path(Boolean withParameter) {
        if (withParameter && registrantId != null) {
            return parent.path() + "/registrants/" + registrantId;
        }
        return parent.path() + "/registrants";
    }

    public String path() {
        return path(true);
    }

    /**
     * Returns the list of Registrants ordered by "id" ascending.
     * 
     * A caller must be an authorized user: either a host of the webinar or an IT Admin:
     * a user from host's account with "WebinarSettings" permission.
     * 

     * HTTP Method: get
     * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants
     * Rate Limit Group: Heavy
     * App Permission: ReadWebinars
     */
    public RegistrantListResource list(RcwRegListRegistrantsParameters queryParams) throws com.ringcentral.RestException, java.io.IOException {
        okhttp3.ResponseBody rb = this.rc.get(this.path(false), queryParams);
        return com.ringcentral.Utils.gson.fromJson(rb.string(), RegistrantListResource.class);
    }

    public RegistrantListResource list() throws com.ringcentral.RestException, java.io.IOException {
        return this.list(null);
    }

    /**
     * Creates a new Registrant for a given session.
     * 

     * Registration MUST be open for the session for this call to succeed (otherwise it should return HTTP 403).
     * 

     * A caller must be an authorized user: either a host of the webinar or an IT Admin:
     * a user from host's account with "WebinarSettings" permission.
     * 

     * HTTP Method: post
     * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants
     * Rate Limit Group: Heavy
     * App Permission: EditWebinars
     */
    public RegistrantModelResponsePost post(RegistrantBaseModel registrantBaseModel) throws com.ringcentral.RestException, java.io.IOException {
        okhttp3.ResponseBody rb = this.rc.post(this.path(false), registrantBaseModel, null);
        return com.ringcentral.Utils.gson.fromJson(rb.string(), RegistrantModelResponsePost.class);
    }

    /**
     * Returns a Registrant by ID.
     * 

     * A caller must be an authorized user: either a host of the webinar or an IT Admin:
     * a user from host's account with "WebinarSettings" permission.
     * 

     * HTTP Method: get
     * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}
     * Rate Limit Group: Heavy
     * App Permission: ReadWebinars
     */
    public RegistrantModel get(RcwRegGetRegistrantParameters queryParams) throws com.ringcentral.RestException, java.io.IOException {
        if (registrantId == null) {
            throw new IllegalArgumentException("Parameter registrantId cannot be null");
        }
        okhttp3.ResponseBody rb = this.rc.get(this.path(), queryParams);
        return com.ringcentral.Utils.gson.fromJson(rb.string(), RegistrantModel.class);
    }

    public RegistrantModel get() throws com.ringcentral.RestException, java.io.IOException {
        return this.get(null);
    }

    /**
     * Deletes a Registrant by ID.
     * 

     * Session must not be in finished state (otherwise it should return HTTP 403).
     * 

     * A caller must be an authorized user: either a host of the webinar or an IT Admin:
     * a user from host's account with "WebinarSettings" permission.
     * 
     * HTTP Method: delete
     * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}
     * Rate Limit Group: Heavy
     * App Permission: EditWebinars
     */
    public String delete() throws com.ringcentral.RestException, java.io.IOException {
        if (registrantId == null) {
            throw new IllegalArgumentException("Parameter registrantId cannot be null");
        }
        okhttp3.ResponseBody rb = this.rc.delete(this.path(), null);
        return rb.string();
    }
}