class Hubspot::Marketing::Transactional::DefaultApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 21
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

archive_token(token_id, opts = {}) click to toggle source

Delete a single token by ID. Delete a single token by ID. @param token_id [String] Identifier generated when a token is created. @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

Delete a single token by ID. Delete a single token by ID. @param token_id [String] Identifier generated when a token is created. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

Create a SMTP API token. Create a SMTP API token. @param [Hash] opts the optional parameters @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails. @return [SmtpApiTokenView]

# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 91
def create_token(opts = {})
  data, _status_code, _headers = create_token_with_http_info(opts)
  data
end
create_token_with_http_info(opts = {}) click to toggle source

Create a SMTP API token. Create a SMTP API token. @param [Hash] opts the optional parameters @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails. @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers

# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 101
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 = {}) click to toggle source

Query a single token by ID. Query a single token by ID. @param token_id [String] Identifier generated when a token is created. @param [Hash] opts the optional parameters @return [SmtpApiTokenView]

# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 151
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 = {}) click to toggle source

Query a single token by ID. Query a single token by ID. @param token_id [String] Identifier generated when a token is created. @param [Hash] opts the optional parameters @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers

# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 161
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 = {}) click to toggle source

Query SMTP API tokens by campaign name or an emailCampaignId. Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId. @param [Hash] opts the optional parameters @option opts [String] :campaign_name A name for the campaign tied to the SMTP API token. @option opts [String] :email_campaign_id Identifier assigned to the campaign provided during the token creation. @option opts [String] :after Starting point to get the next set of results. @option opts [Integer] :limit Maximum number of tokens to return. @return [CollectionResponseSmtpApiTokenView]

# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 216
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 = {}) click to toggle source

Query SMTP API tokens by campaign name or an emailCampaignId. Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId. @param [Hash] opts the optional parameters @option opts [String] :campaign_name A name for the campaign tied to the SMTP API token. @option opts [String] :email_campaign_id Identifier assigned to the campaign provided during the token creation. @option opts [String] :after Starting point to get the next set of results. @option opts [Integer] :limit Maximum number of tokens to return. @return [Array<(CollectionResponseSmtpApiTokenView, Integer, Hash)>] CollectionResponseSmtpApiTokenView data, response status code and response headers

# File lib/hubspot/codegen/marketing/transactional/api/default_api.rb, line 229
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 = {}) click to toggle source

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. @param token_id [String] Identifier generated when a token is created. @param [Hash] opts the optional parameters @return [SmtpApiTokenView]

# 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 = {}) click to toggle source

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. @param token_id [String] Identifier generated when a token is created. @param [Hash] opts the optional parameters @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers

# 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 = {}) click to toggle source

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. @param [Hash] opts the optional parameters @option opts [PublicSingleSendRequestEgg] :public_single_send_request_egg A request object describing the email to send. @return [EmailSendStatusView]

# 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 = {}) click to toggle source

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. @param [Hash] opts the optional parameters @option opts [PublicSingleSendRequestEgg] :public_single_send_request_egg A request object describing the email to send. @return [Array<(EmailSendStatusView, Integer, Hash)>] EmailSendStatusView data, response status code and response headers

# 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