class AsposeEmailCloud::ContactApi
ContactApi
operations.
Attributes
Public Class Methods
Initializes a new instance of the ContactApi
class. @param [ApiInvoker] api_invoker
# File lib/aspose-email-cloud/api/contact_api.rb, line 45 def initialize(api_invoker) @api_invoker = api_invoker end
Public Instance Methods
Converts contact model to specified format and returns as file
@param [ContactAsFileRequest] request Contact model and format to convert @return [File]
# File lib/aspose-email-cloud/api/contact_api.rb, line 52 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 ContactApi.as_file" end local_var_path = '/email/Contact/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 ContactDto
to MapiContactDto
.
@param [ContactDto] contact_dto Contact model to convert @return [MapiContactDto]
# File lib/aspose-email-cloud/api/contact_api.rb, line 79 def as_mapi(contact_dto) # verify the required parameter 'contact_dto' is set if @api_invoker.api_client.config.client_side_validation && contact_dto.nil? raise ArgumentError, "Missing the required parameter 'contact_dto' when calling ContactApi.as_mapi" end local_var_path = '/email/Contact/as-mapi' post_body = @api_invoker.api_client.object_to_http_body(contact_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, 'MapiContactDto') end
Converts contact document to specified format and returns as file
@param [ContactConvertRequest] request Request object. @return [File]
# File lib/aspose-email-cloud/api/contact_api.rb, line 106 def convert(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :PUT, 'File') end
Converts contact document to a model representation
@param [ContactFromFileRequest] request Request object. @return [ContactDto]
# File lib/aspose-email-cloud/api/contact_api.rb, line 114 def from_file(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :PUT, 'ContactDto') end
Get contact document from storage.
@param [ContactGetRequest] request Request object. @return [ContactDto]
# File lib/aspose-email-cloud/api/contact_api.rb, line 122 def get(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :GET, 'ContactDto') end
Converts contact document from storage to specified format and returns as file
@param [ContactGetAsFileRequest] request Request object. @return [File]
# File lib/aspose-email-cloud/api/contact_api.rb, line 130 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 contact list from storage folder.
@param [ContactGetListRequest] request Request object. @return [ContactStorageList]
# File lib/aspose-email-cloud/api/contact_api.rb, line 138 def get_list(request) http_request = request.to_http_info(@api_invoker.api_client) @api_invoker.make_request(http_request, :GET, 'ContactStorageList') end
Save contact to storage.
@param [ContactSaveRequest] request Create/Update contact request. @return [nil]
# File lib/aspose-email-cloud/api/contact_api.rb, line 146 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 ContactApi.save" end local_var_path = '/email/Contact' 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