class Hubspot::Crm::Timeline::EventsApi
Attributes
Public Class Methods
# File lib/hubspot/codegen/crm/timeline/api/events_api.rb, line 21 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param [Hash] opts the optional parameters @option opts [TimelineEvent] :timeline_event The timeline event definition. @return [TimelineEventResponse]
# 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
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. @param [Hash] opts the optional parameters @option opts [BatchInputTimelineEvent] :batch_input_timeline_event The timeline event definition. @return [BatchResponseTimelineEventResponse]
# 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
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. @param [Hash] opts the optional parameters @option opts [BatchInputTimelineEvent] :batch_input_timeline_event The timeline event definition. @return [Array<(BatchResponseTimelineEventResponse
, Integer, Hash)>] BatchResponseTimelineEventResponse
data, response status code and response headers
# 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 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. @param [Hash] opts the optional parameters @option opts [TimelineEvent] :timeline_event The timeline event definition. @return [Array<(TimelineEventResponse
, Integer, Hash)>] TimelineEventResponse
data, response status code and response headers
# 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
Gets the event This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object. @param event_template_id [String] The event template ID. @param event_id [String] The event ID. @param [Hash] opts the optional parameters @return [TimelineEventResponse]
# 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
Gets the event This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object. @param event_template_id [String] The event template ID. @param event_id [String] The event ID. @param [Hash] opts the optional parameters @return [Array<(TimelineEventResponse
, Integer, Hash)>] TimelineEventResponse
data, response status code and response headers
# 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
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. @param event_template_id [String] The event template ID. @param event_id [String] The event ID. @param [Hash] opts the optional parameters @return [EventDetail]
# 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
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. @param event_template_id [String] The event template ID. @param event_id [String] The event ID. @param [Hash] opts the optional parameters @return [Array<(EventDetail
, Integer, Hash)>] EventDetail
data, response status code and response headers
# 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
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. @param event_template_id [String] The event template ID. @param event_id [String] The event ID. @param [Hash] opts the optional parameters @option opts [Boolean] :detail Set to 'true', we want to render the `detailTemplate` instead of the `headerTemplate`. @return [String]
# 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
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. @param event_template_id [String] The event template ID. @param event_id [String] The event ID. @param [Hash] opts the optional parameters @option opts [Boolean] :detail Set to 'true', we want to render the `detailTemplate` instead of the `headerTemplate`. @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
# 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