Class: Hubspot::Marketing::Forms::FormsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/marketing/forms/api/forms_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FormsApi

Returns a new instance of FormsApi.



21
22
23
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_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/marketing/forms/api/forms_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#archive(form_id, opts = {}) ⇒ nil

Archive a form definition Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months.

Parameters:

  • form_id (String) —

    The ID of the form to archive.

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 29

def archive(form_id, opts = {})
  archive_with_http_info(form_id, opts)
  nil
end

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

Archive a form definition Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months.

Parameters:

  • form_id (String) —

    The ID of the form to archive.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 39

def archive_with_http_info(form_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FormsApi.archive ...'
  end
  # verify the required parameter 'form_id' is set
  if @api_client.config.client_side_validation && form_id.nil?
    fail ArgumentError, "Missing the required parameter 'form_id' when calling FormsApi.archive"
  end
  # resource path
  local_var_path = '/marketing/v3/forms/{formId}'.sub('{' + 'formId' + '}', CGI.escape(form_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[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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: FormsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(form_definition_create_request_base, opts = {}) ⇒ FormDefinitionBase

Create a form Add a new ‘hubspot` form

Parameters:

Returns:



91
92
93
94
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 91

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

#create_with_http_info(form_definition_create_request_base, opts = {}) ⇒ Array<(FormDefinitionBase, Integer, Hash)>

Create a form Add a new &#x60;hubspot&#x60; form

Parameters:

Returns:

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

    FormDefinitionBase data, response status code and response headers



101
102
103
104
105
106
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
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 101

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

  # 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'
  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(form_definition_create_request_base) 

  # return_type
  return_type = opts[:return_type] || 'FormDefinitionBase' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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: FormsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(form_id, opts = {}) ⇒ FormDefinitionBase

Get a form definition Returns a form based on the form ID provided.

Parameters:

  • form_id (String) —

    The unique identifier of the form

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



156
157
158
159
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 156

def get_by_id(form_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(form_id, opts)
  data
end

#get_by_id_with_http_info(form_id, opts = {}) ⇒ Array<(FormDefinitionBase, Integer, Hash)>

Get a form definition Returns a form based on the form ID provided.

Parameters:

  • form_id (String) —

    The unique identifier of the form

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

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

    FormDefinitionBase data, response status code and response headers



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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 167

def get_by_id_with_http_info(form_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FormsApi.get_by_id ...'
  end
  # verify the required parameter 'form_id' is set
  if @api_client.config.client_side_validation && form_id.nil?
    fail ArgumentError, "Missing the required parameter 'form_id' when calling FormsApi.get_by_id"
  end
  # resource path
  local_var_path = '/marketing/v3/forms/{formId}'.sub('{' + 'formId' + '}', CGI.escape(form_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'FormDefinitionBase' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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: FormsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page(opts = {}) ⇒ CollectionResponseFormDefinitionBaseForwardPaging

Get a list of forms Returns a list of forms based on the search filters. By default, it returns the first 20 ‘hubspot` forms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to display per page.

  • :archived (Boolean) —

    Whether to return only results that have been archived.

  • :form_types (Array<String>) —

    The form types to be included in the results.

Returns:



223
224
225
226
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 223

def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponseFormDefinitionBaseForwardPaging, Integer, Hash)>

Get a list of forms Returns a list of forms based on the search filters. By default, it returns the first 20 &#x60;hubspot&#x60; forms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to display per page.

  • :archived (Boolean) —

    Whether to return only results that have been archived.

  • :form_types (Array<String>) —

    The form types to be included in the results.

Returns:



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
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 236

def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FormsApi.get_page ...'
  end
  allowable_values = ["hubspot", "captured", "flow", "blog_comment", "all"]
  if @api_client.config.client_side_validation && opts[:'form_types'] && !opts[:'form_types'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"form_types\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/marketing/v3/forms/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
  query_params[:'formTypes'] = @api_client.build_collection_param(opts[:'form_types'], :multi) if !opts[:'form_types'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'CollectionResponseFormDefinitionBaseForwardPaging' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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: FormsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace(form_id, hub_spot_form_definition, opts = {}) ⇒ FormDefinitionBase

Update a form definition Update all fields of a hubspot form definition.

Parameters:

  • form_id (String)
  • hub_spot_form_definition (HubSpotFormDefinition)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



293
294
295
296
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 293

def replace(form_id, hub_spot_form_definition, opts = {})
  data, _status_code, _headers = replace_with_http_info(form_id, hub_spot_form_definition, opts)
  data
end

#replace_with_http_info(form_id, hub_spot_form_definition, opts = {}) ⇒ Array<(FormDefinitionBase, Integer, Hash)>

Update a form definition Update all fields of a hubspot form definition.

Parameters:

  • form_id (String)
  • hub_spot_form_definition (HubSpotFormDefinition)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    FormDefinitionBase data, 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
351
352
353
354
355
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 304

def replace_with_http_info(form_id, hub_spot_form_definition, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FormsApi.replace ...'
  end
  # verify the required parameter 'form_id' is set
  if @api_client.config.client_side_validation && form_id.nil?
    fail ArgumentError, "Missing the required parameter 'form_id' when calling FormsApi.replace"
  end
  # verify the required parameter 'hub_spot_form_definition' is set
  if @api_client.config.client_side_validation && hub_spot_form_definition.nil?
    fail ArgumentError, "Missing the required parameter 'hub_spot_form_definition' when calling FormsApi.replace"
  end
  # resource path
  local_var_path = '/marketing/v3/forms/{formId}'.sub('{' + 'formId' + '}', CGI.escape(form_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', '*/*'])
  # 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(hub_spot_form_definition) 

  # return_type
  return_type = opts[:return_type] || 'FormDefinitionBase' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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: FormsApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(form_id, hub_spot_form_definition_patch_request, opts = {}) ⇒ FormDefinitionBase

Partially update a form definition Update some of the form definition components

Parameters:

  • form_id (String) —

    The ID of the form to update.

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

    the optional parameters

Returns:



363
364
365
366
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 363

def update(form_id, hub_spot_form_definition_patch_request, opts = {})
  data, _status_code, _headers = update_with_http_info(form_id, hub_spot_form_definition_patch_request, opts)
  data
end

#update_with_http_info(form_id, hub_spot_form_definition_patch_request, opts = {}) ⇒ Array<(FormDefinitionBase, Integer, Hash)>

Partially update a form definition Update some of the form definition components

Parameters:

  • form_id (String) —

    The ID of the form to update.

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

    the optional parameters

Returns:

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

    FormDefinitionBase data, response status code and response headers



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
417
418
419
420
421
422
423
424
425
 
# File 'lib/hubspot/codegen/marketing/forms/api/forms_api.rb', line 374

def update_with_http_info(form_id, hub_spot_form_definition_patch_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FormsApi.update ...'
  end
  # verify the required parameter 'form_id' is set
  if @api_client.config.client_side_validation && form_id.nil?
    fail ArgumentError, "Missing the required parameter 'form_id' when calling FormsApi.update"
  end
  # verify the required parameter 'hub_spot_form_definition_patch_request' is set
  if @api_client.config.client_side_validation && hub_spot_form_definition_patch_request.nil?
    fail ArgumentError, "Missing the required parameter 'hub_spot_form_definition_patch_request' when calling FormsApi.update"
  end
  # resource path
  local_var_path = '/marketing/v3/forms/{formId}'.sub('{' + 'formId' + '}', CGI.escape(form_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', '*/*'])
  # 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(hub_spot_form_definition_patch_request) 

  # return_type
  return_type = opts[:return_type] || 'FormDefinitionBase' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end