class AsposeEmailCloud::CalendarApi
CalendarApi
operations.
Attributes
Public Class Methods
Initializes a new instance of the CalendarApi
class. @param [ApiInvoker] api_invoker
# File lib/aspose-email-cloud/api/calendar_api.rb, line 45 def initialize(api_invoker) @api_invoker = api_invoker end
Public Instance Methods
Convert iCalendar to AlternateView
@param [CalendarAsAlternateRequest] request iCalendar to AlternateView
request @return [AlternateView]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 52 def as_alternate(request) # verify the required parameter 'request' is set if @api_invoker.api_client.config.client_side_validation && request.nil? raise ArgumentError, "Missing the required parameter 'request' when calling CalendarApi.as_alternate" end local_var_path = '/email/Calendar/as-alternate' post_body = @api_invoker.api_client.object_to_http_body(request) auth_names = ['JWT'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = EmailRequest.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = EmailRequest.select_header_content_type(['application/json']) http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path, header_params: header_params, body: post_body, auth_names: auth_names) @api_invoker.make_request(http_request, :PUT, 'AlternateView') end
Converts calendar model to specified format and returns as file.
@param [CalendarAsFileRequest] request Calendar model and format to convert. @return [File]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 79 def as_file(request) # verify the required parameter 'request' is set if @api_invoker.api_client.config.client_side_validation && request.nil? raise ArgumentError, "Missing the required parameter 'request' when calling CalendarApi.as_file" end local_var_path = '/email/Calendar/as-file' post_body = @api_invoker.api_client.object_to_http_body(request) auth_names = ['JWT'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = EmailRequest.select_header_accept(['multipart/form-data']) # HTTP header 'Content-Type' header_params['Content-Type'] = EmailRequest.select_header_content_type(['application/json']) http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path, header_params: header_params, body: post_body, auth_names: auth_names) @api_invoker.make_request(http_request, :PUT, 'File') end
Converts CalendarDto
to MapiCalendarDto
.
@param [CalendarDto] calendar_dto iCalendar model calendar representation. @return [MapiCalendarDto]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 106 def as_mapi(calendar_dto) # verify the required parameter 'calendar_dto' is set if @api_invoker.api_client.config.client_side_validation && calendar_dto.nil? raise ArgumentError, "Missing the required parameter 'calendar_dto' when calling CalendarApi.as_mapi" end local_var_path = '/email/Calendar/as-mapi' post_body = @api_invoker.api_client.object_to_http_body(calendar_dto) auth_names = ['JWT'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = EmailRequest.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = EmailRequest.select_header_content_type(['application/json']) http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path, header_params: header_params, body: post_body, auth_names: auth_names) @api_invoker.make_request(http_request, :PUT, 'MapiCalendarDto') end
Converts calendar document to specified format and returns as file.
@param [CalendarConvertRequest] request Request object. @return [File]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 133 def convert(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :PUT, 'File') end
Converts calendar document to a model representation.
@param [CalendarFromFileRequest] request Request object. @return [CalendarDto]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 141 def from_file(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :PUT, 'CalendarDto') end
Get calendar file from storage.
@param [CalendarGetRequest] request Request object. @return [CalendarDto]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 149 def get(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :GET, 'CalendarDto') end
Get iCalendar from storage as AlternateView
@param [CalendarGetAsAlternateRequest] request Request object. @return [AlternateView]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 157 def get_as_alternate(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :GET, 'AlternateView') end
Converts calendar document from storage to specified format and returns as file.
@param [CalendarGetAsFileRequest] request Request object. @return [File]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 165 def get_as_file(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :GET, 'File') end
Get iCalendar list from storage folder.
@param [CalendarGetListRequest] request Request object. @return [CalendarStorageList]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 173 def get_list(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :GET, 'CalendarStorageList') end
Save iCalendar
@param [CalendarSaveRequest] request iCalendar create/update request @return [nil]
# File lib/aspose-email-cloud/api/calendar_api.rb, line 181 def save(request) # verify the required parameter 'request' is set if @api_invoker.api_client.config.client_side_validation && request.nil? raise ArgumentError, "Missing the required parameter 'request' when calling CalendarApi.save" end local_var_path = '/email/Calendar' post_body = @api_invoker.api_client.object_to_http_body(request) auth_names = ['JWT'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = EmailRequest.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = EmailRequest.select_header_content_type(['application/json']) http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path, header_params: header_params, body: post_body, auth_names: auth_names) @api_invoker.make_request(http_request, :PUT, nil) nil end