Class: DealMakerAPI::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/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.



19
20
21
 
# File 'lib/DealMakerAPI/api/default_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/DealMakerAPI/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id, opts = {}) ⇒ V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData

Load data for the digital payments connection stage Load data for the digital payments connection stage

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 27

def get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id, opts = {})
  data, _status_code, _headers = get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id, opts)
  data
end

#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id, opts = {}) ⇒ Array<(V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData, Integer, Hash)>

Load data for the digital payments connection stage Load data for the digital payments connection stage

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 37

def get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data ...'
  end
  # verify the required parameter 'deal_id' is set
  if @api_client.config.client_side_validation && deal_id.nil?
    fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data"
  end
  # resource path
  local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data'.sub('{' + 'deal_id' + '}', CGI.escape(deal_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] || 'V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data(deal_id, opts = {}) ⇒ V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData

Get payout account data Get payout account data

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 90

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

#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info(deal_id, opts = {}) ⇒ Array<(V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData, Integer, Hash)>

Get payout account data Get payout account data

Parameters:

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

    the optional parameters

Returns:



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 100

def (deal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data ...'
  end
  # verify the required parameter 'deal_id' is set
  if @api_client.config.client_side_validation && deal_id.nil?
    fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data"
  end
  # resource path
  local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data'.sub('{' + 'deal_id' + '}', CGI.escape(deal_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] || 'V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id, opts = {}) ⇒ V1EntitiesExpressWireInstruction

Displays the express wire instructions for an investor on a deal Get express wire instructions

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 154

def get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id, opts = {})
  data, _status_code, _headers = get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info(id, investor_id, opts)
  data
end

#get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info(id, investor_id, opts = {}) ⇒ Array<(V1EntitiesExpressWireInstruction, Integer, Hash)>

Displays the express wire instructions for an investor on a deal Get express wire instructions

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



165
166
167
168
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
215
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 165

def get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info(id, investor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_id_investors_investor_id_payments_express_wire_instructions ...'
  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 DefaultApi.get_deals_id_investors_investor_id_payments_express_wire_instructions"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling DefaultApi.get_deals_id_investors_investor_id_payments_express_wire_instructions"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/payments/express_wire/instructions'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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] || 'V1EntitiesExpressWireInstruction'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_deals_id_investors_payments_express_wire_instructions(id, opts = {}) ⇒ V1EntitiesExpressWireInstructions

Displays the express wire instructions for all the investors on a deal Get list of express wire instructions

Parameters:

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

    the optional parameters

Returns:



222
223
224
225
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 222

def get_deals_id_investors_payments_express_wire_instructions(id, opts = {})
  data, _status_code, _headers = get_deals_id_investors_payments_express_wire_instructions_with_http_info(id, opts)
  data
end

#get_deals_id_investors_payments_express_wire_instructions_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesExpressWireInstructions, Integer, Hash)>

Displays the express wire instructions for all the investors on a deal Get list of express wire instructions

Parameters:

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

    the optional parameters

Returns:



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
275
276
277
278
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 232

def get_deals_id_investors_payments_express_wire_instructions_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_id_investors_payments_express_wire_instructions ...'
  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 DefaultApi.get_deals_id_investors_payments_express_wire_instructions"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/payments/express_wire/instructions'.sub('{' + 'id' + '}', CGI.escape(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] || 'V1EntitiesExpressWireInstructions'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_deals_id_summary(id, opts = {}) ⇒ nil

Get Deal Overview Get Deal Overview

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


285
286
287
288
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 285

def get_deals_id_summary(id, opts = {})
  get_deals_id_summary_with_http_info(id, opts)
  nil
end

#get_deals_id_summary_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get Deal Overview Get Deal Overview

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
337
338
339
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 295

def get_deals_id_summary_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_id_summary ...'
  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 DefaultApi.get_deals_id_summary"
  end
  # resource path
  local_var_path = '/deals/{id}/summary'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_deals_payment_onboarding_questionnaire_initial_questions(opts = {}) ⇒ nil

Get initial questions Get initial questions

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


345
346
347
348
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 345

def get_deals_payment_onboarding_questionnaire_initial_questions(opts = {})
  get_deals_payment_onboarding_questionnaire_initial_questions_with_http_info(opts)
  nil
end

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

Get initial questions Get initial questions

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 354

def get_deals_payment_onboarding_questionnaire_initial_questions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_payment_onboarding_questionnaire_initial_questions ...'
  end
  # resource path
  local_var_path = '/deals/payment_onboarding/questionnaire/initial_questions'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_webhooks(opts = {}) ⇒ V1EntitiesWebhooksSubscription

Returns a list of webhook subscription which is associated to the user Returns a list of webhook subscription

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:



403
404
405
406
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 403

def get_webhooks(opts = {})
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
  data
end

#get_webhooks_deal_id(id, opts = {}) ⇒ V1EntitiesWebhooksDeal

Finds a deal using the id Returns a deal

Parameters:

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

    the optional parameters

Returns:



467
468
469
470
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 467

def get_webhooks_deal_id(id, opts = {})
  data, _status_code, _headers = get_webhooks_deal_id_with_http_info(id, opts)
  data
end

#get_webhooks_deal_id_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesWebhooksDeal, Integer, Hash)>

Finds a deal using the id Returns a deal

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesWebhooksDeal data, response status code and response headers



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 477

def get_webhooks_deal_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_webhooks_deal_id ...'
  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 DefaultApi.get_webhooks_deal_id"
  end
  # resource path
  local_var_path = '/webhooks/deal/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'V1EntitiesWebhooksDeal'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_webhooks_deals_search(opts = {}) ⇒ V1EntitiesWebhooksSecurityToken

Searches for deals for a given user Searches for deals for a given user

Parameters:

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

    the optional parameters

Returns:



529
530
531
532
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 529

def get_webhooks_deals_search(opts = {})
  data, _status_code, _headers = get_webhooks_deals_search_with_http_info(opts)
  data
end

#get_webhooks_deals_search_with_http_info(opts = {}) ⇒ Array<(V1EntitiesWebhooksSecurityToken, Integer, Hash)>

Searches for deals for a given user Searches for deals for a given user

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 538

def get_webhooks_deals_search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_webhooks_deals_search ...'
  end
  # resource path
  local_var_path = '/webhooks/deals/search'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_webhooks_security_token(opts = {}) ⇒ V1EntitiesWebhooksSecurityToken

Creates a new security token for webhook subscription Creates a new security token for webhook subscription

Parameters:

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

    the optional parameters

Returns:



586
587
588
589
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 586

def get_webhooks_security_token(opts = {})
  data, _status_code, _headers = get_webhooks_security_token_with_http_info(opts)
  data
end

#get_webhooks_security_token_with_http_info(opts = {}) ⇒ Array<(V1EntitiesWebhooksSecurityToken, Integer, Hash)>

Creates a new security token for webhook subscription Creates a new security token for webhook subscription

Parameters:

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

    the optional parameters

Returns:



595
596
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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 595

def get_webhooks_security_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_webhooks_security_token ...'
  end
  # resource path
  local_var_path = '/webhooks/security_token'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_webhooks_with_http_info(opts = {}) ⇒ Array<(V1EntitiesWebhooksSubscription, Integer, Hash)>

Returns a list of webhook subscription which is associated to the user Returns a list of webhook subscription

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 415

def get_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_webhooks ...'
  end
  # resource path
  local_var_path = '/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'V1EntitiesWebhooksSubscription'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit(deal_id, opts = {}) ⇒ V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult

Submit a payout account details form Submit a payout account details form

Parameters:

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

    the optional parameters

Returns:



644
645
646
647
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 644

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

#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit_with_http_info(deal_id, opts = {}) ⇒ Array<(V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult, Integer, Hash)>

Submit a payout account details form Submit a payout account details form

Parameters:

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

    the optional parameters

Returns:



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 654

def (deal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit ...'
  end
  # verify the required parameter 'deal_id' is set
  if @api_client.config.client_side_validation && deal_id.nil?
    fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit"
  end
  # resource path
  local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit'.sub('{' + 'deal_id' + '}', CGI.escape(deal_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] || 'V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit(deal_id, opts = {}) ⇒ nil

Submit a qualification questionnaire response Submit a qualification questionnaire response

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


707
708
709
710
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 707

def post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit(deal_id, opts = {})
  post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info(deal_id, opts)
  nil
end

#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info(deal_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Submit a qualification questionnaire response Submit a qualification questionnaire response

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 717

def post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info(deal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit ...'
  end
  # verify the required parameter 'deal_id' is set
  if @api_client.config.client_side_validation && deal_id.nil?
    fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit"
  end
  # resource path
  local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit'.sub('{' + 'deal_id' + '}', CGI.escape(deal_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit(deal_id, opts = {}) ⇒ V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult

Submit a qualification questionnaire form Submit a qualification questionnaire form

Parameters:

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

    the optional parameters

Returns:



768
769
770
771
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 768

def post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit(deal_id, opts = {})
  data, _status_code, _headers = post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info(deal_id, opts)
  data
end

#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info(deal_id, opts = {}) ⇒ Array<(V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult, Integer, Hash)>

Submit a qualification questionnaire form Submit a qualification questionnaire form

Parameters:

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

    the optional parameters

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 778

def post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info(deal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit ...'
  end
  # verify the required parameter 'deal_id' is set
  if @api_client.config.client_side_validation && deal_id.nil?
    fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit"
  end
  # resource path
  local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit'.sub('{' + 'deal_id' + '}', CGI.escape(deal_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] || 'V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#post_webhooks(post_webhooks_request, opts = {}) ⇒ V1EntitiesWebhooksSubscription

Creates a webhook subscription which is associated to the user Creates new webhook subscription

Parameters:

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

    the optional parameters

Returns:



831
832
833
834
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 831

def post_webhooks(post_webhooks_request, opts = {})
  data, _status_code, _headers = post_webhooks_with_http_info(post_webhooks_request, opts)
  data
end

#post_webhooks_with_http_info(post_webhooks_request, opts = {}) ⇒ Array<(V1EntitiesWebhooksSubscription, Integer, Hash)>

Creates a webhook subscription which is associated to the user Creates new webhook subscription

Parameters:

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

    the optional parameters

Returns:



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 841

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

  # 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(post_webhooks_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#put_webhooks_id(id, opts = {}) ⇒ V1EntitiesWebhooksSubscription

Updates webhook subscription and webhooks subcription deals Updates webhook subscription

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



900
901
902
903
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 900

def put_webhooks_id(id, opts = {})
  data, _status_code, _headers = put_webhooks_id_with_http_info(id, opts)
  data
end

#put_webhooks_id_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesWebhooksSubscription, Integer, Hash)>

Updates webhook subscription and webhooks subcription deals Updates webhook subscription

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 911

def put_webhooks_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.put_webhooks_id ...'
  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 DefaultApi.put_webhooks_id"
  end
  # resource path
  local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(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(opts[:'put_webhooks_id_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.put_webhooks_id",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#put_webhooks_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end