Class: Hubspot::Crm::Timeline::TemplatesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TemplatesApi

Returns a new instance of TemplatesApi.



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

def api_client
  @api_client
end

Instance Method Details

#archive_event_template(event_template_id, app_id, opts = {}) ⇒ nil

Deletes an event template for the app This will delete the event template. All events associated with it will be removed from search and the timeline UI. There is no recovery from this option, so it’s highly recommended that you stop using any events for a template before deleting it.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

  • (nil) 


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

def archive_event_template(event_template_id, app_id, opts = {})
  archive_event_template_with_http_info(event_template_id, app_id, opts)
  nil
end

#archive_event_template_with_http_info(event_template_id, app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes an event template for the app This will delete the event template. All events associated with it will be removed from search and the timeline UI. There is no recovery from this option, so it&#39;s highly recommended that you stop using any events for a template before deleting it.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
83
84
85
86
87
88
89
90
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 41

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

  # return_type
  return_type = opts[:return_type] 

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplatesApi#archive_event_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_event_template(app_id, opts = {}) ⇒ TimelineEventTemplate

Create an event template for your app Event templates define the general structure for a custom timeline event. This includes formatted copy for its heading and details, as well as any custom property definitions. The event could be something like viewing a video, registering for a webinar, or filling out a survey. A single app can define multiple event templates. Event templates will be created for contacts by default, but they can be created for companies and deals as well. Each event template contains its own set of tokens and ‘Markdown` templates. These tokens can be associated with any CRM object properties via the `objectPropertyName` field to fully build out CRM objects. You must create an event template before you can create events.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Options Hash (opts):

Returns:



98
99
100
101
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 98

def create_event_template(app_id, opts = {})
  data, _status_code, _headers = create_event_template_with_http_info(app_id, opts)
  data
end

#create_event_template_with_http_info(app_id, opts = {}) ⇒ Array<(TimelineEventTemplate, Integer, Hash)>

Create an event template for your app Event templates define the general structure for a custom timeline event. This includes formatted copy for its heading and details, as well as any custom property definitions. The event could be something like viewing a video, registering for a webinar, or filling out a survey. A single app can define multiple event templates. Event templates will be created for contacts by default, but they can be created for companies and deals as well. Each event template contains its own set of tokens and &#x60;Markdown&#x60; templates. These tokens can be associated with any CRM object properties via the &#x60;objectPropertyName&#x60; field to fully build out CRM objects. You must create an event template before you can create events.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TimelineEventTemplate data, response status code and response headers



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 109

def create_event_template_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TemplatesApi.create_event_template ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling TemplatesApi.create_event_template"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/{appId}/event-templates'.sub('{' + 'appId' + '}', CGI.escape(app_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'
  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_template_create_request']) 

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

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

#get_all_event_templates(app_id, opts = {}) ⇒ CollectionResponseTimelineEventTemplate

List all event templates for your app Use this to list all event templates owned by your app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 163

def get_all_event_templates(app_id, opts = {})
  data, _status_code, _headers = get_all_event_templates_with_http_info(app_id, opts)
  data
end

#get_all_event_templates_with_http_info(app_id, opts = {}) ⇒ Array<(CollectionResponseTimelineEventTemplate, Integer, Hash)>

List all event templates for your app Use this to list all event templates owned by your app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



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
211
212
213
214
215
216
217
218
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 173

def get_all_event_templates_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TemplatesApi.get_all_event_templates ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling TemplatesApi.get_all_event_templates"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/{appId}/event-templates'.sub('{' + 'appId' + '}', CGI.escape(app_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] || 'CollectionResponseTimelineEventTemplate' 

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

#get_event_template_by_id(event_template_id, app_id, opts = {}) ⇒ TimelineEventTemplate

Gets a specific event template for your app View the current state of a specific template and its tokens.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 226

def get_event_template_by_id(event_template_id, app_id, opts = {})
  data, _status_code, _headers = get_event_template_by_id_with_http_info(event_template_id, app_id, opts)
  data
end

#get_event_template_by_id_with_http_info(event_template_id, app_id, opts = {}) ⇒ Array<(TimelineEventTemplate, Integer, Hash)>

Gets a specific event template for your app View the current state of a specific template and its tokens.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    TimelineEventTemplate data, response status code and response headers



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
279
280
281
282
283
284
285
286
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 237

def get_event_template_by_id_with_http_info(event_template_id, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TemplatesApi.get_event_template_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 TemplatesApi.get_event_template_by_id"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling TemplatesApi.get_event_template_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/{appId}/event-templates/{eventTemplateId}'.sub('{' + 'eventTemplateId' + '}', CGI.escape(event_template_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_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] || 'TimelineEventTemplate' 

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

#update_event_template(event_template_id, app_id, opts = {}) ⇒ TimelineEventTemplate

Update an existing event template Updates an existing template and its tokens. This is primarily used to update the headerTemplate/detailTemplate, and those changes will take effect for existing events. You can also update or replace all the tokens in the template here instead of doing individual API calls on the ‘/tokens` endpoint.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Options Hash (opts):

Returns:



295
296
297
298
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 295

def update_event_template(event_template_id, app_id, opts = {})
  data, _status_code, _headers = update_event_template_with_http_info(event_template_id, app_id, opts)
  data
end

#update_event_template_with_http_info(event_template_id, app_id, opts = {}) ⇒ Array<(TimelineEventTemplate, Integer, Hash)>

Update an existing event template Updates an existing template and its tokens. This is primarily used to update the headerTemplate/detailTemplate, and those changes will take effect for existing events. You can also update or replace all the tokens in the template here instead of doing individual API calls on the &#x60;/tokens&#x60; endpoint.

Parameters:

  • event_template_id (String) —

    The event template ID.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TimelineEventTemplate data, response status code and response headers



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
352
353
354
355
356
357
358
 
# File 'lib/hubspot/codegen/crm/timeline/api/templates_api.rb', line 307

def update_event_template_with_http_info(event_template_id, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TemplatesApi.update_event_template ...'
  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 TemplatesApi.update_event_template"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling TemplatesApi.update_event_template"
  end
  # resource path
  local_var_path = '/crm/v3/timeline/{appId}/event-templates/{eventTemplateId}'.sub('{' + 'eventTemplateId' + '}', CGI.escape(event_template_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_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'
  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_template_update_request']) 

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

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplatesApi#update_event_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end