Class: SurveyMonkeySwaggerClient::SurveyFolders_Api

Inherits:
Object
  • Object
show all
Defined in:
lib/survey_monkey_swagger_client/api/survey_folders__api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SurveyFolders_Api

Returns a new instance of SurveyFolders_Api.



16
17
18
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_a_folder(opts = {}) ⇒ nil

Create a folder Create a folder

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


24
25
26
27
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 24

def create_a_folder(opts = {})
  create_a_folder_with_http_info(opts)
  nil
end

#create_a_folder_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create a folder Create a folder

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



34
35
36
37
38
39
40
41
42
43
44
45
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
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 34

def create_a_folder_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyFolders_Api.create_a_folder ...'
  end
  # resource path
  local_var_path = '/v3/survey_folders'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyFolders_Api#create_a_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_a_folder(folder_id, opts = {}) ⇒ nil

Delete a folder Delete a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


76
77
78
79
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 76

def delete_a_folder(folder_id, opts = {})
  delete_a_folder_with_http_info(folder_id, opts)
  nil
end

#delete_a_folder_with_http_info(folder_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a folder Delete a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
119
120
121
122
123
124
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 86

def delete_a_folder_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyFolders_Api.delete_a_folder ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling SurveyFolders_Api.delete_a_folder"
  end
  # resource path
  local_var_path = '/v3/survey_folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyFolders_Api#delete_a_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_folder(folder_id, opts = {}) ⇒ nil

Get a folder Get a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


130
131
132
133
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 130

def get_a_folder(folder_id, opts = {})
  get_a_folder_with_http_info(folder_id, opts)
  nil
end

#get_a_folder_with_http_info(folder_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get a folder Get a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 140

def get_a_folder_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyFolders_Api.get_a_folder ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling SurveyFolders_Api.get_a_folder"
  end
  # resource path
  local_var_path = '/v3/survey_folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyFolders_Api#get_a_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_folders(opts = {}) ⇒ nil

Get all folders Get all folders

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


183
184
185
186
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 183

def get_all_folders(opts = {})
  get_all_folders_with_http_info(opts)
  nil
end

#get_all_folders_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get all folders Get all folders

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 192

def get_all_folders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyFolders_Api.get_all_folders ...'
  end
  # resource path
  local_var_path = '/v3/survey_folders'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyFolders_Api#get_all_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_a_folder(folder_id, opts = {}) ⇒ nil

Update a folder Update a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


233
234
235
236
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 233

def update_a_folder(folder_id, opts = {})
  update_a_folder_with_http_info(folder_id, opts)
  nil
end

#update_a_folder_with_http_info(folder_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a folder Update a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/survey_monkey_swagger_client/api/survey_folders__api.rb', line 244

def update_a_folder_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyFolders_Api.update_a_folder ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling SurveyFolders_Api.update_a_folder"
  end
  # resource path
  local_var_path = '/v3/survey_folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyFolders_Api#update_a_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end