Class: Hubspot::Crm::Timeline::EventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/timeline/api/events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_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/crm/timeline/api/events_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#create(opts = {}) ⇒ TimelineEventResponse

Create a single event Creates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via ‘objectPropertyName`, this call will also attempt to updates those properties, or add them if they don’t exist.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :timeline_event (TimelineEvent) —

    The timeline event definition.

Returns:



29
30
31
32
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 29

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

#create_batch(opts = {}) ⇒ BatchResponseTimelineEventResponse

Creates multiple events Creates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via ‘objectPropertyName`, this call will also attempt to updates those properties, or add them if they don’t exist.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



89
90
91
92
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 89

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

#create_batch_with_http_info(opts = {}) ⇒ Array<(BatchResponseTimelineEventResponse, Integer, Hash)>

Creates multiple events Creates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via &#x60;objectPropertyName&#x60;, this call will also attempt to updates those properties, or add them if they don&#39;t exist.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 99

def create_batch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.create_batch ...'
  end
  # resource path
  local_var_path = '/crm/v3/timeline/events/batch/create'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_timeline_event']) 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#create_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a single event Creates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via &#x60;objectPropertyName&#x60;, this call will also attempt to updates those properties, or add them if they don&#39;t exist.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :timeline_event (TimelineEvent) —

    The timeline event definition.

Returns:

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

    TimelineEventResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 39

def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.create ...'
  end
  # resource path
  local_var_path = '/crm/v3/timeline/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'timeline_event']) 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(event_template_id, event_id, opts = {}) ⇒ TimelineEventResponse

Gets the event This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • event_id (String) —

    The event ID.

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 150

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

#get_by_id_with_http_info(event_template_id, event_id, opts = {}) ⇒ Array<(TimelineEventResponse, Integer, Hash)>

Gets the event This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • event_id (String) —

    The event ID.

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

    the optional parameters

Returns:

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

    TimelineEventResponse data, response status code and response headers



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
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
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 161

def get_by_id_with_http_info(event_template_id, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.get_by_id ...'
  end
  # verify the required parameter 'event_template_id' is set
  if @api_client.config.client_side_validation && event_template_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_template_id' when calling EventsApi.get_by_id"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling EventsApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/events/{eventTemplateId}/{eventId}'.sub('{' + 'eventTemplateId' + '}', CGI.escape(event_template_id.to_s)).sub('{' + 'eventId' + '}', CGI.escape(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[:body] 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_detail_by_id(event_template_id, event_id, opts = {}) ⇒ EventDetail

Gets the detailTemplate as rendered This will take the ‘detailTemplate` from the event template and return an object rendering the specified event. If the template references `extraData` that isn’t found in the event, it will be ignored and we’ll render without it.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • event_id (String) —

    The event ID.

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

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 218

def get_detail_by_id(event_template_id, event_id, opts = {})
  data, _status_code, _headers = get_detail_by_id_with_http_info(event_template_id, event_id, opts)
  data
end

#get_detail_by_id_with_http_info(event_template_id, event_id, opts = {}) ⇒ Array<(EventDetail, Integer, Hash)>

Gets the detailTemplate as rendered This will take the &#x60;detailTemplate&#x60; from the event template and return an object rendering the specified event. If the template references &#x60;extraData&#x60; that isn&#39;t found in the event, it will be ignored and we&#39;ll render without it.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • event_id (String) —

    The event ID.

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

    the optional parameters

Returns:

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

    EventDetail data, response status code and response headers



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
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 229

def get_detail_by_id_with_http_info(event_template_id, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.get_detail_by_id ...'
  end
  # verify the required parameter 'event_template_id' is set
  if @api_client.config.client_side_validation && event_template_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_template_id' when calling EventsApi.get_detail_by_id"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling EventsApi.get_detail_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/events/{eventTemplateId}/{eventId}/detail'.sub('{' + 'eventTemplateId' + '}', CGI.escape(event_template_id.to_s)).sub('{' + 'eventId' + '}', CGI.escape(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[:body] 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#get_detail_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_render_by_id(event_template_id, event_id, opts = {}) ⇒ String

Renders the header or detail as HTML This will take either the ‘headerTemplate` or `detailTemplate` from the event template and render for the specified event as HTML. If the template references `extraData` that isn’t found in the event, it will be ignored and we’ll render without it.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • event_id (String) —

    The event ID.

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

    the optional parameters

Options Hash (opts):

  • :detail (Boolean) —

    Set to &#39;true&#39;, we want to render the &#x60;detailTemplate&#x60; instead of the &#x60;headerTemplate&#x60;.

Returns:

  • (String) 


287
288
289
290
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 287

def get_render_by_id(event_template_id, event_id, opts = {})
  data, _status_code, _headers = get_render_by_id_with_http_info(event_template_id, event_id, opts)
  data
end

#get_render_by_id_with_http_info(event_template_id, event_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Renders the header or detail as HTML This will take either the &#x60;headerTemplate&#x60; or &#x60;detailTemplate&#x60; from the event template and render for the specified event as HTML. If the template references &#x60;extraData&#x60; that isn&#39;t found in the event, it will be ignored and we&#39;ll render without it.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • event_id (String) —

    The event ID.

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

    the optional parameters

Options Hash (opts):

  • :detail (Boolean) —

    Set to &#39;true&#39;, we want to render the &#x60;detailTemplate&#x60; instead of the &#x60;headerTemplate&#x60;.

Returns:

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

    String data, response status code and response headers



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
349
 
# File 'lib/hubspot/codegen/crm/timeline/api/events_api.rb', line 299

def get_render_by_id_with_http_info(event_template_id, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.get_render_by_id ...'
  end
  # verify the required parameter 'event_template_id' is set
  if @api_client.config.client_side_validation && event_template_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_template_id' when calling EventsApi.get_render_by_id"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling EventsApi.get_render_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/events/{eventTemplateId}/{eventId}/render'.sub('{' + 'eventTemplateId' + '}', CGI.escape(event_template_id.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/html', '*/*'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#get_render_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end