Class: CloudmersiveValidateApiClient::LeadEnrichmentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LeadEnrichmentApi

Returns a new instance of LeadEnrichmentApi.



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#lead_enrichment_enrich_lead(request, opts = {}) ⇒ LeadEnrichmentResponse

Enrich an input lead with additional fields of data

Parameters:

  • request —

    Input lead with known fields set, and unknown fields left blank (null)

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb', line 26

def lead_enrichment_enrich_lead(request, opts = {})
  data, _status_code, _headers = lead_enrichment_enrich_lead_with_http_info(request, opts)
  data
end

#lead_enrichment_enrich_lead_with_http_info(request, opts = {}) ⇒ Array<(LeadEnrichmentResponse, Fixnum, Hash)>

Enrich an input lead with additional fields of data

Parameters:

  • request —

    Input lead with known fields set, and unknown fields left blank (null)

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

    the optional parameters

Returns:

  • (Array<(LeadEnrichmentResponse, Fixnum, Hash)>) —

    LeadEnrichmentResponse data, response status code and response headers



35
36
37
38
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
 
# File 'lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb', line 35

def lead_enrichment_enrich_lead_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeadEnrichmentApi.lead_enrichment_enrich_lead ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling LeadEnrichmentApi.lead_enrichment_enrich_lead"
  end
  # resource path
  local_var_path = '/validate/lead-enrichment/lead/enrich'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LeadEnrichmentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LeadEnrichmentApi#lead_enrichment_enrich_lead\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lead_enrichment_get_company_information(request, opts = {}) ⇒ LeadEnrichmentResponse

Get company information from email address

Parameters:

  • request —

    Input email address lead

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb', line 78

def lead_enrichment_get_company_information(request, opts = {})
  data, _status_code, _headers = lead_enrichment_get_company_information_with_http_info(request, opts)
  data
end

#lead_enrichment_get_company_information_with_http_info(request, opts = {}) ⇒ Array<(LeadEnrichmentResponse, Fixnum, Hash)>

Get company information from email address

Parameters:

  • request —

    Input email address lead

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

    the optional parameters

Returns:

  • (Array<(LeadEnrichmentResponse, Fixnum, Hash)>) —

    LeadEnrichmentResponse data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb', line 87

def lead_enrichment_get_company_information_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeadEnrichmentApi.lead_enrichment_get_company_information ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling LeadEnrichmentApi.lead_enrichment_get_company_information"
  end
  # resource path
  local_var_path = '/validate/lead-enrichment/lead/email/company-information'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LeadEnrichmentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LeadEnrichmentApi#lead_enrichment_get_company_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end