Class: AsposeCellsCloud::RemoveCharactersByPositionRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RemoveCharactersByPositionRequest

Returns a new instance of RemoveCharactersByPositionRequest.



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
97
98
99
100
101
# File 'lib/aspose_cells_cloud/requests/remove_characters_by_position_request.rb', line 47

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?(:'theFirstNCharacters')
      self.the_first_n_characters = attributes[:'theFirstNCharacters']
  end

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

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

  if attributes.has_key?(:'allCharactersAfterText')
      self.all_characters_after_text = attributes[:'allCharactersAfterText']
  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

#all_characters_after_textObject

Returns the value of attribute all_characters_after_text.



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

def all_characters_after_text
  @all_characters_after_text
end

#all_characters_before_textObject

Returns the value of attribute all_characters_before_text.



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

def all_characters_before_text
  @all_characters_before_text
end

#case_sensitiveObject

Returns the value of attribute case_sensitive.



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

def case_sensitive
  @case_sensitive
end

#out_pathObject

Returns the value of attribute out_path.



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

def out_path
  @out_path
end

#out_storage_nameObject

Returns the value of attribute out_storage_name.



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

def out_storage_name
  @out_storage_name
end

#passwordObject

Returns the value of attribute password.



45
46
47
# File 'lib/aspose_cells_cloud/requests/remove_characters_by_position_request.rb', line 45

def password
  @password
end

#rangeObject

Returns the value of attribute range.



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

def range
  @range
end

#regionObject

Returns the value of attribute region.



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

def region
  @region
end

#spreadsheetObject

Returns the value of attribute spreadsheet.



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

def spreadsheet
  @spreadsheet
end

#the_first_n_charactersObject

Returns the value of attribute the_first_n_characters.



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

def the_first_n_characters
  @the_first_n_characters
end

#the_last_n_charactersObject

Returns the value of attribute the_last_n_characters.



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

def the_last_n_characters
  @the_last_n_characters
end

#worksheetObject

Returns the value of attribute worksheet.



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

def worksheet
  @worksheet
end

Class Method Details

.attribute_mapObject

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/aspose_cells_cloud/requests/remove_characters_by_position_request.rb', line 103

def self.attribute_map
  {
    :'spreadsheet' => :'Spreadsheet',
    :'the_first_n_characters' => :'theFirstNCharacters',
    :'the_last_n_characters' => :'theLastNCharacters',
    :'all_characters_before_text' => :'allCharactersBeforeText',
    :'all_characters_after_text' => :'allCharactersAfterText',
    :'case_sensitive' => :'caseSensitive',
    :'worksheet' => :'worksheet',
    :'range' => :'range',
    :'out_path' => :'outPath',
    :'out_storage_name' => :'outStorageName',
    :'region' => :'region',
    :'password' => :'password'
  }
end

.swagger_typesObject

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/aspose_cells_cloud/requests/remove_characters_by_position_request.rb', line 121

def self.swagger_types
  {
    :'spreadsheet' => :'String',
    :'the_first_n_characters' => :'Integer',
    :'the_last_n_characters' => :'Integer',
    :'all_characters_before_text' => :'String',
    :'all_characters_after_text' => :'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



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
185
186
187
188
189
190
191
192
# File 'lib/aspose_cells_cloud/requests/remove_characters_by_position_request.rb', line 138

def create_http_request(api_client,opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug "Calling API: CellsApi.remove_characters_by_position ..."
  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_by_position "
  end 

  # resource path

  local_var_path = "v4.0/cells/content/remove/characters-by-position"
  # query parameters

  query_params = {}
  query_params[:'theFirstNCharacters'] = self.the_first_n_characters if !self.the_first_n_characters.nil? 
  query_params[:'theLastNCharacters'] = self.the_last_n_characters if !self.the_last_n_characters.nil? 
  query_params[:'allCharactersBeforeText'] = self.all_characters_before_text if !self.all_characters_before_text.nil? 
  query_params[:'allCharactersAfterText'] = self.all_characters_after_text if !self.all_characters_after_text.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_by_position\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end