Class: AsposeEmailCloud::DeleteFolderRequestData

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

Overview

Request model for delete_folder operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, storage_name = nil, recursive = nil) ⇒ DeleteFolderRequestData

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



49
50
51
52
53
 
# File 'lib/aspose-email-cloud/models/requests/delete_folder_request_data.rb', line 49

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) 


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

def path
  @path
end

#recursive ⇒ BOOLEAN

Enable to delete folders, subfolders and files

Returns:

  • (BOOLEAN) 


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

def recursive
  @recursive
end

#storage_name ⇒ String

Storage name

Returns:

  • (String) 


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

def storage_name
  @storage_name
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



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
84
85
86
87
88
89
 
# File 'lib/aspose-email-cloud/models/requests/delete_folder_request_data.rb', line 55

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 EmailApi.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)

  post_body = nil
  auth_names = ['JWT']

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = select_header_accept(['application/json'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])

  AsposeEmailCloud::HttpRequest.new(local_var_path,
                                  header_params,
                                  query_params,
                                  form_params,
                                  post_body,
                                  auth_names)
end