Class: AsposeWordsCloud::UpdateListRequest

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

Overview

Request model for update_list operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, list_id:, list_update:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil) ⇒ UpdateListRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • list_id —

    The list Id.

  • list_update —

    List object.

  • 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.

  • dest_file_name (defaults to: nil) —

    Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

  • revision_author (defaults to: nil) —

    Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.

  • revision_date_time (defaults to: nil) —

    The date and time to use for revisions.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 79

def initialize(name:, list_id:, list_update:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil)
  self.name = name
  self.list_id = list_id
  self.list_update = list_update
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.encrypted_password = encrypted_password
  self.dest_file_name = dest_file_name
  self.revision_author = revision_author
  self.revision_date_time = revision_date_time
end

Instance Attribute Details

#dest_file_name ⇒ Object

Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.



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

def dest_file_name
  @dest_file_name
end

#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.



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

def encrypted_password
  @encrypted_password
end

#folder ⇒ Object

Original document folder.



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

def folder
  @folder
end

#list_id ⇒ Object

The list Id.



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

def list_id
  @list_id
end

#list_update ⇒ Object

List object.



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

def list_update
  @list_update
end

#load_encoding ⇒ Object

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



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

The filename of the input document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/update_list_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.



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

def password
  @password
end

#revision_author ⇒ Object

Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.



60
61
62
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 60

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



63
64
65
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 63

def revision_date_time
  @revision_date_time
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 166

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

  # resource path
  local_var_path = '/words/{name}/lists/{listId}'[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('{' + downcase_first_letter('ListId') + '}', self.list_id.nil? ? '' : self.list_id.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('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
  query_params[downcase_first_letter('RevisionAuthor')] = self.revision_author unless self.revision_author.nil?
  query_params[downcase_first_letter('RevisionDateTime')] = self.revision_date_time unless self.revision_date_time.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 = []
  if self.list_update.nil?
    raise "Parameter ListUpdate is required."
  end
  unless self.list_update.nil?
    form_params.push({:'Name' => 'listUpdate', :'Data' => self.list_update.to_body.to_json, :'MimeType' =>'application/json'})
  end

  body = api_client.build_request_body(header_params, form_params, files_content)
  {
    'method': :PUT,
    '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



220
221
222
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 220

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

#get_response_type ⇒ Object

Get response type



225
226
227
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 225

def get_response_type
  'ListResponse'
end

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

Creating batch part from request

Raises:

  • (ArgumentError) 


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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aspose_words_cloud/models/requests/update_list_request.rb', line 94

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.update_list' if api_client.config.client_side_validation && self.name.nil?
  # verify the required parameter 'list_id' is set
  raise ArgumentError, 'Missing the required parameter list_id when calling WordsApi.update_list' if api_client.config.client_side_validation && self.list_id.nil?
  # verify the required parameter 'list_update' is set
  raise ArgumentError, 'Missing the required parameter list_update when calling WordsApi.update_list' if api_client.config.client_side_validation && self.list_update.nil?

  # resource path
  local_var_path = '/words/{name}/lists/{listId}'[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('{' + downcase_first_letter('ListId') + '}', self.list_id.nil? ? '' : self.list_id.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('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
  query_params[downcase_first_letter('RevisionAuthor')] = self.revision_author unless self.revision_author.nil?
  query_params[downcase_first_letter('RevisionDateTime')] = self.revision_date_time unless self.revision_date_time.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 parameters
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
  header_params['RequestId'] = requestId

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

  # form parameters
  form_params = []
  files_content = []
  if self.list_update.nil?
    raise "Parameter ListUpdate is required."
  end
  unless self.list_update.nil?
    form_params.push({:'Name' => 'listUpdate', :'Data' => self.list_update.to_body.to_json, :'MimeType' =>'application/json'})
  end


  # http body (model)
  body = api_client.build_request_body_batch(header_params, form_params, files_content)
  part = ""
  part.concat("PUT".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