class AsposeEmailCloud::ContactGetListRequest

Request model for contact_get_list operation.

Attributes

folder[RW]

Path to folder in storage. @return [String]

format[RW]

Contact document format. Enum, available values: VCard, WebDav, Msg @return [String]

items_per_page[RW]

Count of items on page. @return [Integer]

page_number[RW]

Page number. @return [Integer]

storage[RW]

Storage name. @return [String]

Public Class Methods

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

Get contact list from storage folder.

@param [String] format Contact document format. Enum, available values: VCard, WebDav, Msg @param [String] folder Path to folder in storage. @param [String] storage Storage name. @param [Integer] items_per_page Count of items on page. @param [Integer] page_number Page number.

# File lib/aspose-email-cloud/models/contact_get_list_request.rb, line 54
def initialize(format:, folder: nil, storage: nil, items_per_page: nil, page_number: nil)
  self.format = format if format
  self.folder = folder if folder
  self.storage = storage if storage
  self.items_per_page = items_per_page if items_per_page
  self.page_number = page_number if page_number
end

Public Instance Methods

to_http_info(api_client) click to toggle source
# File lib/aspose-email-cloud/models/contact_get_list_request.rb, line 62
def to_http_info(api_client)
  # 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 ContactApi.get_list"
  end
  # resource path
  local_var_path = '/email/Contact/list'

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