Class: Hubspot::Crm::Lists::FoldersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/lists/api/folders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FoldersApi

Returns a new instance of FoldersApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 21

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#create(list_folder_create_request, opts = {}) ⇒ ListFolderCreateResponse

Creates a folder Creates a folder with the given information.

Parameters:

Returns:



29
30
31
32
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 29

def create(list_folder_create_request, opts = {})
  data, _status_code, _headers = create_with_http_info(list_folder_create_request, opts)
  data
end

#create_with_http_info(list_folder_create_request, opts = {}) ⇒ Array<(ListFolderCreateResponse, Integer, Hash)>

Creates a folder Creates a folder with the given information.

Parameters:

Returns:

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

    ListFolderCreateResponse data, response status code and response headers



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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 39

def create_with_http_info(list_folder_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.create ...'
  end
  # verify the required parameter 'list_folder_create_request' is set
  if @api_client.config.client_side_validation && list_folder_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'list_folder_create_request' when calling FoldersApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/lists/folders'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ListFolderCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"FoldersApi.create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all(opts = {}) ⇒ ListFolderFetchResponse

Retrieves a folder. Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder_id (String) —

    The Id of the folder to retrieve. (default to ‘0’)

Returns:



97
98
99
100
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 97

def get_all(opts = {})
  data, _status_code, _headers = get_all_with_http_info(opts)
  data
end

#get_all_with_http_info(opts = {}) ⇒ Array<(ListFolderFetchResponse, Integer, Hash)>

Retrieves a folder. Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder_id (String) —

    The Id of the folder to retrieve. (default to ‘0’)

Returns:

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

    ListFolderFetchResponse data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
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
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 107

def get_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.get_all ...'
  end
  # resource path
  local_var_path = '/crm/v3/lists/folders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ListFolderFetchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"FoldersApi.get_all",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move(folder_id, new_parent_folder_id, opts = {}) ⇒ ListFolderFetchResponse

Moves a folder This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 158

def move(folder_id, new_parent_folder_id, opts = {})
  data, _status_code, _headers = move_with_http_info(folder_id, new_parent_folder_id, opts)
  data
end

#move_list(list_move_request, opts = {}) ⇒ nil

Moves a list to a given folder Given a list and a folder, the list will be moved to that folder.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


226
227
228
229
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 226

def move_list(list_move_request, opts = {})
  move_list_with_http_info(list_move_request, opts)
  nil
end

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

Moves a list to a given folder Given a list and a folder, the list will be moved to that folder.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



236
237
238
239
240
241
242
243
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
285
286
287
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 236

def move_list_with_http_info(list_move_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.move_list ...'
  end
  # verify the required parameter 'list_move_request' is set
  if @api_client.config.client_side_validation && list_move_request.nil?
    fail ArgumentError, "Missing the required parameter 'list_move_request' when calling FoldersApi.move_list"
  end
  # resource path
  local_var_path = '/crm/v3/lists/folders/move-list'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"FoldersApi.move_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#move_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_with_http_info(folder_id, new_parent_folder_id, opts = {}) ⇒ Array<(ListFolderFetchResponse, Integer, Hash)>

Moves a folder This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given.

Parameters:

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

    the optional parameters

Returns:

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

    ListFolderFetchResponse data, response status code and response headers



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
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
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 169

def move_with_http_info(folder_id, new_parent_folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.move ...'
  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 FoldersApi.move"
  end
  # verify the required parameter 'new_parent_folder_id' is set
  if @api_client.config.client_side_validation && new_parent_folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'new_parent_folder_id' when calling FoldersApi.move"
  end
  # resource path
  local_var_path = '/crm/v3/lists/folders/{folderId}/move/{newParentFolderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s)).sub('{' + 'newParentFolderId' + '}', CGI.escape(new_parent_folder_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ListFolderFetchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"FoldersApi.move",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#move\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Deletes a folder Deletes the folder with the given Id.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


294
295
296
297
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 294

def remove(folder_id, opts = {})
  remove_with_http_info(folder_id, opts)
  nil
end

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

Deletes a folder Deletes the folder with the given Id.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 304

def remove_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.remove ...'
  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 FoldersApi.remove"
  end
  # resource path
  local_var_path = '/crm/v3/lists/folders/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"FoldersApi.remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rename(folder_id, opts = {}) ⇒ ListFolderFetchResponse

Rename a folder Renames the given folderId with a new name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :new_folder_name (String)

Returns:



358
359
360
361
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 358

def rename(folder_id, opts = {})
  data, _status_code, _headers = rename_with_http_info(folder_id, opts)
  data
end

#rename_with_http_info(folder_id, opts = {}) ⇒ Array<(ListFolderFetchResponse, Integer, Hash)>

Rename a folder Renames the given folderId with a new name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :new_folder_name (String)

Returns:

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

    ListFolderFetchResponse data, response status code and response headers



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/hubspot/codegen/crm/lists/api/folders_api.rb', line 369

def rename_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoldersApi.rename ...'
  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 FoldersApi.rename"
  end
  # resource path
  local_var_path = '/crm/v3/lists/folders/{folderId}/rename'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'newFolderName'] = opts[:'new_folder_name'] if !opts[:'new_folder_name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ListFolderFetchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"FoldersApi.rename",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FoldersApi#rename\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end