Class: Hubspot::Marketing::Events::BasicApi
- Inherits:
-
Object
- Object
- Hubspot::Marketing::Events::BasicApi
- Includes:
- Helpers::GetAllHelper
- Defined in:
- lib/hubspot/codegen/marketing/events/api/basic_api.rb
Constant Summary
Constants included from Helpers::GetAllHelper
Helpers::GetAllHelper::MAX_PAGE_SIZE
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(external_event_id, external_account_id, opts = {}) ⇒ nil
Delete a marketing event Deletes an existing Marketing Event with the specified id, if one exists.
-
#archive_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a marketing event Deletes an existing Marketing Event with the specified id, if one exists.
-
#create(marketing_event_create_request_params, opts = {}) ⇒ MarketingEventDefaultResponse
Create a marketing event Creates a new marketing event in HubSpot.
-
#create_with_http_info(marketing_event_create_request_params, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>
Create a marketing event Creates a new marketing event in HubSpot.
-
#do_cancel(external_event_id, external_account_id, opts = {}) ⇒ MarketingEventDefaultResponse
Mark a marketing event as cancelled Mark a marketing event as cancelled.
-
#do_cancel_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>
Mark a marketing event as cancelled Mark a marketing event as cancelled.
-
#get_by_id(external_event_id, external_account_id, opts = {}) ⇒ MarketingEventPublicReadResponse
Get a marketing event Returns the details of the Marketing Event with the specified id, if one exists.
-
#get_by_id_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(MarketingEventPublicReadResponse, Integer, Hash)>
Get a marketing event Returns the details of the Marketing Event with the specified id, if one exists.
-
#initialize(api_client = ApiClient.default) ⇒ BasicApi
constructor
A new instance of BasicApi.
-
#replace(external_event_id, marketing_event_create_request_params, opts = {}) ⇒ MarketingEventPublicDefaultResponse
Create or update a marketing event Upsets a Marketing Event.
-
#replace_with_http_info(external_event_id, marketing_event_create_request_params, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponse, Integer, Hash)>
Create or update a marketing event Upsets a Marketing Event.
-
#update(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) ⇒ MarketingEventPublicDefaultResponse
Update a marketing event Updates an existing Marketing Event with the specified id, if one exists.
-
#update_with_http_info(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponse, Integer, Hash)>
Update a marketing event Updates an existing Marketing Event with the specified id, if one exists.
Methods included from Helpers::GetAllHelper
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
21 22 23 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 21 def api_client @api_client end |
Instance Method Details
#archive(external_event_id, external_account_id, opts = {}) ⇒ nil
Delete a marketing event Deletes an existing Marketing Event with the specified id, if one exists.
32 33 34 35 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 32 def archive(external_event_id, external_account_id, opts = {}) archive_with_http_info(external_event_id, external_account_id, opts) nil end |
#archive_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a marketing event Deletes an existing Marketing Event with the specified id, if one exists.
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 91 92 93 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 43 def archive_with_http_info(external_event_id, external_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.archive ...' 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 BasicApi.archive" end # verify the required parameter 'external_account_id' is set if @api_client.config.client_side_validation && external_account_id.nil? fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.archive" end # resource path local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'externalAccountId'] = external_account_id # 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'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(marketing_event_create_request_params, opts = {}) ⇒ MarketingEventDefaultResponse
Create a marketing event Creates a new marketing event in HubSpot
100 101 102 103 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 100 def create(marketing_event_create_request_params, opts = {}) data, _status_code, _headers = create_with_http_info(marketing_event_create_request_params, opts) data end |
#create_with_http_info(marketing_event_create_request_params, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>
Create a marketing event Creates a new marketing event in HubSpot
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 157 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 110 def create_with_http_info(marketing_event_create_request_params, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.create ...' end # verify the required parameter 'marketing_event_create_request_params' is set if @api_client.config.client_side_validation && marketing_event_create_request_params.nil? fail ArgumentError, "Missing the required parameter 'marketing_event_create_request_params' when calling BasicApi.create" end # resource path local_var_path = '/marketing/v3/marketing-events/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(marketing_event_create_request_params) # return_type return_type = opts[:return_type] || 'MarketingEventDefaultResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#do_cancel(external_event_id, external_account_id, opts = {}) ⇒ MarketingEventDefaultResponse
Mark a marketing event as cancelled Mark a marketing event as cancelled.
165 166 167 168 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 165 def do_cancel(external_event_id, external_account_id, opts = {}) data, _status_code, _headers = do_cancel_with_http_info(external_event_id, external_account_id, opts) data end |
#do_cancel_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(MarketingEventDefaultResponse, Integer, Hash)>
Mark a marketing event as cancelled Mark a marketing event as cancelled.
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 219 220 221 222 223 224 225 226 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 176 def do_cancel_with_http_info(external_event_id, external_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.do_cancel ...' 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 BasicApi.do_cancel" end # verify the required parameter 'external_account_id' is set if @api_client.config.client_side_validation && external_account_id.nil? fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.do_cancel" end # resource path local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/cancel'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'externalAccountId'] = external_account_id # 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] || 'MarketingEventDefaultResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#do_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_by_id(external_event_id, external_account_id, opts = {}) ⇒ MarketingEventPublicReadResponse
Get a marketing event Returns the details of the Marketing Event with the specified id, if one exists.
234 235 236 237 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 234 def get_by_id(external_event_id, external_account_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(external_event_id, external_account_id, opts) data end |
#get_by_id_with_http_info(external_event_id, external_account_id, opts = {}) ⇒ Array<(MarketingEventPublicReadResponse, Integer, Hash)>
Get a marketing event Returns the details of the Marketing Event with the specified id, if one exists.
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 287 288 289 290 291 292 293 294 295 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 245 def get_by_id_with_http_info(external_event_id, external_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...' 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 BasicApi.get_by_id" end # verify the required parameter 'external_account_id' is set if @api_client.config.client_side_validation && external_account_id.nil? fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.get_by_id" end # resource path local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'externalAccountId'] = external_account_id # 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] || 'MarketingEventPublicReadResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#replace(external_event_id, marketing_event_create_request_params, opts = {}) ⇒ MarketingEventPublicDefaultResponse
Create or update a marketing event Upsets a Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.
303 304 305 306 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 303 def replace(external_event_id, marketing_event_create_request_params, opts = {}) data, _status_code, _headers = replace_with_http_info(external_event_id, marketing_event_create_request_params, opts) data end |
#replace_with_http_info(external_event_id, marketing_event_create_request_params, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponse, Integer, Hash)>
Create or update a marketing event Upsets a Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.
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 359 360 361 362 363 364 365 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 314 def replace_with_http_info(external_event_id, marketing_event_create_request_params, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.replace ...' 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 BasicApi.replace" end # verify the required parameter 'marketing_event_create_request_params' is set if @api_client.config.client_side_validation && marketing_event_create_request_params.nil? fail ArgumentError, "Missing the required parameter 'marketing_event_create_request_params' when calling BasicApi.replace" end # resource path local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_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', '*/*']) # 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(marketing_event_create_request_params) # return_type return_type = opts[:return_type] || 'MarketingEventPublicDefaultResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) ⇒ MarketingEventPublicDefaultResponse
Update a marketing event Updates an existing Marketing Event with the specified id, if one exists.
374 375 376 377 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 374 def update(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) data, _status_code, _headers = update_with_http_info(external_event_id, external_account_id, marketing_event_update_request_params, opts) data end |
#update_with_http_info(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) ⇒ Array<(MarketingEventPublicDefaultResponse, Integer, Hash)>
Update a marketing event Updates an existing Marketing Event with the specified id, if one exists.
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/hubspot/codegen/marketing/events/api/basic_api.rb', line 386 def update_with_http_info(external_event_id, external_account_id, marketing_event_update_request_params, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.update ...' 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 BasicApi.update" end # verify the required parameter 'external_account_id' is set if @api_client.config.client_side_validation && external_account_id.nil? fail ArgumentError, "Missing the required parameter 'external_account_id' when calling BasicApi.update" end # verify the required parameter 'marketing_event_update_request_params' is set if @api_client.config.client_side_validation && marketing_event_update_request_params.nil? fail ArgumentError, "Missing the required parameter 'marketing_event_update_request_params' when calling BasicApi.update" end # resource path local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'externalAccountId'] = external_account_id # 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(marketing_event_update_request_params) # return_type return_type = opts[:return_type] || 'MarketingEventPublicDefaultResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |