Package software.xdev.sched.api

Class SessionApi

java.lang.Object

software.xdev.sched.api.SessionApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SessionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SessionApi()
SessionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
String	addSession(String sessionKey, String name, String sessionStart, String sessionEnd, String sessionType, String sessionSubtype, String description, URI mediaUrl, String venue, String address, String tags, String seats, URI rsvpUrl, String ticketMessage, String active, Object customFields)
String	addSession(String sessionKey, String name, String sessionStart, String sessionEnd, String sessionType, String sessionSubtype, String description, URI mediaUrl, String venue, String address, String tags, String seats, URI rsvpUrl, String ticketMessage, String active, Object customFields, Map<String,String> additionalHeaders)
String	deleteSession(String sessionKey)
String	deleteSession(String sessionKey, Map<String,String> additionalHeaders)
List<ExportSession>	exportSessions(Integer since, String format, String fields, Integer page, Integer limit, String stripHtml, String customData)
List<ExportSession>	exportSessions(Integer since, String format, String fields, Integer page, Integer limit, String stripHtml, String customData, Map<String,String> additionalHeaders)
ApiClient	getApiClient()
List<Session>	listSessions(Integer since, String format, String status, String customData)
List<Session>	listSessions(Integer since, String format, String status, String customData, Map<String,String> additionalHeaders)
String	modifySession(String sessionKey, String name, String sessionStart, String sessionEnd, String sessionType, String sessionSubtype, String description, URI mediaUrl, String venue, String address, String tags, String seats, URI rsvpUrl, String ticketMessage, String active)
String	modifySession(String sessionKey, String name, String sessionStart, String sessionEnd, String sessionType, String sessionSubtype, String description, URI mediaUrl, String venue, String address, String tags, String seats, URI rsvpUrl, String ticketMessage, String active, Map<String,String> additionalHeaders)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SessionApi

public SessionApi()

SessionApi

public SessionApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addSession

public String addSession(String sessionKey,
 String name,
 String sessionStart,
 String sessionEnd,
 String sessionType,
 String sessionSubtype,
 String description,
 URI mediaUrl,
 String venue,
 String address,
 String tags,
 String seats,
 URI rsvpUrl,
 String ticketMessage,
 String active,
 Object customFields)
                  throws ApiException

Parameters:

sessionKey - Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. (required)

name - (required)

sessionStart - Full date + time for start of session Format: YYYY-MM-DD HH:MM (required)

sessionEnd - Full date + time for end of session Format: YYYY-MM-DD HH:MM (required)

sessionType - Used to filter sessions (required)

sessionSubtype - For additional filter/organizing sessions (optional)

description - Detailed description of the session. Links (HTML Tag \\<a>) allowed. Max Size: 8kb (optional)

mediaUrl - URL for media: audio/video/documents. Must use HTTPS. (optional)

venue - Building name / Company name etc. (optional)

address - Room # / Street Address (optional)

tags - Comma-separated words and phrases (optional)

seats - Venue capacity - number of available seats (optional)

rsvpUrl - URL used for Custom Button (optional)

ticketMessage - Custom ticket upgrade message, displayed when attendee attempts to add the session without the correct ticket (accepts basic HTML) (optional)

active - Y = session is active, N = session is deactivated and hidden (optional)

customFields - To add custom named fields, just add your field names and their values (optional)

Returns:

String

Throws:

ApiException - if fails to make API call

addSession

public String addSession(String sessionKey,
 String name,
 String sessionStart,
 String sessionEnd,
 String sessionType,
 String sessionSubtype,
 String description,
 URI mediaUrl,
 String venue,
 String address,
 String tags,
 String seats,
 URI rsvpUrl,
 String ticketMessage,
 String active,
 Object customFields,
 Map<String,String> additionalHeaders)
                  throws ApiException

Parameters:

sessionKey - Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. (required)

name - (required)

sessionStart - Full date + time for start of session Format: YYYY-MM-DD HH:MM (required)

sessionEnd - Full date + time for end of session Format: YYYY-MM-DD HH:MM (required)

sessionType - Used to filter sessions (required)

sessionSubtype - For additional filter/organizing sessions (optional)

description - Detailed description of the session. Links (HTML Tag \\<a>) allowed. Max Size: 8kb (optional)

mediaUrl - URL for media: audio/video/documents. Must use HTTPS. (optional)

venue - Building name / Company name etc. (optional)

address - Room # / Street Address (optional)

tags - Comma-separated words and phrases (optional)

seats - Venue capacity - number of available seats (optional)

rsvpUrl - URL used for Custom Button (optional)

ticketMessage - Custom ticket upgrade message, displayed when attendee attempts to add the session without the correct ticket (accepts basic HTML) (optional)

active - Y = session is active, N = session is deactivated and hidden (optional)

customFields - To add custom named fields, just add your field names and their values (optional)

additionalHeaders - additionalHeaders for this call

Returns:

String

Throws:

ApiException - if fails to make API call

deleteSession

public String deleteSession(String sessionKey)
                     throws ApiException

Parameters:

sessionKey - Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. (required)

Returns:

String

Throws:

ApiException - if fails to make API call

deleteSession

public String deleteSession(String sessionKey,
 Map<String,String> additionalHeaders)
                     throws ApiException

Parameters:

sessionKey - Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. (required)

additionalHeaders - additionalHeaders for this call

Returns:

String

Throws:

ApiException - if fails to make API call

exportSessions

public List<ExportSession> exportSessions(Integer since,
 String format,
 String fields,
 Integer page,
 Integer limit,
 String stripHtml,
 String customData)
                                   throws ApiException

Parameters:

since - Retrieve sessions modified since timestamp (Unix epoch time) (optional)

format - One of \"csv\", \"xml\", \"json\", \"xls\" (returns xlsx-File). Defaults to \"csv\" (optional)

fields - Comma separated list of fields wanted. Select the order of needed fields by listing them here. Leave blank to get all available fields. (optional)

page - To page results, provide a page number. Omit to get all sessions (optional)

limit - Number of sessions per page. Defaults to 1000 (optional)

stripHtml - Remove HTML tags from description. Include this parameter with value \"Y\" (optional)

customData - Include this parameter with value \"Y\" if you have custom added fields. Note that spaces in field name will be replaced by underscores. (optional)

Returns:

List<ExportSession>

Throws:

ApiException - if fails to make API call

exportSessions

public List<ExportSession> exportSessions(Integer since,
 String format,
 String fields,
 Integer page,
 Integer limit,
 String stripHtml,
 String customData,
 Map<String,String> additionalHeaders)
                                   throws ApiException

Parameters:

since - Retrieve sessions modified since timestamp (Unix epoch time) (optional)

format - One of \"csv\", \"xml\", \"json\", \"xls\" (returns xlsx-File). Defaults to \"csv\" (optional)

fields - Comma separated list of fields wanted. Select the order of needed fields by listing them here. Leave blank to get all available fields. (optional)

page - To page results, provide a page number. Omit to get all sessions (optional)

limit - Number of sessions per page. Defaults to 1000 (optional)

stripHtml - Remove HTML tags from description. Include this parameter with value \"Y\" (optional)

customData - Include this parameter with value \"Y\" if you have custom added fields. Note that spaces in field name will be replaced by underscores. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<ExportSession>

Throws:

ApiException - if fails to make API call

listSessions

public List<Session> listSessions(Integer since,
 String format,
 String status,
 String customData)
                           throws ApiException

Parameters:

since - Retrieve sessions modified since timestamp (Unix epoch time) (optional)

format - (optional, default to json)

status - Set to \"del\" to fetch only references to deleted sessions (optional)

customData - Include this parameter with value \"Y\" if you have custom added fields. Note that spaces in field name will be replaced by underscores. (optional)

Returns:

List<Session>

Throws:

ApiException - if fails to make API call

listSessions

public List<Session> listSessions(Integer since,
 String format,
 String status,
 String customData,
 Map<String,String> additionalHeaders)
                           throws ApiException

Parameters:

since - Retrieve sessions modified since timestamp (Unix epoch time) (optional)

format - (optional, default to json)

status - Set to \"del\" to fetch only references to deleted sessions (optional)

customData - Include this parameter with value \"Y\" if you have custom added fields. Note that spaces in field name will be replaced by underscores. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<Session>

Throws:

ApiException - if fails to make API call

modifySession

public String modifySession(String sessionKey,
 String name,
 String sessionStart,
 String sessionEnd,
 String sessionType,
 String sessionSubtype,
 String description,
 URI mediaUrl,
 String venue,
 String address,
 String tags,
 String seats,
 URI rsvpUrl,
 String ticketMessage,
 String active)
                     throws ApiException

Parameters:

sessionKey - Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. (required)

name - (optional)

sessionStart - Full date + time for start of session Format: YYYY-MM-DD HH:MM (optional)

sessionEnd - Full date + time for end of session Format: YYYY-MM-DD HH:MM (optional)

sessionType - Used to filter sessions (optional)

sessionSubtype - For additional filter/organizing sessions (optional)

description - Detailed description of the session. Links (HTML Tag \\<a>) allowed. Max Size: 8kb (optional)

mediaUrl - URL for media: audio/video/documents. Must use HTTPS. (optional)

venue - Building name / Company name etc. (optional)

address - Room # / Street Address (optional)

tags - Comma-separated words and phrases (optional)

seats - Venue capacity - number of available seats (optional)

rsvpUrl - URL used for Custom Button (optional)

ticketMessage - Custom ticket upgrade message, displayed when attendee attempts to add the session without the correct ticket (accepts basic HTML) (optional)

active - Y = session is active, N = session is deactivated and hidden (optional)

Returns:

String

Throws:

ApiException - if fails to make API call

modifySession

public String modifySession(String sessionKey,
 String name,
 String sessionStart,
 String sessionEnd,
 String sessionType,
 String sessionSubtype,
 String description,
 URI mediaUrl,
 String venue,
 String address,
 String tags,
 String seats,
 URI rsvpUrl,
 String ticketMessage,
 String active,
 Map<String,String> additionalHeaders)
                     throws ApiException

Parameters:

sessionKey - Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. (required)

name - (optional)

sessionStart - Full date + time for start of session Format: YYYY-MM-DD HH:MM (optional)

sessionEnd - Full date + time for end of session Format: YYYY-MM-DD HH:MM (optional)

sessionType - Used to filter sessions (optional)

sessionSubtype - For additional filter/organizing sessions (optional)

description - Detailed description of the session. Links (HTML Tag \\<a>) allowed. Max Size: 8kb (optional)

mediaUrl - URL for media: audio/video/documents. Must use HTTPS. (optional)

venue - Building name / Company name etc. (optional)

address - Room # / Street Address (optional)

tags - Comma-separated words and phrases (optional)

seats - Venue capacity - number of available seats (optional)

rsvpUrl - URL used for Custom Button (optional)

ticketMessage - Custom ticket upgrade message, displayed when attendee attempts to add the session without the correct ticket (accepts basic HTML) (optional)

active - Y = session is active, N = session is deactivated and hidden (optional)

additionalHeaders - additionalHeaders for this call

Returns:

String

Throws:

ApiException - if fails to make API call