Class: Hubspot::Marketing::Events::BatchApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchApi

Returns a new instance of BatchApi.



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

def api_client
  @api_client
end

Instance Method Details

#archive(batch_input_marketing_event_external_unique_identifier, opts = {}) ⇒ Error

Delete multiple marketing events Bulk delete a number of marketing events in HubSpot

Parameters:

Returns:



29
30
31
32
 
# File 'lib/hubspot/codegen/marketing/events/api/batch_api.rb', line 29

def archive(batch_input_marketing_event_external_unique_identifier, opts = {})
  data, _status_code, _headers = archive_with_http_info(batch_input_marketing_event_external_unique_identifier, opts)
  data
end

#archive_with_http_info(batch_input_marketing_event_external_unique_identifier, opts = {}) ⇒ Array<(Error, Integer, Hash)>

Delete multiple marketing events Bulk delete a number of marketing events in HubSpot

Parameters:

Returns:

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

    Error 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
83
84
85
86
 
# File 'lib/hubspot/codegen/marketing/events/api/batch_api.rb', line 39

def archive_with_http_info(batch_input_marketing_event_external_unique_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
  end
  # verify the required parameter 'batch_input_marketing_event_external_unique_identifier' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_external_unique_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_external_unique_identifier' when calling BatchApi.archive"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/delete'

  # 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(['*/*'])
  # 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(batch_input_marketing_event_external_unique_identifier) 

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

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

#do_upsert(batch_input_marketing_event_create_request_params, opts = {}) ⇒ BatchResponseMarketingEventPublicDefaultResponse

Create or update multiple marketing events Upset multiple Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.

Parameters:

Returns:



93
94
95
96
 
# File 'lib/hubspot/codegen/marketing/events/api/batch_api.rb', line 93

def do_upsert(batch_input_marketing_event_create_request_params, opts = {})
  data, _status_code, _headers = do_upsert_with_http_info(batch_input_marketing_event_create_request_params, opts)
  data
end

#do_upsert_with_http_info(batch_input_marketing_event_create_request_params, opts = {}) ⇒ Array<(BatchResponseMarketingEventPublicDefaultResponse, Integer, Hash)>

Create or update multiple marketing events Upset multiple Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.

Parameters:

Returns:



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
143
144
145
146
147
148
149
150
 
# File 'lib/hubspot/codegen/marketing/events/api/batch_api.rb', line 103

def do_upsert_with_http_info(batch_input_marketing_event_create_request_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.do_upsert ...'
  end
  # verify the required parameter 'batch_input_marketing_event_create_request_params' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_create_request_params.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_create_request_params' when calling BatchApi.do_upsert"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/upsert'

  # 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(batch_input_marketing_event_create_request_params) 

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

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