Class: Hubspot::Marketing::Events::ListAssociationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ListAssociationsApi

Returns a new instance of ListAssociationsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Associate a list with a marketing event Associates a list with a marketing event by external account id, external event id, and ILS list id

Parameters:

  • external_account_id (String) —

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

  • external_event_id (String) —

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

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

  • (nil) 


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

def (, external_event_id, list_id, opts = {})
  (, external_event_id, list_id, opts)
  nil
end

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

Associate a list with a marketing event Associates a list with a marketing event by external account id, external event id, and ILS list id

Parameters:

  • external_account_id (String) —

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

  • external_event_id (String) —

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

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
95
96
97
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 43

def (, external_event_id, list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListAssociationsApi.associate_by_external_account_and_event_ids ...'
  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 ListAssociationsApi.associate_by_external_account_and_event_ids"
  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 ListAssociationsApi.associate_by_external_account_and_event_ids"
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ListAssociationsApi.associate_by_external_account_and_event_ids"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}'.sub('{' + 'externalAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'listId' + '}', CGI.escape(list_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 => :"ListAssociationsApi.associate_by_external_account_and_event_ids",
    :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: ListAssociationsApi#associate_by_external_account_and_event_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#associate_by_marketing_event_id(marketing_event_id, list_id, opts = {}) ⇒ nil

Associate a list with a marketing event Associates a list with a marketing event by marketing event id and ILS list id

Parameters:

  • marketing_event_id (String) —

    The internal id of the marketing event in HubSpot.

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

  • (nil) 


105
106
107
108
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 105

def associate_by_marketing_event_id(marketing_event_id, list_id, opts = {})
  associate_by_marketing_event_id_with_http_info(marketing_event_id, list_id, opts)
  nil
end

#associate_by_marketing_event_id_with_http_info(marketing_event_id, list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Associate a list with a marketing event Associates a list with a marketing event by marketing event id and ILS list id

Parameters:

  • marketing_event_id (String) —

    The internal id of the marketing event in HubSpot.

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
162
163
164
165
166
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 116

def associate_by_marketing_event_id_with_http_info(marketing_event_id, list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListAssociationsApi.associate_by_marketing_event_id ...'
  end
  # verify the required parameter 'marketing_event_id' is set
  if @api_client.config.client_side_validation && marketing_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketing_event_id' when calling ListAssociationsApi.associate_by_marketing_event_id"
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ListAssociationsApi.associate_by_marketing_event_id"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}'.sub('{' + 'marketingEventId' + '}', CGI.escape(marketing_event_id.to_s)).sub('{' + 'listId' + '}', CGI.escape(list_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 => :"ListAssociationsApi.associate_by_marketing_event_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListAssociationsApi#associate_by_marketing_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Disassociate a list from a marketing event Disassociates a list from a marketing event by external account id, external event id, and ILS list id

Parameters:

  • external_account_id (String) —

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

  • external_event_id (String) —

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

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

  • (nil) 


175
176
177
178
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 175

def (, external_event_id, list_id, opts = {})
  (, external_event_id, list_id, opts)
  nil
end

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

Disassociate a list from a marketing event Disassociates a list from a marketing event by external account id, external event id, and ILS list id

Parameters:

  • external_account_id (String) —

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

  • external_event_id (String) —

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

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 187

def (, external_event_id, list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListAssociationsApi.disassociate_by_external_account_and_event_ids ...'
  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 ListAssociationsApi.disassociate_by_external_account_and_event_ids"
  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 ListAssociationsApi.disassociate_by_external_account_and_event_ids"
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ListAssociationsApi.disassociate_by_external_account_and_event_ids"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}'.sub('{' + 'externalAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'listId' + '}', CGI.escape(list_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 => :"ListAssociationsApi.disassociate_by_external_account_and_event_ids",
    :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: ListAssociationsApi#disassociate_by_external_account_and_event_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#disassociate_by_marketing_event_id(marketing_event_id, list_id, opts = {}) ⇒ nil

Disassociate a list from a marketing event Disassociates a list from a marketing event by marketing event id and ILS list id

Parameters:

  • marketing_event_id (String) —

    The internal id of the marketing event in HubSpot.

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

  • (nil) 


249
250
251
252
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 249

def disassociate_by_marketing_event_id(marketing_event_id, list_id, opts = {})
  disassociate_by_marketing_event_id_with_http_info(marketing_event_id, list_id, opts)
  nil
end

#disassociate_by_marketing_event_id_with_http_info(marketing_event_id, list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disassociate a list from a marketing event Disassociates a list from a marketing event by marketing event id and ILS list id

Parameters:

  • marketing_event_id (String) —

    The internal id of the marketing event in HubSpot.

  • list_id (String) —

    The ILS ID of the list.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 260

def disassociate_by_marketing_event_id_with_http_info(marketing_event_id, list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListAssociationsApi.disassociate_by_marketing_event_id ...'
  end
  # verify the required parameter 'marketing_event_id' is set
  if @api_client.config.client_side_validation && marketing_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketing_event_id' when calling ListAssociationsApi.disassociate_by_marketing_event_id"
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ListAssociationsApi.disassociate_by_marketing_event_id"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}'.sub('{' + 'marketingEventId' + '}', CGI.escape(marketing_event_id.to_s)).sub('{' + 'listId' + '}', CGI.escape(list_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 => :"ListAssociationsApi.disassociate_by_marketing_event_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: ListAssociationsApi#disassociate_by_marketing_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_by_external_account_and_event_ids(external_account_id, external_event_id, opts = {}) ⇒ CollectionResponseWithTotalPublicListNoPaging

Get lists associated with a marketing event Gets lists associated with a marketing event by external account id and external event id

Parameters:

  • external_account_id (String) —

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

  • external_event_id (String) —

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

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 318

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

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

Get lists associated with a marketing event Gets lists associated with a marketing event by external account id and external event id

Parameters:

  • external_account_id (String) —

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

  • external_event_id (String) —

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

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

    the optional parameters

Returns:



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

def (, external_event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListAssociationsApi.get_all_by_external_account_and_event_ids ...'
  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 ListAssociationsApi.get_all_by_external_account_and_event_ids"
  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 ListAssociationsApi.get_all_by_external_account_and_event_ids"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists'.sub('{' + 'externalAccountId' + '}', CGI.escape(.to_s)).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', '*/*'])

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

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

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

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

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

#get_all_by_marketing_event_id(marketing_event_id, opts = {}) ⇒ CollectionResponseWithTotalPublicListNoPaging

Get lists associated with a marketing event Gets lists associated with a marketing event by marketing event id

Parameters:

  • marketing_event_id (String) —

    The internal id of the marketing event in HubSpot.

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

    the optional parameters

Returns:



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

def get_all_by_marketing_event_id(marketing_event_id, opts = {})
  data, _status_code, _headers = get_all_by_marketing_event_id_with_http_info(marketing_event_id, opts)
  data
end

#get_all_by_marketing_event_id_with_http_info(marketing_event_id, opts = {}) ⇒ Array<(CollectionResponseWithTotalPublicListNoPaging, Integer, Hash)>

Get lists associated with a marketing event Gets lists associated with a marketing event by marketing event id

Parameters:

  • marketing_event_id (String) —

    The internal id of the marketing event in HubSpot.

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

    the optional parameters

Returns:



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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/hubspot/codegen/marketing/events/api/list_associations_api.rb', line 396

def get_all_by_marketing_event_id_with_http_info(marketing_event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListAssociationsApi.get_all_by_marketing_event_id ...'
  end
  # verify the required parameter 'marketing_event_id' is set
  if @api_client.config.client_side_validation && marketing_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketing_event_id' when calling ListAssociationsApi.get_all_by_marketing_event_id"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/associations/{marketingEventId}/lists'.sub('{' + 'marketingEventId' + '}', CGI.escape(marketing_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', '*/*'])

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

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

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

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

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