Class: AsposeWordsCloud::GetDocumentFieldNamesOnlineRequest

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

Overview

Request model for get_document_field_names_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(template:, load_encoding: nil, password: nil, encrypted_password: nil, use_non_merge_fields: nil) ⇒ GetDocumentFieldNamesOnlineRequest

Initializes a new instance.

Parameters:

  • template —

    The template document.

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

  • use_non_merge_fields (defaults to: nil) —

    The flag indicating whether to use non merge fields. If true, result includes “mustache” field names.



55
56
57
58
59
60
61
 
# File 'lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb', line 55

def initialize(template:, load_encoding: nil, password: nil, encrypted_password: nil, use_non_merge_fields: nil)
  self.template = template
  self.load_encoding = load_encoding
  self.password = password
  self.encrypted_password = encrypted_password
  self.use_non_merge_fields = use_non_merge_fields
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.



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

def encrypted_password
  @encrypted_password
end

#load_encoding ⇒ Object

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



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

def load_encoding
  @load_encoding
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.



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

def password
  @password
end

#template ⇒ Object

The template document.



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

def template
  @template
end

#use_non_merge_fields ⇒ Object

The flag indicating whether to use non merge fields. If true, result includes “mustache” field names.



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

def use_non_merge_fields
  @use_non_merge_fields
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


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
 
# File 'lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb', line 120

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

  # resource path
  local_var_path = '/words/online/get/mailMerge/FieldNames'[1..-1]
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  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('UseNonMergeFields')] = self.use_non_merge_fields unless self.use_non_merge_fields.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params[downcase_first_letter('Template')] = self.template

  # http body (model)
  post_body = nil
  body = api_client.build_request_body(header_params, form_params, post_body)
  {
    '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



160
161
162
 
# File 'lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb', line 160

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

#get_response_type ⇒ Object

Get response type



165
166
167
 
# File 'lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb', line 165

def get_response_type
  'FieldNamesResponse'
end

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

Creating batch part from request

Raises:

  • (ArgumentError) 


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
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
 
# File 'lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb', line 64

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

  # resource path
  local_var_path = '/words/online/get/mailMerge/FieldNames'[7..-1]
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  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('UseNonMergeFields')] = self.use_non_merge_fields unless self.use_non_merge_fields.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(['multipart/form-data'])
  header_params['RequestId'] = requestId

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

  # form parameters
  form_params = {}
  form_params[downcase_first_letter('Template')] = self.template

  # http body (model)
  post_body = nil
  body = api_client.build_request_body_batch(header_params, form_params, post_body)
  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