Class: AsposeCellsCloud::RemoveCharactersRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/requests/remove_characters_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RemoveCharactersRequest

Returns a new instance of RemoveCharactersRequest.



46
47
48
49
50
51
52
53
54
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
90
91
92
93
94
95
96
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 46

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'Spreadsheet')
      self.spreadsheet = attributes[:'Spreadsheet']
  end

  if attributes.has_key?(:'removeTextMethod')
      self.remove_text_method = attributes[:'removeTextMethod']
  end

  if attributes.has_key?(:'characterSets')
      self.character_sets = attributes[:'characterSets']
  end

  if attributes.has_key?(:'removeCustomValue')
      self.remove_custom_value = attributes[:'removeCustomValue']
  end

  if attributes.has_key?(:'caseSensitive')
      self.case_sensitive = attributes[:'caseSensitive']
  end

  if attributes.has_key?(:'worksheet')
      self.worksheet = attributes[:'worksheet']
  end

  if attributes.has_key?(:'range')
      self.range = attributes[:'range']
  end

  if attributes.has_key?(:'outPath')
      self.out_path = attributes[:'outPath']
  end

  if attributes.has_key?(:'outStorageName')
      self.out_storage_name = attributes[:'outStorageName']
  end

  if attributes.has_key?(:'region')
      self.region = attributes[:'region']
  end

  if attributes.has_key?(:'password')
      self.password = attributes[:'password']
  end

end

Instance Attribute Details

#case_sensitive ⇒ Object

Returns the value of attribute case_sensitive.



38
39
40
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 38

def case_sensitive
  @case_sensitive
end

#character_sets ⇒ Object

Returns the value of attribute character_sets.



36
37
38
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 36

def character_sets
  @character_sets
end

#out_path ⇒ Object

Returns the value of attribute out_path.



41
42
43
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 41

def out_path
  @out_path
end

#out_storage_name ⇒ Object

Returns the value of attribute out_storage_name.



42
43
44
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 42

def out_storage_name
  @out_storage_name
end

#password ⇒ Object

Returns the value of attribute password.



44
45
46
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 44

def password
  @password
end

#range ⇒ Object

Returns the value of attribute range.



40
41
42
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 40

def range
  @range
end

#region ⇒ Object

Returns the value of attribute region.



43
44
45
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 43

def region
  @region
end

#remove_custom_value ⇒ Object

Returns the value of attribute remove_custom_value.



37
38
39
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 37

def remove_custom_value
  @remove_custom_value
end

#remove_text_method ⇒ Object

Returns the value of attribute remove_text_method.



35
36
37
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 35

def remove_text_method
  @remove_text_method
end

#spreadsheet ⇒ Object

Returns the value of attribute spreadsheet.



34
35
36
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 34

def spreadsheet
  @spreadsheet
end

#worksheet ⇒ Object

Returns the value of attribute worksheet.



39
40
41
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 39

def worksheet
  @worksheet
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 98

def self.attribute_map
  {
    :'spreadsheet' => :'Spreadsheet',
    :'remove_text_method' => :'removeTextMethod',
    :'character_sets' => :'characterSets',
    :'remove_custom_value' => :'removeCustomValue',
    :'case_sensitive' => :'caseSensitive',
    :'worksheet' => :'worksheet',
    :'range' => :'range',
    :'out_path' => :'outPath',
    :'out_storage_name' => :'outStorageName',
    :'region' => :'region',
    :'password' => :'password'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 115

def self.swagger_types
  {
    :'spreadsheet' => :'String',
    :'remove_text_method' => :'String',
    :'character_sets' => :'String',
    :'remove_custom_value' => :'String',
    :'case_sensitive' => :'BOOLEAN',
    :'worksheet' => :'String',
    :'range' => :'String',
    :'out_path' => :'String',
    :'out_storage_name' => :'String',
    :'region' => :'String',
    :'password' => :'String'
  }
end

Instance Method Details

#create_http_request(api_client, opts = {}) ⇒ Object 



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/aspose_cells_cloud/requests/remove_characters_request.rb', line 131

def create_http_request(api_client,opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug "Calling API: CellsApi.remove_characters ..."
  end
  api_client.request_token_if_needed
  # verify the required parameter 'spreadsheet' is set
  if api_client.config.client_side_validation && spreadsheet.nil?
      fail ArgumentError, "Missing the required parameter 'spreadsheet' when calling CellsApi.remove_characters "
  end 

  # resource path
  local_var_path = "v4.0/cells/content/remove/characters"
  # query parameters
  query_params = {}
  query_params[:'removeTextMethod'] = self.remove_text_method if !self.remove_text_method.nil? 
  query_params[:'characterSets'] = self.character_sets if !self.character_sets.nil? 
  query_params[:'removeCustomValue'] = self.remove_custom_value if !self.remove_custom_value.nil? 
  query_params[:'caseSensitive'] = self.case_sensitive if !self.case_sensitive.nil? 
  query_params[:'worksheet'] = self.worksheet if !self.worksheet.nil? 
  query_params[:'range'] = self.range if !self.range.nil? 
  query_params[:'outPath'] = self.out_path if !self.out_path.nil? 
  query_params[:'outStorageName'] = self.out_storage_name if !self.out_storage_name.nil? 
  query_params[:'region'] = self.region if !self.region.nil? 
  query_params[:'password'] = self.password if !self.password.nil? 

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  post_body = nil 
  header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
  if !spreadsheet.empty? && File.exist?(spreadsheet )
      form_params[File.basename(spreadsheet)] =  ::File.open(spreadsheet,"r")   
  end 

  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Specification.Name>Api.remove_characters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end