Class: AsposeEmailCloud::CalendarGetListRequest

Inherits:
EmailRequest
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/calendar_get_list_request.rb

Overview

Request model for calendar_get_list operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(folder:, items_per_page: nil, page_number: nil, storage: nil) ⇒ CalendarGetListRequest

Get iCalendar list from storage folder.

Parameters:

  • folder (String) —

    Path to folder in storage.

  • items_per_page (Integer) (defaults to: nil) —

    Count of items on page.

  • page_number (Integer) (defaults to: nil) —

    Page number.

  • storage (String) (defaults to: nil) —

    Storage name.



50
51
52
53
54
55
 
# File 'lib/aspose-email-cloud/models/calendar_get_list_request.rb', line 50

def initialize(folder:, items_per_page: nil, page_number: nil, storage: nil)
  self.folder = folder if folder
  self.items_per_page = items_per_page if items_per_page
  self.page_number = page_number if page_number
  self.storage = storage if storage
end

Instance Attribute Details

#folder ⇒ String

Path to folder in storage.

Returns:

  • (String) 


34
35
36
 
# File 'lib/aspose-email-cloud/models/calendar_get_list_request.rb', line 34

def folder
  @folder
end

#items_per_page ⇒ Integer

Count of items on page.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/aspose-email-cloud/models/calendar_get_list_request.rb', line 37

def items_per_page
  @items_per_page
end

#page_number ⇒ Integer

Page number.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/aspose-email-cloud/models/calendar_get_list_request.rb', line 40

def page_number
  @page_number
end

#storage ⇒ String

Storage name.

Returns:

  • (String) 


43
44
45
 
# File 'lib/aspose-email-cloud/models/calendar_get_list_request.rb', line 43

def storage
  @storage
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose-email-cloud/models/calendar_get_list_request.rb', line 57

def to_http_info(api_client)
  # verify the required parameter 'folder' is set
  if api_client.config.client_side_validation && self.folder.nil?
    raise ArgumentError, "Missing the required parameter 'folder' when calling CalendarApi.get_list"
  end
  # resource path
  local_var_path = '/email/Calendar/list'

  # query parameters
  query_params = {}
  query_params[:folder] = self.folder
  query_params[:itemsPerPage] = self.items_per_page unless self.items_per_page.nil?
  query_params[:pageNumber] = self.page_number unless self.page_number.nil?
  query_params[:storage] = self.storage unless self.storage.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(['application/json'])
  # 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