Class: TripletexRubyClient::CrmprospectApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/crmprospect_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CrmprospectApi

Returns a new instance of CrmprospectApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/crmprospect_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/tripletex_ruby_client/api/crmprospect_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperProspect

Get prospect by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



28
29
30
31
 
# File 'lib/tripletex_ruby_client/api/crmprospect_api.rb', line 28

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  data
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperProspect, Fixnum, Hash)>

Get prospect by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperProspect 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
 
# File 'lib/tripletex_ruby_client/api/crmprospect_api.rb', line 39

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CrmprospectApi.get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CrmprospectApi.get"
  end
  # resource path
  local_var_path = '/crm/prospect/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperProspect')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CrmprospectApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseProspect

Find prospects corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Containing

  • :description (String) —

    Containing

  • :created_date_from (String) —

    From and including

  • :created_date_to (String) —

    To and excluding

  • :customer_id (String) —

    Equals

  • :sales_employee_id (String) —

    Equals

  • :is_closed (BOOLEAN) —

    Equals

  • :closed_reason (String) —

    Equals

  • :closed_date_from (String) —

    From and including

  • :closed_date_to (String) —

    To and excluding

  • :competitor (String) —

    Containing

  • :prospect_type (String) —

    Equals

  • :project_id (String) —

    Equals

  • :project_offer_id (String) —

    Equals

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



97
98
99
100
 
# File 'lib/tripletex_ruby_client/api/crmprospect_api.rb', line 97

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  data
end

#search_with_http_info(opts = {}) ⇒ Array<(ListResponseProspect, Fixnum, Hash)>

Find prospects corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Containing

  • :description (String) —

    Containing

  • :created_date_from (String) —

    From and including

  • :created_date_to (String) —

    To and excluding

  • :customer_id (String) —

    Equals

  • :sales_employee_id (String) —

    Equals

  • :is_closed (BOOLEAN) —

    Equals

  • :closed_reason (String) —

    Equals

  • :closed_date_from (String) —

    From and including

  • :closed_date_to (String) —

    To and excluding

  • :competitor (String) —

    Containing

  • :prospect_type (String) —

    Equals

  • :project_id (String) —

    Equals

  • :project_offer_id (String) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseProspect data, response status code and response headers



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/tripletex_ruby_client/api/crmprospect_api.rb', line 124

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CrmprospectApi.search ...'
  end
  # resource path
  local_var_path = '/crm/prospect'

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
  query_params[:'createdDateFrom'] = opts[:'created_date_from'] if !opts[:'created_date_from'].nil?
  query_params[:'createdDateTo'] = opts[:'created_date_to'] if !opts[:'created_date_to'].nil?
  query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  query_params[:'salesEmployeeId'] = opts[:'sales_employee_id'] if !opts[:'sales_employee_id'].nil?
  query_params[:'isClosed'] = opts[:'is_closed'] if !opts[:'is_closed'].nil?
  query_params[:'closedReason'] = opts[:'closed_reason'] if !opts[:'closed_reason'].nil?
  query_params[:'closedDateFrom'] = opts[:'closed_date_from'] if !opts[:'closed_date_from'].nil?
  query_params[:'closedDateTo'] = opts[:'closed_date_to'] if !opts[:'closed_date_to'].nil?
  query_params[:'competitor'] = opts[:'competitor'] if !opts[:'competitor'].nil?
  query_params[:'prospectType'] = opts[:'prospect_type'] if !opts[:'prospect_type'].nil?
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'projectOfferId'] = opts[:'project_offer_id'] if !opts[:'project_offer_id'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseProspect')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CrmprospectApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end