Class: AsposeEmailCloud::DeleteFolderRequest

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

Overview

Request model for delete_folder operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(path:, storage_name: nil, recursive: nil) ⇒ DeleteFolderRequest

Delete folder

Parameters:

  • path (String) —

    Folder path e.g. '/folder'

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

    Storage name

  • recursive (BOOLEAN) (defaults to: nil) —

    Enable to delete folders, subfolders and files



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

def initialize(path:, storage_name: nil, recursive: nil)
  self.path = path if path
  self.storage_name = storage_name if storage_name
  self.recursive = recursive if recursive
end

Instance Attribute Details

#path ⇒ String

Folder path e.g. '/folder'

Returns:

  • (String) 


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

def path
  @path
end

#recursive ⇒ BOOLEAN

Enable to delete folders, subfolders and files

Returns:

  • (BOOLEAN) 


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

def recursive
  @recursive
end

#storage_name ⇒ String

Storage name

Returns:

  • (String) 


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

def storage_name
  @storage_name
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



52
53
54
55
56
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
 
# File 'lib/aspose-email-cloud/models/delete_folder_request.rb', line 52

def to_http_info(api_client)
  # verify the required parameter 'path' is set
  if api_client.config.client_side_validation && self.path.nil?
    raise ArgumentError, "Missing the required parameter 'path' when calling FolderApi.delete_folder"
  end
  # resource path
  local_var_path = '/email/storage/folder/{path}'.sub('{' + 'path' + '}', self.path.to_s)

  # query parameters
  query_params = {}
  query_params[:storageName] = self.storage_name unless self.storage_name.nil?
  query_params[:recursive] = self.recursive unless self.recursive.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