Class: AsposeEmailCloud::ContactGetAsFileRequest

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

Overview

Request model for contact_get_as_file operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(file_name:, to_format:, from_format:, storage: nil, folder: nil) ⇒ ContactGetAsFileRequest

Converts contact document from storage to specified format and returns as file

Parameters:

  • file_name (String) —

    Calendar document file name

  • to_format (String) —

    File format. Enum, available values: VCard, WebDav, Msg

  • from_format (String) —

    File format to convert from. Enum, available values: VCard, WebDav, Msg

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

    Storage name

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

    Path to folder in storage



54
55
56
57
58
59
60
 
# File 'lib/aspose-email-cloud/models/contact_get_as_file_request.rb', line 54

def initialize(file_name:, to_format:, from_format:, storage: nil, folder: nil)
  self.file_name = file_name if file_name
  self.to_format = to_format if to_format
  self.from_format = from_format if from_format
  self.storage = storage if storage
  self.folder = folder if folder
end

Instance Attribute Details

#file_name ⇒ String

Calendar document file name

Returns:

  • (String) 


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

def file_name
  @file_name
end

#folder ⇒ String

Path to folder in storage

Returns:

  • (String) 


46
47
48
 
# File 'lib/aspose-email-cloud/models/contact_get_as_file_request.rb', line 46

def folder
  @folder
end

#from_format ⇒ String

File format to convert from. Enum, available values: VCard, WebDav, Msg

Returns:

  • (String) 


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

def from_format
  @from_format
end

#storage ⇒ String

Storage name

Returns:

  • (String) 


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

def storage
  @storage
end

#to_format ⇒ String

File format. Enum, available values: VCard, WebDav, Msg

Returns:

  • (String) 


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

def to_format
  @to_format
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/aspose-email-cloud/models/contact_get_as_file_request.rb', line 62

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 ContactApi.get_as_file"
  end
  # verify the required parameter 'to_format' is set
  if api_client.config.client_side_validation && self.to_format.nil?
    raise ArgumentError, "Missing the required parameter 'to_format' when calling ContactApi.get_as_file"
  end
  # verify the required parameter 'from_format' is set
  if api_client.config.client_side_validation && self.from_format.nil?
    raise ArgumentError, "Missing the required parameter 'from_format' when calling ContactApi.get_as_file"
  end
  # resource path
  local_var_path = '/email/Contact/as-file'

  # query parameters
  query_params = {}
  query_params[:fileName] = self.file_name
  query_params[:toFormat] = self.to_format
  query_params[:fromFormat] = self.from_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