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

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

Constant Summary

Constants included from Helpers::GetAllHelper

Helpers::GetAllHelper::MAX_PAGE_SIZE

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BasicApi 



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete Marketing Event by External Ids Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app can be deleted.



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

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

#archive_by_object_id(object_id, opts = {}) ⇒ nil

Delete Marketing Event by objectId Deletes the existing Marketing Event with the specified objectId, if it exists.



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

def archive_by_object_id(object_id, opts = {})
  archive_by_object_id_with_http_info(object_id, opts)
  nil
end

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

Delete Marketing Event by objectId Deletes the existing Marketing Event with the specified objectId, if it exists.



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

def archive_by_object_id_with_http_info(object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.archive_by_object_id ...'
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling BasicApi.archive_by_object_id"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_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 => :"BasicApi.archive_by_object_id",
    :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_by_object_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Marketing Event by External Ids Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app can be deleted.



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
94
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 43

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

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

Create a marketing event Creates a new marketing event in HubSpot



164
165
166
167
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 164

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



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

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

#get_all(opts = {}) ⇒ CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging

Get all marketing event Returns all Marketing Events available on the portal, along with their properties, regardless of whether they were created manually or through the application. The marketing events returned by this endpoint are sorted by objectId.

Options Hash (opts):

  • :after (String) —

    The cursor indicating the position of the last retrieved item.

  • :limit (Integer) —

    The limit for response size. The default value is 10, the max number is 100 (default to 10)



233
234
235
236
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 233

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

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

Get all marketing event Returns all Marketing Events available on the portal, along with their properties, regardless of whether they were created manually or through the application. The marketing events returned by this endpoint are sorted by objectId.

Options Hash (opts):

  • :after (String) —

    The cursor indicating the position of the last retrieved item.

  • :limit (Integer) —

    The limit for response size. The default value is 10, the max number is 100 (default to 10)



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
288
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 244

def get_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.get_all ...'
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/'

  # 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?

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

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

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

#get_by_object_id(object_id, opts = {}) ⇒ MarketingEventPublicReadResponseV2

Get Marketing Event by objectId Returns the details of a Marketing Event with the specified objectId, if it exists.



295
296
297
298
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 295

def get_by_object_id(object_id, opts = {})
  data, _status_code, _headers = get_by_object_id_with_http_info(object_id, opts)
  data
end

#get_by_object_id_with_http_info(object_id, opts = {}) ⇒ Array<(MarketingEventPublicReadResponseV2, Integer, Hash)>

Get Marketing Event by objectId Returns the details of a Marketing Event with the specified objectId, if it exists.



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

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

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

  new_options = opts.merge(
    :operation => :"BasicApi.get_by_object_id",
    :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_by_object_id\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 Marketing Event by External IDs Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app making the request can be retrieved.



359
360
361
362
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 359

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 Marketing Event by External IDs Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app making the request can be retrieved.



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
417
418
419
420
421
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 370

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 Marketing Event by External IDs Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists. Only Marketing Events created by the same app can be updated.



430
431
432
433
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 430

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_by_object_id(object_id, marketing_event_public_update_request_v2, opts = {}) ⇒ MarketingEventPublicDefaultResponseV2

Update Marketing Event by objectId Updates the details of an existing Marketing Event identified by its objectId, if it exists.



510
511
512
513
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 510

def update_by_object_id(object_id, marketing_event_public_update_request_v2, opts = {})
  data, _status_code, _headers = update_by_object_id_with_http_info(object_id, marketing_event_public_update_request_v2, opts)
  data
end

#update_by_object_id_with_http_info(object_id, marketing_event_public_update_request_v2, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponseV2, Integer, Hash)>

Update Marketing Event by objectId Updates the details of an existing Marketing Event identified by its objectId, if it exists.



521
522
523
524
525
526
527
528
529
530
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
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 521

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

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

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

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

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

Update Marketing Event by External IDs Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists. Only Marketing Events created by the same app can be updated.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
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
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 442

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.



584
585
586
587
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 584

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.



595
596
597
598
599
600
601
602
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
 
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 595

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