Class: Hubspot::Marketing::Transactional::DefaultApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



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

def api_client
  @api_client
end

Instance Method Details

#archive_token(token_id, opts = {}) ⇒ nil

Delete a single token by ID. Delete a single token by ID.

Parameters:

  • token_id (String) —

    Identifier generated when a token is created.

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

    the optional parameters

Returns:

  • (nil) 


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

def archive_token(token_id, opts = {})
  archive_token_with_http_info(token_id, opts)
  nil
end

#archive_token_with_http_info(token_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a single token by ID. Delete a single token by ID.

Parameters:

  • token_id (String) —

    Identifier generated when a token is created.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 39

def archive_token_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.archive_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling DefaultApi.archive_token"
  end
  # resource path
  local_var_path = '/marketing/v3/transactional/smtp-tokens/{tokenId}'.sub('{' + 'tokenId' + '}', CGI.escape(token_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']

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

#create_token(opts = {}) ⇒ SmtpApiTokenView

Create a SMTP API token. Create a SMTP API token.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :smtp_api_token_request_egg (SmtpApiTokenRequestEgg) —

    A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.

Returns:



221
222
223
224
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 221

def create_token(opts = {})
  data, _status_code, _headers = create_token_with_http_info(opts)
  data
end

#create_token_with_http_info(opts = {}) ⇒ Array<(SmtpApiTokenView, Integer, Hash)>

Create a SMTP API token. Create a SMTP API token.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :smtp_api_token_request_egg (SmtpApiTokenRequestEgg) —

    A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.

Returns:

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

    SmtpApiTokenView data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 231

def create_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_token ...'
  end
  # resource path
  local_var_path = '/marketing/v3/transactional/smtp-tokens'

  # 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[:'smtp_api_token_request_egg']) 

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

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

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

#get_token_by_id(token_id, opts = {}) ⇒ SmtpApiTokenView

Query a single token by ID. Query a single token by ID.

Parameters:

  • token_id (String) —

    Identifier generated when a token is created.

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 91

def get_token_by_id(token_id, opts = {})
  data, _status_code, _headers = get_token_by_id_with_http_info(token_id, opts)
  data
end

#get_token_by_id_with_http_info(token_id, opts = {}) ⇒ Array<(SmtpApiTokenView, Integer, Hash)>

Query a single token by ID. Query a single token by ID.

Parameters:

  • token_id (String) —

    Identifier generated when a token is created.

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

    the optional parameters

Returns:

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

    SmtpApiTokenView data, response status code and response headers



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
143
144
145
146
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 101

def get_token_by_id_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_token_by_id ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling DefaultApi.get_token_by_id"
  end
  # resource path
  local_var_path = '/marketing/v3/transactional/smtp-tokens/{tokenId}'.sub('{' + 'tokenId' + '}', CGI.escape(token_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] || 'SmtpApiTokenView' 

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

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

#get_tokens_page(opts = {}) ⇒ CollectionResponseSmtpApiTokenView

Query SMTP API tokens by campaign name or an emailCampaignId. Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :campaign_name (String) —

    A name for the campaign tied to the SMTP API token.

  • :email_campaign_id (String) —

    Identifier assigned to the campaign provided during the token creation.

  • :after (String) —

    Starting point to get the next set of results.

  • :limit (Integer) —

    Maximum number of tokens to return.

Returns:



156
157
158
159
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 156

def get_tokens_page(opts = {})
  data, _status_code, _headers = get_tokens_page_with_http_info(opts)
  data
end

#get_tokens_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponseSmtpApiTokenView, Integer, Hash)>

Query SMTP API tokens by campaign name or an emailCampaignId. Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :campaign_name (String) —

    A name for the campaign tied to the SMTP API token.

  • :email_campaign_id (String) —

    Identifier assigned to the campaign provided during the token creation.

  • :after (String) —

    Starting point to get the next set of results.

  • :limit (Integer) —

    Maximum number of tokens to return.

Returns:



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
211
212
213
214
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 169

def get_tokens_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tokens_page ...'
  end
  # resource path
  local_var_path = '/marketing/v3/transactional/smtp-tokens'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'campaignName'] = opts[:'campaign_name'] if !opts[:'campaign_name'].nil?
  query_params[:'emailCampaignId'] = opts[:'email_campaign_id'] if !opts[:'email_campaign_id'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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] || 'CollectionResponseSmtpApiTokenView' 

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

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

#reset_password(token_id, opts = {}) ⇒ SmtpApiTokenView

Reset the password of an existing token. Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.

Parameters:

  • token_id (String) —

    Identifier generated when a token is created.

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 281

def reset_password(token_id, opts = {})
  data, _status_code, _headers = reset_password_with_http_info(token_id, opts)
  data
end

#reset_password_with_http_info(token_id, opts = {}) ⇒ Array<(SmtpApiTokenView, Integer, Hash)>

Reset the password of an existing token. Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.

Parameters:

  • token_id (String) —

    Identifier generated when a token is created.

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

    the optional parameters

Returns:

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

    SmtpApiTokenView data, response status code and response headers



291
292
293
294
295
296
297
298
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
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 291

def reset_password_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.reset_password ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling DefaultApi.reset_password"
  end
  # resource path
  local_var_path = '/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset'.sub('{' + 'tokenId' + '}', CGI.escape(token_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] || 'SmtpApiTokenView' 

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

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

#send_email(opts = {}) ⇒ EmailSendStatusView

Send a single transactional email asynchronously. Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



343
344
345
346
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 343

def send_email(opts = {})
  data, _status_code, _headers = send_email_with_http_info(opts)
  data
end

#send_email_with_http_info(opts = {}) ⇒ Array<(EmailSendStatusView, Integer, Hash)>

Send a single transactional email asynchronously. Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailSendStatusView data, response status code and response headers



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/hubspot/codegen/marketing/transactional/api/default_api.rb', line 353

def send_email_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_email ...'
  end
  # resource path
  local_var_path = '/marketing/v3/transactional/single-email/send'

  # 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[:'public_single_send_request_egg']) 

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

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