Class: Hubspot::Marketing::Events::AddEventAttendeesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddEventAttendeesApi

Returns a new instance of AddEventAttendeesApi.



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

def api_client
  @api_client
end

Instance Method Details

#record_by_contact_emails(external_event_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {}) ⇒ BatchResponseSubscriberEmailResponse

Record Participants by Email with Marketing Event External Ids Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt

Parameters:

  • external_event_id (String) —

    The id of the marketing event in the external event application

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.

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

    the optional parameters

Options Hash (opts):

  • :external_account_id (String) —

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

Returns:



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

def record_by_contact_emails(external_event_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {})
  data, _status_code, _headers = record_by_contact_emails_with_http_info(external_event_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts)
  data
end

#record_by_contact_emails_with_http_info(external_event_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {}) ⇒ Array<(BatchResponseSubscriberEmailResponse, Integer, Hash)>

Record Participants by Email with Marketing Event External Ids Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state &quot;attend&quot;: - joinedAt - leftAt

Parameters:

  • external_event_id (String) —

    The id of the marketing event in the external event application

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

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

    the optional parameters

Options Hash (opts):

  • :external_account_id (String) —

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

Returns:



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
98
99
100
101
102
103
104
105
 
# File 'lib/hubspot/codegen/marketing/events/api/add_event_attendees_api.rb', line 45

def record_by_contact_emails_with_http_info(external_event_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddEventAttendeesApi.record_by_contact_emails ...'
  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 AddEventAttendeesApi.record_by_contact_emails"
  end
  # verify the required parameter 'subscriber_state' is set
  if @api_client.config.client_side_validation && subscriber_state.nil?
    fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling AddEventAttendeesApi.record_by_contact_emails"
  end
  # verify the required parameter 'batch_input_marketing_event_email_subscriber' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_email_subscriber.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_email_subscriber' when calling AddEventAttendeesApi.record_by_contact_emails"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.to_s))

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

  # 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_email_subscriber)

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

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

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

#record_by_contact_id(object_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {}) ⇒ BatchResponseSubscriberVidResponse

Record Participants by ContactId with Marketing Event Object Id Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt

Parameters:

  • object_id (String) —

    The internal id of the marketing event in HubSpot

  • subscriber_state (String) —

    The attendance state value. It may be &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;

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

    the optional parameters

Returns:



114
115
116
117
 
# File 'lib/hubspot/codegen/marketing/events/api/add_event_attendees_api.rb', line 114

def record_by_contact_id(object_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {})
  data, _status_code, _headers = record_by_contact_id_with_http_info(object_id, subscriber_state, batch_input_marketing_event_subscriber, opts)
  data
end

#record_by_contact_id_with_http_info(object_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {}) ⇒ Array<(BatchResponseSubscriberVidResponse, Integer, Hash)>

Record Participants by ContactId with Marketing Event Object Id Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state &quot;attend&quot;: - joinedAt - leftAt

Parameters:

  • object_id (String) —

    The internal id of the marketing event in HubSpot

  • subscriber_state (String) —

    The attendance state value. It may be &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;

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

    the optional parameters

Returns:



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/hubspot/codegen/marketing/events/api/add_event_attendees_api.rb', line 126

def record_by_contact_id_with_http_info(object_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddEventAttendeesApi.record_by_contact_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 AddEventAttendeesApi.record_by_contact_id"
  end
  # verify the required parameter 'subscriber_state' is set
  if @api_client.config.client_side_validation && subscriber_state.nil?
    fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling AddEventAttendeesApi.record_by_contact_id"
  end
  # verify the required parameter 'batch_input_marketing_event_subscriber' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_subscriber.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_subscriber' when calling AddEventAttendeesApi.record_by_contact_id"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.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(batch_input_marketing_event_subscriber)

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

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

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

#record_by_contact_ids(external_event_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {}) ⇒ BatchResponseSubscriberVidResponse

Record Participants by ContactId with Marketing Event External Ids Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt

Parameters:

  • external_event_id (String) —

    The id of the marketing event in the external event application

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

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

    the optional parameters

Options Hash (opts):

  • :external_account_id (String) —

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

Returns:



195
196
197
198
 
# File 'lib/hubspot/codegen/marketing/events/api/add_event_attendees_api.rb', line 195

def record_by_contact_ids(external_event_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {})
  data, _status_code, _headers = record_by_contact_ids_with_http_info(external_event_id, subscriber_state, batch_input_marketing_event_subscriber, opts)
  data
end

#record_by_contact_ids_with_http_info(external_event_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {}) ⇒ Array<(BatchResponseSubscriberVidResponse, Integer, Hash)>

Record Participants by ContactId with Marketing Event External Ids Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state &quot;attend&quot;: - joinedAt - leftAt

Parameters:

  • external_event_id (String) —

    The id of the marketing event in the external event application

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

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

    the optional parameters

Options Hash (opts):

  • :external_account_id (String) —

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

Returns:



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

def record_by_contact_ids_with_http_info(external_event_id, subscriber_state, batch_input_marketing_event_subscriber, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddEventAttendeesApi.record_by_contact_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 AddEventAttendeesApi.record_by_contact_ids"
  end
  # verify the required parameter 'subscriber_state' is set
  if @api_client.config.client_side_validation && subscriber_state.nil?
    fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling AddEventAttendeesApi.record_by_contact_ids"
  end
  # verify the required parameter 'batch_input_marketing_event_subscriber' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_subscriber.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_subscriber' when calling AddEventAttendeesApi.record_by_contact_ids"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.to_s))

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

  # 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_subscriber)

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

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

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

#record_by_email(object_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {}) ⇒ BatchResponseSubscriberEmailResponse

Record Participants by Email with Marketing Event Object Id Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt

Parameters:

  • object_id (String) —

    The internal ID of the marketing event in HubSpot

  • subscriber_state (String) —

    The attendance state value. It may be &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/hubspot/codegen/marketing/events/api/add_event_attendees_api.rb', line 277

def record_by_email(object_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {})
  data, _status_code, _headers = record_by_email_with_http_info(object_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts)
  data
end

#record_by_email_with_http_info(object_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {}) ⇒ Array<(BatchResponseSubscriberEmailResponse, Integer, Hash)>

Record Participants by Email with Marketing Event Object Id Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state &quot;attend&quot;: - joinedAt - leftAt

Parameters:

  • object_id (String) —

    The internal ID of the marketing event in HubSpot

  • subscriber_state (String) —

    The attendance state value. It may be &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;

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

    the optional parameters

Returns:



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

def record_by_email_with_http_info(object_id, subscriber_state, batch_input_marketing_event_email_subscriber, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddEventAttendeesApi.record_by_email ...'
  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 AddEventAttendeesApi.record_by_email"
  end
  # verify the required parameter 'subscriber_state' is set
  if @api_client.config.client_side_validation && subscriber_state.nil?
    fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling AddEventAttendeesApi.record_by_email"
  end
  # verify the required parameter 'batch_input_marketing_event_email_subscriber' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_email_subscriber.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_email_subscriber' when calling AddEventAttendeesApi.record_by_email"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.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(batch_input_marketing_event_email_subscriber)

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

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

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