class AsposeEmailCloud::CalendarGetAsFileRequest

Request model for calendar_get_as_file operation.

Attributes

file_name[RW]

Calendar document file name. @return [String]

folder[RW]

Path to folder in storage. @return [String]

format[RW]

File format. Enum, available values: Ics, Msg @return [String]

storage[RW]

Storage name. @return [String]

Public Class Methods

new(file_name:, format:, storage: nil, folder: nil) click to toggle source

Converts calendar document from storage to specified format and returns as file.

@param [String] file_name Calendar document file name. @param [String] format File format. Enum, available values: Ics, Msg @param [String] storage Storage name. @param [String] folder Path to folder in storage.

# File lib/aspose-email-cloud/models/calendar_get_as_file_request.rb, line 50
def initialize(file_name:, format:, storage: nil, folder: nil)
  self.file_name = file_name if file_name
  self.format = format if format
  self.storage = storage if storage
  self.folder = folder if folder
end

Public Instance Methods

to_http_info(api_client) click to toggle source
# File lib/aspose-email-cloud/models/calendar_get_as_file_request.rb, line 57
def to_http_info(api_client)
  # verify the required parameter 'file_name' is set
  if api_client.config.client_side_validation && self.file_name.nil?
    raise ArgumentError, "Missing the required parameter 'file_name' when calling CalendarApi.get_as_file"
  end
  # verify the required parameter 'format' is set
  if api_client.config.client_side_validation && self.format.nil?
    raise ArgumentError, "Missing the required parameter 'format' when calling CalendarApi.get_as_file"
  end
  # resource path
  local_var_path = '/email/Calendar/as-file'

  # query parameters
  query_params = {}
  query_params[:fileName] = self.file_name
  query_params[:format] = self.format
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:folder] = self.folder unless self.folder.nil?

  # form parameters
  form_params = {}

  # http body (model)
  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'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['application/json'])

  AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                    header_params: header_params,
                                    query_params: query_params,
                                    form_params: form_params,
                                    auth_names: auth_names)
end