# ------------------------------------------------------------------------------------
#
# Copyright (c) 2024 Aspose.Words for Cloud
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# ------------------------------------------------------------------------------------
module AsposeWordsCloud
#
# Request model for insert_header_footer operation.
#
class InsertHeaderFooterRequest
# The filename of the input document.
attr_accessor :name
# The path to the section in the document tree.
attr_accessor :section_path
# Type of header/footer.
attr_accessor :header_footer_type
# Original document folder.
attr_accessor :folder
# Original document storage.
attr_accessor :storage
# Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
attr_accessor :load_encoding
# 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.
attr_accessor :password
# Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
attr_accessor :encrypted_password
# The value indicates whether OpenType support is on.
attr_accessor :open_type_support
# 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.
attr_accessor :dest_file_name
# 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.
attr_accessor :revision_author
# The date and time to use for revisions.
attr_accessor :revision_date_time
#
# Initializes a new instance.
# @param name The filename of the input document.
# @param section_path The path to the section in the document tree.
# @param header_footer_type Type of header/footer.
# @param folder Original document folder.
# @param storage Original document storage.
# @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
# @param password 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.
# @param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
# @param open_type_support The value indicates whether OpenType support is on.
# @param dest_file_name 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.
# @param revision_author 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.
# @param revision_date_time The date and time to use for revisions.
def initialize(name:, section_path:, header_footer_type:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil)
self.name = name
self.section_path = section_path
self.header_footer_type = header_footer_type
self.folder = folder
self.storage = storage
self.load_encoding = load_encoding
self.password = password
self.encrypted_password = encrypted_password
self.open_type_support = open_type_support
self.dest_file_name = dest_file_name
self.revision_author = revision_author
self.revision_date_time = revision_date_time
end
# Creating batch part from request
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.insert_header_footer' if api_client.config.client_side_validation && self.name.nil?
# verify the required parameter 'section_path' is set
raise ArgumentError, 'Missing the required parameter section_path when calling WordsApi.insert_header_footer' if api_client.config.client_side_validation && self.section_path.nil?
# verify the required parameter 'header_footer_type' is set
raise ArgumentError, 'Missing the required parameter header_footer_type when calling WordsApi.insert_header_footer' if api_client.config.client_side_validation && self.header_footer_type.nil?
# resource path
local_var_path = '/words/{name}/{sectionPath}/headersfooters'[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('SectionPath') + '}', self.section_path.nil? ? '' : self.section_path.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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.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.header_footer_type.nil?
raise "Parameter HeaderFooterType is required."
end
unless self.header_footer_type.nil?
form_params.push({:'Name' => 'headerFooterType', :'Data' => self.header_footer_type, :'MimeType' =>'text/plain'})
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
def create_http_request(api_client)
# verify the required parameter 'name' is set
raise ArgumentError, 'Missing the required parameter name when calling WordsApi.insert_header_footer' if api_client.config.client_side_validation && self.name.nil?
# verify the required parameter 'section_path' is set
raise ArgumentError, 'Missing the required parameter section_path when calling WordsApi.insert_header_footer' if api_client.config.client_side_validation && self.section_path.nil?
# verify the required parameter 'header_footer_type' is set
raise ArgumentError, 'Missing the required parameter header_footer_type when calling WordsApi.insert_header_footer' if api_client.config.client_side_validation && self.header_footer_type.nil?
# resource path
local_var_path = '/words/{name}/{sectionPath}/headersfooters'[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('SectionPath') + '}', self.section_path.nil? ? '' : self.section_path.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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.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.header_footer_type.nil?
raise "Parameter HeaderFooterType is required."
end
unless self.header_footer_type.nil?
form_params.push({:'Name' => 'headerFooterType', :'Data' => self.header_footer_type, :'MimeType' =>'text/plain'})
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
#
# Helper method to convert first letter to downcase
#
def downcase_first_letter(str)
str[0].downcase + str[1..-1]
end
# Get response type
def get_response_type
'HeaderFooterResponse'
end
end
end