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_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:



29
30
31
32
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 29

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:



93
94
95
96
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 93

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



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

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:



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

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:



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

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:



212
213
214
215
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 212

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:



221
222
223
224
225
226
227
228
229
230
231
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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 221

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:



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

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_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:



270
271
272
273
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 270

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:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
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
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 280

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:



339
340
341
342
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 339

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:



350
351
352
353
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
395
396
397
398
399
400
401
 
# File 'lib/DealMakerAPI/api/default_api.rb', line 350

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