Class: AsposeWordsCloud::GetDocumentStatisticsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb

Overview

Request model for get_document_statistics operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil) ⇒ GetDocumentStatisticsRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.

  • encrypted_password (defaults to: nil) —

    Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

  • include_comments (defaults to: nil) —

    The flag indicating whether to include comments from the WordCount. The default value is “false”.

  • include_footnotes (defaults to: nil) —

    The flag indicating whether to include footnotes from the WordCount. The default value is “false”.

  • include_text_in_shapes (defaults to: nil) —

    The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 71

def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil)
  self.name = name
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.encrypted_password = encrypted_password
  self.include_comments = include_comments
  self.include_footnotes = include_footnotes
  self.include_text_in_shapes = include_text_in_shapes
end

Instance Attribute Details

#encrypted_password ⇒ Object

Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 48

def encrypted_password
  @encrypted_password
end

#folder ⇒ Object

Original document folder.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 36

def folder
  @folder
end

#include_comments ⇒ Object

The flag indicating whether to include comments from the WordCount. The default value is “false”.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 51

def include_comments
  @include_comments
end

#include_footnotes ⇒ Object

The flag indicating whether to include footnotes from the WordCount. The default value is “false”.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 54

def include_footnotes
  @include_footnotes
end

#include_text_in_shapes ⇒ Object

The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 57

def include_text_in_shapes
  @include_text_in_shapes
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 42

def load_encoding
  @load_encoding
end

#name ⇒ Object

The filename of the input document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 33

def name
  @name
end

#password ⇒ Object

Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 45

def password
  @password
end

#storage ⇒ Object

Original document storage.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 39

def storage
  @storage
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 141

def create_http_request(api_client)
  # verify the required parameter 'name' is set
  raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_document_statistics' if api_client.config.client_side_validation && self.name.nil?

  # resource path
  local_var_path = '/words/{name}/statistics'[1..-1]
  local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
  query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
  query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
  query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
  query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
  query_params[downcase_first_letter('IncludeComments')] = self.include_comments unless self.include_comments.nil?
  query_params[downcase_first_letter('IncludeFootnotes')] = self.include_footnotes unless self.include_footnotes.nil?
  query_params[downcase_first_letter('IncludeTextInShapes')] = self.include_text_in_shapes unless self.include_text_in_shapes.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])

  # form parameters
  form_params = []
  files_content = []
  body = api_client.build_request_body(header_params, form_params, files_content)
  {
    'method': :GET,
    'path': local_var_path,
    'header_params': header_params,
    'query_params': query_params,
    'body': body,
    'auth_names': ['JWT']
  }
end

#downcase_first_letter(str) ⇒ Object

Helper method to convert first letter to downcase



183
184
185
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 183

def downcase_first_letter(str)
  str[0].downcase + str[1..-1]
end

#get_response_type ⇒ Object

Get response type



188
189
190
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 188

def get_response_type
  'StatDataResponse'
end

#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 84

def to_batch_part(api_client, requestId, parentRequestId = nil)
  # verify the required parameter 'name' is set
  raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_document_statistics' if api_client.config.client_side_validation && self.name.nil?

  # resource path
  local_var_path = '/words/{name}/statistics'[7..-1]
  local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
  query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
  query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
  query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
  query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
  query_params[downcase_first_letter('IncludeComments')] = self.include_comments unless self.include_comments.nil?
  query_params[downcase_first_letter('IncludeFootnotes')] = self.include_footnotes unless self.include_footnotes.nil?
  query_params[downcase_first_letter('IncludeTextInShapes')] = self.include_text_in_shapes unless self.include_text_in_shapes.nil?

  if query_params
    query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
  end

  header_params = {}
  header_params['RequestId'] = requestId

  if parentRequestId != nil
    header_params['DependsOn'] = parentRequestId
  end

  # form parameters
  form_params = []
  files_content = []

  # http body (model)
  body = api_client.build_request_body_batch(header_params, form_params, files_content)
  part = ""
  part.concat("GET".force_encoding('UTF-8'))
  part.concat(" ".force_encoding('UTF-8'))
  part.concat(local_var_path.force_encoding('UTF-8'))
  part.concat(" \r\n".force_encoding('UTF-8'))

  header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
  part.concat("\r\n".force_encoding('UTF-8'))
  if body
    if body.is_a?(Hash)
      body.each do |key, value|
        part.concat(value, "\r\n")
      end
    else
      part.concat(body)
    end
  end
 part
end