Class: Hubspot::Marketing::Events::BasicApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BasicApi

Returns a new instance of BasicApi.



22
23
24
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 22

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#archive(external_event_id, external_account_id, opts = {}) ⇒ nil

Delete a marketing event Deletes an existing Marketing Event with the specified id, if one exists.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to delete

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:

  • (nil) 


31
32
33
34
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 31

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

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

Delete a marketing event Deletes an existing Marketing Event with the specified id, if one exists.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to delete

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
91
92
93
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 42

def archive_with_http_info(external_event_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.archive ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling BasicApi.archive"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.archive"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s))

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

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

#batch_archive(batch_input_marketing_event_external_unique_identifier, opts = {}) ⇒ Error

Delete multiple marketing events Bulk delete a number of marketing events in HubSpot

Parameters:

Returns:



100
101
102
103
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 100

def batch_archive(batch_input_marketing_event_external_unique_identifier, opts = {})
  data, _status_code, _headers = batch_archive_with_http_info(batch_input_marketing_event_external_unique_identifier, opts)
  data
end

#batch_archive_with_http_info(batch_input_marketing_event_external_unique_identifier, opts = {}) ⇒ Array<(Error, Integer, Hash)>

Delete multiple marketing events Bulk delete a number of marketing events in HubSpot

Parameters:

Returns:

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

    Error data, response status code and response headers



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
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 110

def batch_archive_with_http_info(batch_input_marketing_event_external_unique_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.batch_archive ...'
  end
  # verify the required parameter 'batch_input_marketing_event_external_unique_identifier' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_external_unique_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_external_unique_identifier' when calling BasicApi.batch_archive"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/delete'

  # 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(batch_input_marketing_event_external_unique_identifier)

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

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

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

#batch_upsert(batch_input_marketing_event_create_request_params, opts = {}) ⇒ BatchResponseMarketingEventPublicDefaultResponse

Create or update multiple marketing events Upsert multiple marketing events. If there is an existing Marketing event with the specified ID, it will be updated; otherwise a new event will be created.

Parameters:

Returns:



168
169
170
171
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 168

def batch_upsert(batch_input_marketing_event_create_request_params, opts = {})
  data, _status_code, _headers = batch_upsert_with_http_info(batch_input_marketing_event_create_request_params, opts)
  data
end

#batch_upsert_with_http_info(batch_input_marketing_event_create_request_params, opts = {}) ⇒ Array<(BatchResponseMarketingEventPublicDefaultResponse, Integer, Hash)>

Create or update multiple marketing events Upsert multiple marketing events. If there is an existing Marketing event with the specified ID, it will be updated; otherwise a new event will be created.

Parameters:

Returns:



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
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 178

def batch_upsert_with_http_info(batch_input_marketing_event_create_request_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.batch_upsert ...'
  end
  # verify the required parameter 'batch_input_marketing_event_create_request_params' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_create_request_params.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_create_request_params' when calling BasicApi.batch_upsert"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/upsert'

  # 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(batch_input_marketing_event_create_request_params)

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

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

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

#cancel(external_event_id, external_account_id, opts = {}) ⇒ MarketingEventDefaultResponse

Mark a marketing event as cancelled Mark a marketing event as cancelled.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to mark as cancelled

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 237

def cancel(external_event_id, , opts = {})
  data, _status_code, _headers = cancel_with_http_info(external_event_id, , opts)
  data
end

#cancel_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>

Mark a marketing event as cancelled Mark a marketing event as cancelled.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to mark as cancelled

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:



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
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 248

def cancel_with_http_info(external_event_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.cancel ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling BasicApi.cancel"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.cancel"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/cancel'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s))

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

  # 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] || 'MarketingEventDefaultResponse'

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

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

#complete(external_event_id, external_account_id, marketing_event_complete_request_params, opts = {}) ⇒ MarketingEventDefaultResponse

Mark a marketing event as completed Mark a marketing event as completed

Parameters:

  • external_event_id (String) —

    The id of the marketing event in the external event application.

  • external_account_id (String) —

    The accountId that is associated with this marketing event in the external event application.

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

    the optional parameters

Returns:



308
309
310
311
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 308

def complete(external_event_id, , marketing_event_complete_request_params, opts = {})
  data, _status_code, _headers = complete_with_http_info(external_event_id, , marketing_event_complete_request_params, opts)
  data
end

#complete_with_http_info(external_event_id, external_account_id, marketing_event_complete_request_params, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>

Mark a marketing event as completed Mark a marketing event as completed

Parameters:

  • external_event_id (String) —

    The id of the marketing event in the external event application.

  • external_account_id (String) —

    The accountId that is associated with this marketing event in the external event application.

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

    the optional parameters

Returns:



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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 320

def complete_with_http_info(external_event_id, , marketing_event_complete_request_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.complete ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling BasicApi.complete"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.complete"
  end
  # verify the required parameter 'marketing_event_complete_request_params' is set
  if @api_client.config.client_side_validation && marketing_event_complete_request_params.nil?
    fail ArgumentError, "Missing the required parameter 'marketing_event_complete_request_params' when calling BasicApi.complete"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/complete'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s))

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

  # 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(marketing_event_complete_request_params)

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

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

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

#create(marketing_event_create_request_params, opts = {}) ⇒ MarketingEventDefaultResponse

Create a marketing event Creates a new marketing event in HubSpot

Parameters:

Returns:



387
388
389
390
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 387

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

#create_with_http_info(marketing_event_create_request_params, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>

Create a marketing event Creates a new marketing event in HubSpot

Parameters:

Returns:



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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 397

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

  # 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(marketing_event_create_request_params)

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

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

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

#do_search(q, opts = {}) ⇒ CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging

Search for marketing events Search for marketing events that have an event id that starts with the query string

Parameters:

  • q (String) —

    The id of the marketing event in the external event application

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

    the optional parameters

Returns:



455
456
457
458
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 455

def do_search(q, opts = {})
  data, _status_code, _headers = do_search_with_http_info(q, opts)
  data
end

#do_search_with_http_info(q, opts = {}) ⇒ Array<(CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging, Integer, Hash)>

Search for marketing events Search for marketing events that have an event id that starts with the query string

Parameters:

  • q (String) —

    The id of the marketing event in the external event application

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

    the optional parameters

Returns:



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 465

def do_search_with_http_info(q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.do_search ...'
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling BasicApi.do_search"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/search'

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

  # 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] || 'CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging'

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

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

#get_details(external_event_id, external_account_id, opts = {}) ⇒ MarketingEventPublicReadResponse

Get a marketing event Returns the details of the Marketing Event with the specified id, if one exists.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to return

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:



520
521
522
523
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 520

def get_details(external_event_id, , opts = {})
  data, _status_code, _headers = get_details_with_http_info(external_event_id, , opts)
  data
end

#get_details_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(MarketingEventPublicReadResponse, Integer, Hash)>

Get a marketing event Returns the details of the Marketing Event with the specified id, if one exists.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to return

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 531

def get_details_with_http_info(external_event_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.get_details ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling BasicApi.get_details"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.get_details"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s))

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

  # 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] || 'MarketingEventPublicReadResponse'

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

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

#update(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) ⇒ MarketingEventPublicDefaultResponse

Update a marketing event Updates an existing Marketing Event with the specified id, if one exists.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to update

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:



591
592
593
594
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 591

def update(external_event_id, , marketing_event_update_request_params, opts = {})
  data, _status_code, _headers = update_with_http_info(external_event_id, , marketing_event_update_request_params, opts)
  data
end

#update_with_http_info(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponse, Integer, Hash)>

Update a marketing event Updates an existing Marketing Event with the specified id, if one exists.

Parameters:

  • external_event_id (String) —

    The id of the marketing event to update

  • external_account_id (String) —

    The account id associated with the marketing event

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

    the optional parameters

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 603

def update_with_http_info(external_event_id, , marketing_event_update_request_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.update ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling BasicApi.update"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.update"
  end
  # verify the required parameter 'marketing_event_update_request_params' is set
  if @api_client.config.client_side_validation && marketing_event_update_request_params.nil?
    fail ArgumentError, "Missing the required parameter 'marketing_event_update_request_params' when calling BasicApi.update"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s))

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

  # 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(marketing_event_update_request_params)

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

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

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

#upsert(external_event_id, marketing_event_create_request_params, opts = {}) ⇒ MarketingEventPublicDefaultResponse

Create or update a marketing event Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.

Parameters:

  • external_event_id (String) —

    The ID of the marketing event to upsert

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

    the optional parameters

Returns:



671
672
673
674
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 671

def upsert(external_event_id, marketing_event_create_request_params, opts = {})
  data, _status_code, _headers = upsert_with_http_info(external_event_id, marketing_event_create_request_params, opts)
  data
end

#upsert_with_http_info(external_event_id, marketing_event_create_request_params, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponse, Integer, Hash)>

Create or update a marketing event Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.

Parameters:

  • external_event_id (String) —

    The ID of the marketing event to upsert

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

    the optional parameters

Returns:



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 682

def upsert_with_http_info(external_event_id, marketing_event_create_request_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.upsert ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling BasicApi.upsert"
  end
  # verify the required parameter 'marketing_event_create_request_params' is set
  if @api_client.config.client_side_validation && marketing_event_create_request_params.nil?
    fail ArgumentError, "Missing the required parameter 'marketing_event_create_request_params' when calling BasicApi.upsert"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_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'
  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(marketing_event_create_request_params)

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

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

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