Class: Propertyware::ProspectsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/api/prospects_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProspectsApi

Returns a new instance of ProspectsApi.



19
20
21
 
# File 'lib/propertyware/api/prospects_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/propertyware/api/prospects_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_contacts_using_post3(save_prospect, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>

Create prospects in bulk (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates prospects in bulk.<br/><br/>Required permission:<br/><span class="permissionBlock">UNITS</span> - Write

Parameters:

  • save_prospect (Array<SaveProspect>) —

    saveProspect

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/propertyware/api/prospects_api.rb', line 27

def create_contacts_using_post3(save_prospect, opts = {})
  data, _status_code, _headers = create_contacts_using_post3_with_http_info(save_prospect, opts)
  data
end

#create_contacts_using_post3_with_http_info(save_prospect, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>

Create prospects in bulk (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates prospects in bulk.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;UNITS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_prospect (Array<SaveProspect>) —

    saveProspect

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

    the optional parameters

Returns:

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

    Array<RESTAPIBulkSuccessResponse> data, response status code and response headers



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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/propertyware/api/prospects_api.rb', line 37

def create_contacts_using_post3_with_http_info(save_prospect, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.create_contacts_using_post3 ...'
  end
  # verify the required parameter 'save_prospect' is set
  if @api_client.config.client_side_validation && save_prospect.nil?
    fail ArgumentError, "Missing the required parameter 'save_prospect' when calling ProspectsApi.create_contacts_using_post3"
  end
  # resource path
  local_var_path = '/prospects/bulk'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_prospect)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RESTAPIBulkSuccessResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.create_contacts_using_post3",
    :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: ProspectsApi#create_contacts_using_post3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_prospect(save_prospect, opts = {}) ⇒ Prospect

Create a prospect (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a specific prospect.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Write

Parameters:

  • save_prospect (SaveProspect) —

    saveProspect

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/propertyware/api/prospects_api.rb', line 95

def create_prospect(save_prospect, opts = {})
  data, _status_code, _headers = create_prospect_with_http_info(save_prospect, opts)
  data
end

#create_prospect_conversation(prospect_id, save_conversation, opts = {}) ⇒ Conversation

Create a prospect conversation (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a specific prospect conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Write

Parameters:

  • prospect_id (Integer) —

    Prospect ID

  • save_conversation (SaveConversation) —

    saveConversation

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/propertyware/api/prospects_api.rb', line 164

def create_prospect_conversation(prospect_id, save_conversation, opts = {})
  data, _status_code, _headers = create_prospect_conversation_with_http_info(prospect_id, save_conversation, opts)
  data
end

#create_prospect_conversation_with_http_info(prospect_id, save_conversation, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>

Create a prospect conversation (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a specific prospect conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • prospect_id (Integer) —

    Prospect ID

  • save_conversation (SaveConversation) —

    saveConversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/propertyware/api/prospects_api.rb', line 175

def create_prospect_conversation_with_http_info(prospect_id, save_conversation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.create_prospect_conversation ...'
  end
  # verify the required parameter 'prospect_id' is set
  if @api_client.config.client_side_validation && prospect_id.nil?
    fail ArgumentError, "Missing the required parameter 'prospect_id' when calling ProspectsApi.create_prospect_conversation"
  end
  # verify the required parameter 'save_conversation' is set
  if @api_client.config.client_side_validation && save_conversation.nil?
    fail ArgumentError, "Missing the required parameter 'save_conversation' when calling ProspectsApi.create_prospect_conversation"
  end
  # resource path
  local_var_path = '/prospects/{prospectID}/conversations'.sub('{' + 'prospectID' + '}', CGI.escape(prospect_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_conversation)

  # return_type
  return_type = opts[:debug_return_type] || 'Conversation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.create_prospect_conversation",
    :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: ProspectsApi#create_prospect_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_prospect_with_http_info(save_prospect, opts = {}) ⇒ Array<(Prospect, Integer, Hash)>

Create a prospect (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a specific prospect.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_prospect (SaveProspect) —

    saveProspect

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

    the optional parameters

Returns:

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

    Prospect data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/propertyware/api/prospects_api.rb', line 105

def create_prospect_with_http_info(save_prospect, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.create_prospect ...'
  end
  # verify the required parameter 'save_prospect' is set
  if @api_client.config.client_side_validation && save_prospect.nil?
    fail ArgumentError, "Missing the required parameter 'save_prospect' when calling ProspectsApi.create_prospect"
  end
  # resource path
  local_var_path = '/prospects'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_prospect)

  # return_type
  return_type = opts[:debug_return_type] || 'Prospect'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.create_prospect",
    :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: ProspectsApi#create_prospect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_prospect_conversation(prospect_id, conversation_id, opts = {}) ⇒ ResponseEntity

Delete a prospect conversation (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Deletes a specific prospect conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Delete

Parameters:

  • prospect_id (Integer) —

    Prospect ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/propertyware/api/prospects_api.rb', line 238

def delete_prospect_conversation(prospect_id, conversation_id, opts = {})
  data, _status_code, _headers = delete_prospect_conversation_with_http_info(prospect_id, conversation_id, opts)
  data
end

#delete_prospect_conversation_with_http_info(prospect_id, conversation_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete a prospect conversation (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Deletes a specific prospect conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • prospect_id (Integer) —

    Prospect ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



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
296
297
298
299
 
# File 'lib/propertyware/api/prospects_api.rb', line 249

def delete_prospect_conversation_with_http_info(prospect_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.delete_prospect_conversation ...'
  end
  # verify the required parameter 'prospect_id' is set
  if @api_client.config.client_side_validation && prospect_id.nil?
    fail ArgumentError, "Missing the required parameter 'prospect_id' when calling ProspectsApi.delete_prospect_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ProspectsApi.delete_prospect_conversation"
  end
  # resource path
  local_var_path = '/prospects/{prospectID}/conversations/{conversationID}'.sub('{' + 'prospectID' + '}', CGI.escape(prospect_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResponseEntity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.delete_prospect_conversation",
    :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: ProspectsApi#delete_prospect_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospect(prospect_id, opts = {}) ⇒ Prospect

Retrieve a prospect Retrieves a specific prospect.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Read

Parameters:

  • prospect_id (Integer) —

    Prospect ID

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

    the optional parameters

Options Hash (opts):

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to true)

Returns:



307
308
309
310
 
# File 'lib/propertyware/api/prospects_api.rb', line 307

def get_prospect(prospect_id, opts = {})
  data, _status_code, _headers = get_prospect_with_http_info(prospect_id, opts)
  data
end

#get_prospect_campaign(prospect_id, opts = {}) ⇒ Campaign

Retrieve prospect campaign Retrieves the campaign details of a prospect.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Read

Parameters:

  • prospect_id (Integer) —

    Prospect ID

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

    the optional parameters

Returns:



372
373
374
375
 
# File 'lib/propertyware/api/prospects_api.rb', line 372

def get_prospect_campaign(prospect_id, opts = {})
  data, _status_code, _headers = get_prospect_campaign_with_http_info(prospect_id, opts)
  data
end

#get_prospect_campaign_with_http_info(prospect_id, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Retrieve prospect campaign Retrieves the campaign details of a prospect.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • prospect_id (Integer) —

    Prospect ID

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



382
383
384
385
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
 
# File 'lib/propertyware/api/prospects_api.rb', line 382

def get_prospect_campaign_with_http_info(prospect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.get_prospect_campaign ...'
  end
  # verify the required parameter 'prospect_id' is set
  if @api_client.config.client_side_validation && prospect_id.nil?
    fail ArgumentError, "Missing the required parameter 'prospect_id' when calling ProspectsApi.get_prospect_campaign"
  end
  # resource path
  local_var_path = '/prospects/{prospectID}/campaign'.sub('{' + 'prospectID' + '}', CGI.escape(prospect_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Campaign'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.get_prospect_campaign",
    :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: ProspectsApi#get_prospect_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospect_conversation(prospect_id, conversation_id, opts = {}) ⇒ Conversation

Retrieve a prospect conversation Retrieves a specific prospect conversation.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Read

Parameters:

  • prospect_id (Integer) —

    Prospect ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:



436
437
438
439
 
# File 'lib/propertyware/api/prospects_api.rb', line 436

def get_prospect_conversation(prospect_id, conversation_id, opts = {})
  data, _status_code, _headers = get_prospect_conversation_with_http_info(prospect_id, conversation_id, opts)
  data
end

#get_prospect_conversation_with_http_info(prospect_id, conversation_id, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>

Retrieve a prospect conversation Retrieves a specific prospect conversation.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • prospect_id (Integer) —

    Prospect ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/propertyware/api/prospects_api.rb', line 447

def get_prospect_conversation_with_http_info(prospect_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.get_prospect_conversation ...'
  end
  # verify the required parameter 'prospect_id' is set
  if @api_client.config.client_side_validation && prospect_id.nil?
    fail ArgumentError, "Missing the required parameter 'prospect_id' when calling ProspectsApi.get_prospect_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ProspectsApi.get_prospect_conversation"
  end
  # resource path
  local_var_path = '/prospects/{prospectID}/conversations/{conversationID}'.sub('{' + 'prospectID' + '}', CGI.escape(prospect_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Conversation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.get_prospect_conversation",
    :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: ProspectsApi#get_prospect_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospect_conversations(prospect_id, opts = {}) ⇒ Array<Conversation>

Retrieve all prospect conversations Retrieves all the conversations of a prospect.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Read <br/><br/>Sortable by: createddate, lastmodifieddatetime, id

Parameters:

  • prospect_id (Integer) —

    Prospect ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :type (String) —

    Filters results by the conversation type.

Returns:



510
511
512
513
 
# File 'lib/propertyware/api/prospects_api.rb', line 510

def get_prospect_conversations(prospect_id, opts = {})
  data, _status_code, _headers = get_prospect_conversations_with_http_info(prospect_id, opts)
  data
end

#get_prospect_conversations_with_http_info(prospect_id, opts = {}) ⇒ Array<(Array<Conversation>, Integer, Hash)>

Retrieve all prospect conversations Retrieves all the conversations of a prospect.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

  • prospect_id (Integer) —

    Prospect ID

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :type (String) —

    Filters results by the conversation type.

Returns:

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

    Array<Conversation> data, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/propertyware/api/prospects_api.rb', line 526

def get_prospect_conversations_with_http_info(prospect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.get_prospect_conversations ...'
  end
  # verify the required parameter 'prospect_id' is set
  if @api_client.config.client_side_validation && prospect_id.nil?
    fail ArgumentError, "Missing the required parameter 'prospect_id' when calling ProspectsApi.get_prospect_conversations"
  end
  allowable_values = ["MANAGEMENT_TEAM", "OWNER", "TENANT"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/prospects/{prospectID}/conversations'.sub('{' + 'prospectID' + '}', CGI.escape(prospect_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Conversation>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.get_prospect_conversations",
    :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: ProspectsApi#get_prospect_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospect_statuses(opts = {}) ⇒ Array<ProspectStatus>

Retrieve all prospect statuses (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of all prospect statuses<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Read

Parameters:

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

    the optional parameters

Returns:



588
589
590
591
 
# File 'lib/propertyware/api/prospects_api.rb', line 588

def get_prospect_statuses(opts = {})
  data, _status_code, _headers = get_prospect_statuses_with_http_info(opts)
  data
end

#get_prospect_statuses_with_http_info(opts = {}) ⇒ Array<(Array<ProspectStatus>, Integer, Hash)>

Retrieve all prospect statuses (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of all prospect statuses&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

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

    the optional parameters

Returns:

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

    Array<ProspectStatus> data, response status code and response headers



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/propertyware/api/prospects_api.rb', line 597

def get_prospect_statuses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.get_prospect_statuses ...'
  end
  # resource path
  local_var_path = '/prospects/statuses'

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ProspectStatus>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.get_prospect_statuses",
    :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: ProspectsApi#get_prospect_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospect_with_http_info(prospect_id, opts = {}) ⇒ Array<(Prospect, Integer, Hash)>

Retrieve a prospect Retrieves a specific prospect.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • prospect_id (Integer) —

    Prospect ID

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

    the optional parameters

Options Hash (opts):

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to true)

Returns:

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

    Prospect data, response status code and response headers



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/propertyware/api/prospects_api.rb', line 318

def get_prospect_with_http_info(prospect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.get_prospect ...'
  end
  # verify the required parameter 'prospect_id' is set
  if @api_client.config.client_side_validation && prospect_id.nil?
    fail ArgumentError, "Missing the required parameter 'prospect_id' when calling ProspectsApi.get_prospect"
  end
  # resource path
  local_var_path = '/prospects/{prospectID}'.sub('{' + 'prospectID' + '}', CGI.escape(prospect_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Prospect'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.get_prospect",
    :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: ProspectsApi#get_prospect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospects(opts = {}) ⇒ Array<Prospect>

Retrieve all prospects Retrieves a list of prospects.<br/><br/>Required permission:<br/><span class="permissionBlock">PROSPECTS</span> - Read <br/><br/>Sortable by: createddate, type, lastmodifieddatetime, status, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :status (String) —

    Filters results to prospects with a specific status.

  • :portfolio_id (Integer) —

    Filters results to prospects associated with a specific portfolio.

  • :building_id (Integer) —

    Filters results to prospects associated with a specific building.

  • :type (String) —

    Filters results to prospects with a specific type.

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to false)

Returns:



655
656
657
658
 
# File 'lib/propertyware/api/prospects_api.rb', line 655

def get_prospects(opts = {})
  data, _status_code, _headers = get_prospects_with_http_info(opts)
  data
end

#get_prospects_with_http_info(opts = {}) ⇒ Array<(Array<Prospect>, Integer, Hash)>

Retrieve all prospects Retrieves a list of prospects.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PROSPECTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;status&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :status (String) —

    Filters results to prospects with a specific status.

  • :portfolio_id (Integer) —

    Filters results to prospects associated with a specific portfolio.

  • :building_id (Integer) —

    Filters results to prospects associated with a specific building.

  • :type (String) —

    Filters results to prospects with a specific type.

  • :include_custom_fields (Boolean) —

    includeCustomFields (default to false)

Returns:

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

    Array<Prospect> data, response status code and response headers



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/propertyware/api/prospects_api.rb', line 674

def get_prospects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProspectsApi.get_prospects ...'
  end
  # resource path
  local_var_path = '/prospects'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'buildingID'] = opts[:'building_id'] if !opts[:'building_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Prospect>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"ProspectsApi.get_prospects",
    :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: ProspectsApi#get_prospects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end